README

=== FediBoost ===
Contributors: kraftbj
Tags: activitypub, mastodon, fediverse, boost, social
Requires at least: 6.9
Tested up to: 7.1
Requires PHP: 7.4
Stable tag: 1.1.0
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html

Automatically boost WordPress posts on connected Mastodon accounts when published via ActivityPub.

== Description ==

FediBoost extends the ActivityPub plugin by automatically boosting your WordPress posts on your connected Mastodon accounts when they are published.

When you publish a new post on your WordPress site, FediBoost will automatically boost (reblog) that post on your linked Mastodon account, helping increase visibility across the fediverse.

**Features:**

* Automatic boosting of new posts to connected Mastodon accounts
* Choose which post types are boosted
* Seamless integration with the ActivityPub plugin
* No additional configuration required after setup

**Requirements:**

* The [ActivityPub plugin](https://wordpress.org/plugins/activitypub/) must be installed and configured
* A connected Mastodon account via ActivityPub

== Installation ==

1. Ensure the ActivityPub plugin is installed and activated.
2. Upload the `fediboost` folder to `/wp-content/plugins/` or install via the WordPress plugin installer.
3. Activate FediBoost through the Plugins menu.
4. Go to Settings > FediBoost.
5. Enter your Mastodon instance URL (e.g., mastodon.social) and authorize the connection.
6. New posts will automatically be boosted to your connected Mastodon account when published.

== Frequently Asked Questions ==

= Does this plugin work without the ActivityPub plugin? =

No, FediBoost requires the ActivityPub plugin to be installed and properly configured. FediBoost extends ActivityPub's functionality to add automatic boosting capabilities.

= Can I choose which posts get boosted? =

Yes, by post type. Under Settings > FediBoost, choose which post types are boosted when published. Only post types the ActivityPub plugin federates are listed, and all of them are selected by default. Developers can use the `fediboost_should_boost_post` filter to programmatically control which posts are boosted. See the Developer Hooks section below for details.

= Why don't my own boosts show up as reposts on my posts? =

When FediBoost boosts a post, Mastodon sends that boost back to your site, and the ActivityPub plugin would normally record it as a "repost" on the post. Since that's just your own account boosting your own post, FediBoost discards reposts that come from any of your connected Mastodon accounts. Reposts from everyone else are recorded as usual. Developers can turn this off with the `fediboost_ignore_self_boosts` filter.

Reposts recorded before this was added can be removed with WP-CLI:

`wp fediboost cleanup-self-boosts --dry-run` lists them, `wp fediboost cleanup-self-boosts` moves them to the trash, and adding `--force` deletes them permanently. Only accounts still listed on the FediBoost settings page are matched, so run the cleanup before disconnecting an account.

= What happens if I change my WordPress authentication salts? =

FediBoost encrypts OAuth tokens using your WordPress authentication salts (defined in wp-config.php). If these salts are changed — for example, by a security plugin, during a security incident response, or by manually editing wp-config.php — all stored tokens will become invalid. You will need to reconnect your Mastodon accounts under Settings > FediBoost after any salt change. This is standard behavior for WordPress plugins that encrypt sensitive data using the built-in salts.

The OpenSSL PHP extension is required for token encryption. If OpenSSL is not available, FediBoost will not be able to store account credentials securely and will display an admin notice.

== Developer Hooks ==

FediBoost provides several filters that allow developers to customize its behavior. All filters follow WordPress coding standards and can be added to your theme's functions.php file or a custom plugin.

= fediboost_should_boost_post =

Control whether a specific post should be boosted. Return false to skip boosting for the given post. Default: true.

**Parameters:**

* `$should_boost` (bool) — Whether the post should be boosted.
* `$post` (WP_Post) — The post object being published.

**Example:**

`add_filter( 'fediboost_should_boost_post', function( $should_boost, $post ) {
    // Don't boost posts in the "internal" category.
    if ( has_category( 'internal', $post ) ) {
        return false;
    }
    return $should_boost;
}, 10, 2 );`

= fediboost_boost_delay =

Delay in seconds after ActivityPub federation completes before the boost is executed. This delay is only used when the federation completion hook fires successfully. Default: 30.

**Parameters:**

* `$delay` (int) — The delay in seconds.

**Example:**

`add_filter( 'fediboost_boost_delay', function( $delay ) {
    // Wait 2 minutes after federation before boosting.
    return 120;
} );`

= fediboost_fallback_delay =

Delay in seconds before a boost is executed when the ActivityPub federation completion hook does not fire. This acts as a safety net for older versions of the ActivityPub plugin that do not support the `activitypub_outbox_processing_complete` hook. If the federation hook fires first, the fallback is cancelled and `fediboost_boost_delay` is used instead. Default: 300 (5 minutes).

**Parameters:**

* `$delay` (int) — The fallback delay in seconds.

**Example:**

`add_filter( 'fediboost_fallback_delay', function( $delay ) {
    // Wait 10 minutes in the fallback path.
    return 600;
} );`

= fediboost_manage_capability =

WordPress capability required to manage FediBoost settings. Default: 'manage_options'. Note: a floor of 'edit_others_posts' is enforced regardless of this filter's return value, so you cannot lower the requirement below that capability.

**Parameters:**

* `$capability` (string) — The required capability.

**Example:**

`add_filter( 'fediboost_manage_capability', function( $capability ) {
    // Allow editors to manage FediBoost settings.
    return 'edit_others_posts';
} );`

= fediboost_max_accounts =

Maximum number of connected Mastodon accounts. Default: 10.

**Parameters:**

* `$max` (int) — The maximum number of accounts.

**Example:**

`add_filter( 'fediboost_max_accounts', function( $max ) {
    // Allow up to 25 connected accounts.
    return 25;
} );`

= fediboost_ignore_self_boosts =

Whether reposts from connected Mastodon accounts are discarded instead of being recorded as "repost" interactions on the post. Default: true.

**Parameters:**

* `$ignore` (bool) — Whether to discard the repost.
* `$commentdata` (array) — Comment data for the incoming repost.

**Example:**

`// Keep recording reposts from connected accounts.
add_filter( 'fediboost_ignore_self_boosts', '__return_false' );`

== External Services ==

FediBoost connects to external Mastodon instances that you configure (e.g., mastodon.social). This communication is essential for the plugin to function and is initiated only with the instance you explicitly provide.

**During setup:**

* FediBoost registers an OAuth application on your Mastodon instance and performs an authorization flow so it can act on your behalf.

**When a post is published:**

* FediBoost searches for the post on your Mastodon instance and performs a reblog (boost) via the Mastodon API.

**Data sent to your Mastodon instance:**

* Your instance URL
* OAuth authorization codes
* Search queries to locate your posts
* Reblog (boost) requests

**Data stored locally on your WordPress site:**

* Encrypted OAuth tokens
* Your Mastodon username
* Your Mastodon instance URL

Each Mastodon instance has its own privacy policy and terms of service. You can find a list of instances and their policies at [joinmastodon.org/servers](https://joinmastodon.org/servers).

This plugin does not send data to any third-party service other than the Mastodon instance(s) you explicitly configure.

== Changelog ==

= 1.1.0 =
* Add a Post Types setting to choose which post types are boosted. Defaults to every post type the ActivityPub plugin federates, so existing sites see no change.
* Stop recording reposts from connected Mastodon accounts, so a site's own boosts no longer show up as reposts on its posts.
* Add `wp fediboost cleanup-self-boosts` to remove those reposts recorded by earlier versions.
* Add the `fediboost_ignore_self_boosts` filter to keep recording them.
* Tested up to WordPress 7.1.

= 1.0.1 =
* Delay boost scheduling until after ActivityPub federation completes
* Add fallback boost scheduling for older ActivityPub versions

= 1.0.0 =
* Initial release
* Automatic boosting of published posts to connected Mastodon accounts
fediboost / fediboost

Package info

Security

Statistics

README
