Compare commits

..

4 commits

Author SHA1 Message Date
e7fd05ce9a phpcs
All checks were successful
PHP Code Checker / PHP Code Checker (pull_request) Successful in 48s
PHPUnit / PHPUnit – PHP 8.1 (pull_request) Successful in 58s
PHPUnit / PHPUnit – PHP 8.2 (pull_request) Successful in 1m1s
PHPUnit / PHPUnit – PHP 8.3 (pull_request) Successful in 1m1s
2024-10-22 18:46:37 +02:00
61522ddcbe make example url easier to copy
Some checks failed
PHP Code Checker / PHP Code Checker (pull_request) Failing after 1m46s
PHPUnit / PHPUnit – PHP 8.1 (pull_request) Successful in 1m1s
PHPUnit / PHPUnit – PHP 8.3 (pull_request) Has been cancelled
PHPUnit / PHPUnit – PHP 8.2 (pull_request) Has been cancelled
2024-10-22 18:43:42 +02:00
a0a4edb72b improve admin welcome page
Some checks failed
PHP Code Checker / PHP Code Checker (pull_request) Failing after 3m53s
PHPUnit / PHPUnit – PHP 8.1 (pull_request) Successful in 4m21s
PHPUnit / PHPUnit – PHP 8.2 (pull_request) Successful in 1m39s
PHPUnit / PHPUnit – PHP 8.3 (pull_request) Successful in 1m2s
2024-10-22 16:18:29 +02:00
3cc3405f45 Add "How to Check if It's Working" section in admin
All checks were successful
PHP Code Checker / PHP Code Checker (pull_request) Successful in 35s
PHPUnit / PHPUnit – PHP 8.1 (pull_request) Successful in 1m10s
PHPUnit / PHPUnit – PHP 8.2 (pull_request) Successful in 1m7s
PHPUnit / PHPUnit – PHP 8.3 (pull_request) Successful in 1m8s
2024-10-20 12:15:25 +02:00
24 changed files with 76 additions and 343 deletions

View file

@ -1,24 +0,0 @@
.distignore
.git
.gitignore
.wordpress-org
.wp-env.json
bin
CHANGELOG.md
CODE_OF_CONDUCT.md
composer.json
composer.lock
docker-compose.yml
Dockerfile
docs
FEDERATION.md
Gruntfile.js
node_modules
package.json
package-lock.json
phpcs.xml
phpunit.xml
README.md
src
tests
vendor

View file

@ -21,7 +21,7 @@ jobs:
MYSQL_ROOT_PASSWORD: root MYSQL_ROOT_PASSWORD: root
strategy: strategy:
matrix: matrix:
php-version: ['7.4', '8.0', '8.1', '8.2', '8.3'] php-version: ['8.1', '8.2', '8.3']
name: PHPUnit PHP ${{ matrix.php-version }} name: PHPUnit PHP ${{ matrix.php-version }}
env: env:
extensions: mysql extensions: mysql
@ -45,7 +45,7 @@ jobs:
with: with:
path: | path: |
./vendor/ ./vendor/
key: cache-composer-phpunit-2 key: cache-composer-phpunit-1
- name: Setup PHP - name: Setup PHP
uses: https://github.com/shivammathur/setup-php@v2 uses: https://github.com/shivammathur/setup-php@v2

View file

@ -1,16 +0,0 @@
on:
push:
tags: 'v*'
jobs:
upload-release:
runs-on: ubuntu-latest
steps:
- uses: https://code.forgejo.org/actions/checkout@v4
- uses: https://code.forgejo.org/actions/forgejo-release@v2
with:
direction: upload
url: https://code.event-federation.eu
release-notes: ${{ TAG }}
token: ${{ secrets.GITHUB_TOKEN }}

23
.gitattributes vendored
View file

@ -1,23 +0,0 @@
.distignore export-ignore
.forgejo export-ignore
.gitattributes export-ignore
.gitignore export-ignore
.wp-env.json export-ignore
bin export-ignore
CODE_OF_CONDUCT.md export-ignore
composer.json export-ignore
composer.lock export-ignore
docker-compose.yml export-ignore
Dockerfile export-ignore
docs export-ignore
FEDERATION.md export-ignore
Gruntfile.js export-ignore
node_modules export-ignore
package.json export-ignore
package-lock.json export-ignore
phpcs.xml export-ignore
phpunit.xml export-ignore
README.md export-ignore
src export-ignore
tests export-ignore
vendor export-ignore

1
.gitignore vendored
View file

@ -2,4 +2,3 @@ vendor/
composer.lock composer.lock
.phpunit.result.cache .phpunit.result.cache
node_modules/ node_modules/
package-lock.json

Binary file not shown.

Before

Width:  |  Height:  |  Size: 324 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 120 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 392 KiB

After

Width:  |  Height:  |  Size: 80 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 52 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 125 KiB

View file

@ -1,126 +0,0 @@
# Contributor Covenant Code of Conduct
## Our Pledge
We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.
## Our Standards
Examples of behavior that contributes to a positive environment for our
community include:
* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the overall
community
Examples of unacceptable behavior include:
* The use of sexualized language or imagery, and sexual attention or advances of
any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email address,
without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## Enforcement Responsibilities
Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.
Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.
## Scope
This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official email address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement via email to
simon@fdpl.io. All complaints will be reviewed and investigated fairly
and as soon as personal time and energy of community leaders permits.
All community leaders are obligated to respect the privacy and security of the
reporter of any incident.
## Enforcement Guidelines
Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:
### 1. Correction
**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.
**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.
### 2. Warning
**Community Impact**: A violation through a single incident or series of
actions.
**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or permanent
ban.
### 3. Temporary Ban
**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.
**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.
### 4. Permanent Ban
**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.
**Consequence**: A permanent ban from any sort of public interaction within the
community.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org),
version 2.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html).
Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
For answers to common questions about this code of conduct, see the FAQ at
[https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are available at
[https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations).

View file

@ -1,59 +0,0 @@
module.exports = function (grunt) {
// Project configuration.
grunt.initConfig(
{
checktextdomain: {
options:{
text_domain: 'activitypub-event-bridge',
keywords: [
'__:1,2d',
'_e:1,2d',
'_x:1,2c,3d',
'esc_html__:1,2d',
'esc_html_e:1,2d',
'esc_html_x:1,2c,3d',
'esc_attr__:1,2d',
'esc_attr_e:1,2d',
'esc_attr_x:1,2c,3d',
'_ex:1,2c,3d',
'_n:1,2,4d',
'_nx:1,2,4c,5d',
'_n_noop:1,2,3d',
'_nx_noop:1,2,3c,4d'
]
},
files: {
src: [
'**/*.php', // Include all files
'!sass/**', // Exclude sass/
'!node_modules/**', // Exclude node_modules/
'!tests/**', // Exclude tests/
'!vendor/**', // Exclude vendor/
'!build/**', // Exclude build/
'!static/**', // Exclude static resources
],
expand: true
}
},
wp_readme_to_markdown: {
target: {
files: {
'README.md': 'readme.txt'
},
},
options: {
pre_convert: function ( readme ) {
return readme.replace( /\*\*Note\*\*:/g, "> [!NOTE]\n>" );
}
}
}
}
);
grunt.loadNpmTasks( 'grunt-wp-readme-to-markdown' );
grunt.loadNpmTasks( 'grunt-checktextdomain' );
// Default task(s).
grunt.registerTask( 'default', ['wp_readme_to_markdown', 'checktextdomain'] );
};

View file

@ -1,48 +1,50 @@
# ActivityPub Event Bridge # # ActivityPub Event Bridge
**Contributors:** [andremenrath](https://profiles.wordpress.org/andremenrath/)
**Tags:** events, fediverse, activitypub, calendar Contributors: andremenrath
**Requires at least:** 6.5 Tags: events, fediverse, activitypub, calendar
**Tested up to:** 6.6 Requires at least: 6.5
**Stable tag:** 0.2.0 Tested up to: 6.6
**Requires PHP:** 7.4 Stable tag: 0.1.0
**License:** AGPL-3.0-or-later Requires PHP: 8.1
**License URI:** https://www.gnu.org/licenses/agpl-3.0.html License: AGPL-3.0-or-later
License URI: https://www.gnu.org/licenses/agpl-3.0.html
Integrating popular event plugins with the ActivityPub plugin. Integrating popular event plugins with the ActivityPub plugin.
![Federate your Events, Expand your Reach!](.wordpress-org/banner-1544x500.jpg) ![](.wordpress-org/banner-1544x500.jpg)
## Description ## ## Description
Make your events more discoverable, expand your reach effortlessly while being independent of other (commercial) platforms, and be a part of the growing decentralized web (the Fediverse). Make your events more discoverable, expand your reach effortlessly while being independent of other (commercial) platforms, and be a part of the growing decentralized web (the Fediverse).
With the ActivityPub Event Bridge Plugin for WordPress, your events can be automatically followed, aggregated and displayed across decentralized platforms like [Mastodon](https://joinmastodon.org) or [Gancio](https://gancio.org), without any extra work. With the ActivityPub Event Bridge plugin for WordPress, your events can be automatically followed, aggregated and displayed across decentralized platforms like [Mastodon](https://joinmastodon.org) or [Gancio](https://gancio.org), without any extra work.
Forget the hassle of managing multiple social media accounts just to keep your audience informed. Forget the hassle of managing multiple social media accounts just to keep your audience informed.
This plugin is not an event managing plugin but an add-on to popular event plugins. It extends their functionality to fully support the [ActivityPub plugin](https://wordpress.org/plugins/activitypub/). This plugin is not an event managing plugin but an add-on to popular event plugins. It extends their functionality to fully support the [ActivityPub plugin](https://wordpress.org/plugins/activitypub/).
With the ActivityPub plugin people can follow your website directly and engage with your events just as they would on social media: liking, boosting and even commenting if you enable it. With the ActivityPub plugin people can follow your website directly and engage with your events just as they would on social media: liking, boosting and even commenting if you enable it.
You retain full ownership of your content. By integrating into your existing setup, it ensures no extra work is needed while enhancing your events' visibility across the web. You retain full ownership of your content. By integrating into your existing setup, it ensures no extra work is needed while enhancing your events' visibility across the web.
### How It Works ### ### How It Works
With the ActivityPub Event Bridge WordPress plugin, sharing your events is effortless and automatic! With the ActivityPub Event Bridge WordPress plugin, sharing your events is effortless and automatic!
Once you create an event on your WordPress site, it is seamlessly shared across the decentralized web using the ActivityPub protocol. Once you create an event on your WordPress site, it is seamlessly shared across the decentralized web using the ActivityPub protocol.
<p align="center"> <p align="center">
<img src="./.wordpress-org/event-activitypub-publishing.gif" alt="Logo" width="300"/> <img src="./.wordpress-org/event-activitypub-publishing.gif" alt="Logo" width="250" />
</p> </p>
Your events can be automatically delivered to platforms that fully support events, such as [Mobilizon](https://joinmobilizon.org/), [Gancio](https://gancio.org), [Friendica](https://friendi.ca), [Hubzilla](https://hubzilla.org), and [Pleroma](https://pleroma.social/). Your events can be automatically delivered to platforms that fully support events, such as [Mobilizon](https://joinmobilizon.org/), [Gancio](https://gancio.org), [Friendica](https://friendi.ca), [Hubzilla](https://hubzilla.org), and [Pleroma](https://pleroma.social/).
These platforms create public event calendars by pulling in events from various sources, including your website. Any updates you make to your events are synced across these platforms—so you only need to manage your events on your own site, with no extra work required. These platforms create public event calendars by pulling in events from various sources, including your website. Any updates you make to your events are synced across these platforms—so you only need to manage your events on your own site, with no extra work required.
<p align="center"> <p align="center">
<img src="./.wordpress-org/decentralized-event-calenders.gif" alt="Logo" width="250"/> <img src="./.wordpress-org/decentralized-event-calenders.gif" alt="Logo" width="250" />
</p> </p>
Even platforms that don't yet fully support events, like [Mastodon](https://joinmastodon.org), will still receive a detailed, well-composed summary of your event. Even platforms that don't yet fully support events, like [Mastodon](https://joinmastodon.org), will still receive a detailed, well-composed summary of your event.
The Event Federation plugin ensures that users from those platforms are provided with all important information about an event. The Event Federation plugin ensures that users from those platforms are provided with all important information about an event.
### Features for Your WordPress Events and the Fediverse ### ### Features for Your WordPress Events and the Fediverse
**ActivityPub-Enabled Event Sharing:** Your WordPress events are now compatible with the Fediverse, using the ActivityStreams format. This means your events can be easily discovered and followed by users on platforms like Mastodon and other ActivityPub-compatible services. **ActivityPub-Enabled Event Sharing:** Your WordPress events are not part of the Fediverse and
**Automatic Event Summaries:** When your event is shared on the Fediverse, platforms like Mastodon that don't fully support events will display a brief HTML summary of key details — such as the event's title, start time, and location. This ensures that even if someone can't view the full event on their platform, they still get the important info at a glance, with a link to your WordPress event page. **Automatic Event Summaries:** When your event is shared on the Fediverse, platforms like Mastodon that don't fully support events will display a brief HTML summary of key details — such as the event's title, start time, and location. This ensures that even if someone can't view the full event on their platform, they still get the important info at a glance, with a link to your WordPress event page.
@ -50,11 +52,11 @@ The Event Federation plugin ensures that users from those platforms are provided
**Event Reminders for Your Followers:** Often, events are planned well in advance. To keep your followers informed right in time, you can set up reminders that are supposed to trigger the events showing up in their timelines right before the event starts. At the moment this reminder is implemented as a self-boost of your original event post. While this feature may behave differently across various platforms, we are working on a more robust solution that will let you schedule dedicated reminder notes that appear in all followers' timelines. **Event Reminders for Your Followers:** Often, events are planned well in advance. To keep your followers informed right in time, you can set up reminders that are supposed to trigger the events showing up in their timelines right before the event starts. At the moment this reminder is implemented as a self-boost of your original event post. While this feature may behave differently across various platforms, we are working on a more robust solution that will let you schedule dedicated reminder notes that appear in all followers' timelines.
## Installation ## ## Installation
This plugin depends on the [ActivityPub plugin](https://wordpress.org/plugins/activitypub/). Additionally, you need to use one of the supported event Plugins. This plugin depends on the [ActivityPub plugin](https://wordpress.org/plugins/activitypub/). Additionally, you need to use one of the supported event plugins. See below.
### Supported Event Plugins ### ### Supported Event plugins
* [The Events Calendar](https://de.wordpress.org/plugins/the-events-calendar/) * [The Events Calendar](https://de.wordpress.org/plugins/the-events-calendar/)
* [VS Event List](https://de.wordpress.org/plugins/very-simple-event-list/) * [VS Event List](https://de.wordpress.org/plugins/very-simple-event-list/)
@ -64,41 +66,41 @@ This plugin depends on the [ActivityPub plugin](https://wordpress.org/plugins/ac
* [Modern Events Calendar Lite](https://webnus.net/modern-events-calendar/) * [Modern Events Calendar Lite](https://webnus.net/modern-events-calendar/)
* [GatherPress](https://gatherpress.org/) * [GatherPress](https://gatherpress.org/)
## Configuration ## ## Configuration
If you're new to the [ActivityPub plugin](https://wordpress.org/plugins/activitypub/), its recommended to spend a few minutes reading through its documentation to familiarize yourself with its setup and functionality. If youre new to the [ActivityPub plugin](https://wordpress.org/plugins/activitypub/), its recommended to spend a few minutes reading through its documentation to familiarize yourself with its setup and functionality.
## Frequently Asked Questions ## ## Frequently Asked Questions
### Do I need to install another event plugin to use the Event Federation Plugin? ### ### Do I need to install another event plugin to use the Event Federation plugin?
Yes, this plugin works as an add-on and requires both the ActivityPub plugin and a supported event plugin such as The Events Calendar, VS Event List, or Events Manager to manage your events. It just fills the missing gap between event plugins and the [ActivityPub plugin](https://wordpress.org/plugins/activitypub/). Yes, this plugin works as an add-on and requires both the ActivityPub plugin and a supported event plugin such as The Events Calendar, VS Event List, or Events Manager to manage your events. It just fills the missing gap between event plugins and the [ActivityPub plugin](https://wordpress.org/plugins/activitypub/).
### What platforms can follow my events? ###
Your events can be followed on platforms that support ActivityPub like [Mobilizon](https://joinmobilizon.org/), [Gancio](https://gancio.org), [Friendica](https://friendi.ca), [Hubzilla](https://hubzilla.org), and [Pleroma](https://pleroma.social/). Even other applications like [Mastodon](https://joinmastodon.org), which don't fully support events yet, will display all important information about the events. ### What platforms can follow my events?
Your events can be followed on platforms that support ActivityPub like [Mobilizon](https://joinmobilizon.org/), [Gancio](https://gancio.org), [Friendica](https://friendi.ca), [Hubzilla](https://hubzilla.org), and [Pleroma](https://pleroma.social/). Even other applications like [Mastodon](https://joinmastodon.org), which dont fully support events yet, will display all important information about the events.
### How much extra work is required to maintain my events across the decentralized Web? ### ### How much extra work is required to maintain my events across the decentralized Web?
None! Once the plugin is set up, your events are automatically sent to all connected platforms or account that follow you (your Website). Any updates you make to your events are synced without additional effort. None! Once the plugin is set up, your events are automatically sent to all connected platforms or account that follow you (your Website). Any updates you make to your events are synced without additional effort.
### Can I still use social media to promote my events? ### ### Can I still use social media to promote my events?
Yes, you can still use traditional social media if you wish. However, this plugin helps reduce reliance on commercial platforms by connecting your events to the decentralized Fediverse. Yes, you can still use traditional social media if you wish. However, this plugin helps reduce reliance on commercial platforms by connecting your events to the decentralized Fediverse.
### Will this plugin work if I don't use the ActivityPub plugin? ### ### Will this plugin work if I don't use the ActivityPub plugin?
No, the Event Federation Plugin depends on the [ActivityPub plugin](https://wordpress.org/plugins/activitypub/) to deliver your events across decentralized platforms, so it's essential to have it installed and configured. No, the Event Federation plugin depends on the ActivityPub plugin to deliver your events across decentralized platforms, so it's essential to have it installed and configured.
### My event plugin is not supported, what can I do? ### ### My event plugin is not supported, what can I do?
If you know about coding have a look at the documentation of how to add your plugin or open an [issue](https://code.event-federation.eu/Event-Federation/wordpress-activitypub-event-bridge/issues), if we can spare some free hours we might add it. If you know about coding have a look at the documentation of how to add your plugin or open an [issue](https://code.event-federation.eu/Event-Federation/wordpress-activitypub-event-bridge/issues), if we can spare some free hours we might add it.
### What if I experience problems? ### ### What if I experience problems?
We're always interested in your feedback. Feel free to reach out to us via [E-Mail](https://event-federation.eu/contact/) or create an [issue](https://code.event-federation.eu/Event-Federation/wordpress-activitypub-event-bridge/issues). We're always interested in your feedback. Feel free to reach out to us via [E-Mail](https://event-federation.eu/contact/) or create an [issue](https://code.event-federation.eu/Event-Federation/wordpress-activitypub-event-bridge/issues).
## Changelog ## ## Changelog
### [0.2.0] 2024-10-29 ### ### [0.1.0] 2024-10-01
* Initial release on https://wordpress.org/ * Initial alpha release on WordPress.org

View file

@ -3,15 +3,15 @@
* Plugin Name: ActivityPub Event Bridge * Plugin Name: ActivityPub Event Bridge
* Description: Integrating popular event plugins with the ActivityPub plugin. * Description: Integrating popular event plugins with the ActivityPub plugin.
* Plugin URI: https://event-federation.eu/ * Plugin URI: https://event-federation.eu/
* Version: 0.2.0 * Version: 0.1.1
* Author: André Menrath * Author: André Menrath
* Author URI: https://graz.social/@linos * Author URI: https://graz.social/@linos
* Text Domain: activitypub-event-bridge * Text Domain: activitypub-event-bridge
* License: AGPL-3.0-or-later * License: AGPL-3.0-or-later
* License URI: https://www.gnu.org/licenses/agpl-3.0.html * License URI: https://www.gnu.org/licenses/agpl-3.0.de.html
* Requires PHP: 7.4 * Requires PHP: 8.1
* *
* Requires at least ActivityPub plugin with version >= 3.2.2. ActivityPub plugin tested up to: 4.0.1. * Requires at least ActivityPub plugin with version >= 3.2.2. ActivityPub plugin tested up to: 3.3.3.
* *
* @package ActivityPub_Event_Bridge * @package ActivityPub_Event_Bridge
* @license AGPL-3.0-or-later * @license AGPL-3.0-or-later

View file

@ -4,7 +4,7 @@
"description": "The ActivityPub Event Bridge help for event custom post types to federate properly.", "description": "The ActivityPub Event Bridge help for event custom post types to federate properly.",
"type": "wordpress-plugin", "type": "wordpress-plugin",
"require": { "require": {
"php": ">=7.4.0", "php": ">=8.1.0",
"composer/installers": "^2.0" "composer/installers": "^2.0"
}, },
"require-dev": { "require-dev": {

View file

@ -1,9 +1,6 @@
version: '3' version: '3'
# This files purpose is to run the PHPunit tests locally. # This files purpose is to run the PHPunit tests locally.
# Prerequisites:
# Run "composer install" to generate a composer.lock file and install PHP dev dependencies.
#
# Install docker and docker compose and than just run: # Install docker and docker compose and than just run:
# docker compose up # docker compose up

16
improvements.md Normal file
View file

@ -0,0 +1,16 @@
Make use of:
https://docs.theeventscalendar.com/reference/classes/tribe__events__api/get_event_terms/
for getting all tags/terms for an event!
```
public static function get_event_terms( $event_id, array $args = array() ) {
$terms = array();
foreach ( get_post_taxonomies( $event_id ) as $taxonomy ) {
$tax_terms = wp_get_object_terms( $event_id, $taxonomy, $args );
$terms[ $taxonomy ] = $tax_terms;
}
return $terms;
}
```

View file

@ -121,9 +121,9 @@ final class The_Events_Calendar extends Event {
/** /**
* Get the event location. * Get the event location.
* *
* @return ?Place The place/venue if one is set. * @return Place|array The place/venue if one is set.
*/ */
public function get_location(): ?Place { public function get_location(): Place|null {
// Get short handle for the venues. // Get short handle for the venues.
$venues = $this->tribe_event->venues; $venues = $this->tribe_event->venues;

View file

@ -47,7 +47,7 @@ class Health_Check {
*/ */
public static function test_event_transformation() { public static function test_event_transformation() {
$result = array( $result = array(
'label' => \__( 'Transformation of Events to a valid ActivityStreams representation.', 'activitypub-event-bridge' ), 'label' => \__( 'Transformation of Events to a valid ActivityStreams representation.', 'activitypub' ),
'status' => 'good', 'status' => 'good',
'badge' => array( 'badge' => array(
'label' => \__( 'ActivityPub Event Bridge', 'activitypub-event-bridge' ), 'label' => \__( 'ActivityPub Event Bridge', 'activitypub-event-bridge' ),
@ -172,7 +172,7 @@ class Health_Check {
'label' => __( 'ActivityPub Event Bridge', 'activitypub-event-bridge' ), 'label' => __( 'ActivityPub Event Bridge', 'activitypub-event-bridge' ),
'fields' => array( 'fields' => array(
'plugin_version' => array( 'plugin_version' => array(
'label' => __( 'Plugin Version', 'activitypub-event-bridge' ), 'label' => __( 'Plugin Version', 'activitypub' ),
'value' => ACTIVITYPUB_EVENT_BRIDGE_PLUGIN_VERSION, 'value' => ACTIVITYPUB_EVENT_BRIDGE_PLUGIN_VERSION,
'private' => true, 'private' => true,
), ),

View file

@ -44,7 +44,7 @@ class Settings {
'activitypub_event_bridge_default_event_category', 'activitypub_event_bridge_default_event_category',
array( array(
'type' => 'string', 'type' => 'string',
'description' => \__( 'Define your own custom post template', 'activitypub-event-bridge' ), 'description' => \__( 'Define your own custom post template', 'activitypub' ),
'show_in_rest' => true, 'show_in_rest' => true,
'default' => self::DEFAULT_EVENT_CATEGORY, 'default' => self::DEFAULT_EVENT_CATEGORY,
'sanitize_callback' => array( self::class, 'sanitize_mapped_event_category' ), 'sanitize_callback' => array( self::class, 'sanitize_mapped_event_category' ),
@ -56,7 +56,7 @@ class Settings {
'activitypub_event_bridge_event_category_mappings', 'activitypub_event_bridge_event_category_mappings',
array( array(
'type' => 'array', 'type' => 'array',
'description' => \__( 'Define your own custom post template', 'activitypub-event-bridge' ), 'description' => \__( 'Define your own custom post template', 'activitypub' ),
'default' => array(), 'default' => array(),
'sanitize_callback' => array( self::class, 'sanitize_event_category_mappings' ), 'sanitize_callback' => array( self::class, 'sanitize_event_category_mappings' ),
) )
@ -67,7 +67,7 @@ class Settings {
'activitypub_event_bridge_initially_activated', 'activitypub_event_bridge_initially_activated',
array( array(
'type' => 'boolean', 'type' => 'boolean',
'description' => \__( 'Whether the plugin just got activated for the first time.', 'activitypub-event-bridge' ), 'description' => \__( 'Whether the plugin just got activated for the first time.', 'activitypub' ),
'default' => 1, 'default' => 1,
) )
); );

View file

@ -252,7 +252,7 @@ class Setup {
* *
* @return \Activitypub\Transformer\Base|null * @return \Activitypub\Transformer\Base|null
*/ */
public function register_activitypub_event_transformer( $transformer, $wp_object, $object_class ): \Activitypub\Transformer\Base { public function register_activitypub_event_transformer( $transformer, $wp_object, $object_class ): \Activitypub\Transformer\Base|null {
// If the current WordPress object is not a post (e.g., a WP_Comment), don't change the transformer. // If the current WordPress object is not a post (e.g., a WP_Comment), don't change the transformer.
if ( 'WP_Post' !== $object_class ) { if ( 'WP_Post' !== $object_class ) {
return $transformer; return $transformer;

View file

@ -1,29 +0,0 @@
{
"name": "activitypub-event-bridge",
"version": "0.1.0",
"author": {
"name": "André Menrath",
"web": "https://graz.social/@linos"
},
"scripts": {
"dev": "wp-scripts start",
"build": "wp-scripts build",
"readme": "grunt wp_readme_to_markdown",
"env-start": "wp-env start && wp-env run cli wp rewrite structure '/%year%/%monthnum%/%postname%/'",
"env-stop": "wp-env stop"
},
"license": "AGPL-3.0",
"bugs": {
"url": "https://code.event-federation.eu/Event-Federation/wordpress-activitypub-event-bridge/issues"
},
"devDependencies": {
"@wordpress/env": "^10.10.0",
"@wordpress/scripts": "^30.0.2",
"classnames": "^2.3.2",
"grunt": "^1.1.0",
"grunt-checktextdomain": "^1.0.1",
"grunt-wp-i18n": "^1.0.3",
"grunt-wp-readme-to-markdown": "^2.0.1"
}
}

View file

@ -29,9 +29,6 @@
<!-- Exclude minified Javascript files. --> <!-- Exclude minified Javascript files. -->
<exclude-pattern>*.min.js</exclude-pattern> <exclude-pattern>*.min.js</exclude-pattern>
<!-- Exclude the Grundfile.js. -->
<exclude-pattern>Gruntfile.js</exclude-pattern>
<!-- Strip the filepaths down to the relevant bit. --> <!-- Strip the filepaths down to the relevant bit. -->
<arg name="basepath" value="."/> <arg name="basepath" value="."/>

View file

@ -3,8 +3,8 @@ Contributors: andremenrath
Tags: events, fediverse, activitypub, calendar Tags: events, fediverse, activitypub, calendar
Requires at least: 6.5 Requires at least: 6.5
Tested up to: 6.6 Tested up to: 6.6
Stable tag: 0.2.0 Stable tag: 0.1.0
Requires PHP: 7.4 Requires PHP: 8.1
License: AGPL-3.0-or-later License: AGPL-3.0-or-later
License URI: https://www.gnu.org/licenses/agpl-3.0.html License URI: https://www.gnu.org/licenses/agpl-3.0.html
Integrating popular event plugins with the ActivityPub plugin. Integrating popular event plugins with the ActivityPub plugin.
@ -31,8 +31,6 @@ These platforms create public event calendars by pulling in events from various
![](./.wordpress-org/decentralized-event-calenders.gif) ![](./.wordpress-org/decentralized-event-calenders.gif)
Even platforms that don't yet fully support events, like [Mastodon](https://joinmastodon.org), will still receive a detailed, well-composed summary of your event.
The Event Federation plugin ensures that users from those platforms are provided with all important information about an event.
= Features for Your WordPress Events and the Fediverse = = Features for Your WordPress Events and the Fediverse =
@ -60,16 +58,17 @@ This plugin depends on the [ActivityPub plugin](https://wordpress.org/plugins/ac
== Configuration == == Configuration ==
If you're new to the [ActivityPub plugin](https://wordpress.org/plugins/activitypub/), its recommended to spend a few minutes reading through its documentation to familiarize yourself with its setup and functionality. If youre new to the [ActivityPub plugin](https://wordpress.org/plugins/activitypub/), its recommended to spend a few minutes reading through its documentation to familiarize yourself with its setup and functionality.
== Frequently Asked Questions == == Frequently Asked Questions ==
= Do I need to install another event plugin to use the Event Federation Plugin? = = Do I need to install another event plugin to use the Event Federation Plugin? =
Yes, this plugin works as an add-on and requires both the ActivityPub plugin and a supported event plugin such as The Events Calendar, VS Event List, or Events Manager to manage your events. It just fills the missing gap between event plugins and the [ActivityPub plugin](https://wordpress.org/plugins/activitypub/). Yes, this plugin works as an add-on and requires both the ActivityPub plugin and a supported event plugin such as The Events Calendar, VS Event List, or Events Manager to manage your events.
= What platforms can follow my events? = = What platforms can follow my events? =
Your events can be followed on platforms that support ActivityPub like [Mobilizon](https://joinmobilizon.org/), [Gancio](https://gancio.org), [Friendica](https://friendi.ca), [Hubzilla](https://hubzilla.org), and [Pleroma](https://pleroma.social/). Even other applications like [Mastodon](https://joinmastodon.org), which don't fully support events yet, will display all important information about the events. Your events can be followed on platforms that support ActivityPub like [Mobilizon](https://joinmobilizon.org/), [Gancio](https://gancio.org), [Friendica](https://friendi.ca), [Hubzilla](https://hubzilla.org), and [Pleroma](https://pleroma.social/). Even other applications like [Mastodon](https://joinmastodon.org), which dont fully support events yet, will display all important information about the events.
= How much extra work is required to maintain my events across the decentralized Web? = = How much extra work is required to maintain my events across the decentralized Web? =
@ -93,6 +92,6 @@ We're always interested in your feedback. Feel free to reach out to us via [E-Ma
== Changelog == == Changelog ==
= [0.2.0] 2024-10-29 = = [0.1.0] 2024-09-01 =
* Initial release on https://wordpress.org/ * Initial alpha release on WordPress.org