Skip to content

Platform & Connection Actions โ€‹

These cover platform connection events (OAuth responses, permission revocation) and the dynamic _{platform} settings seam โ€” the hooks a platform integration listens on to expose its settings, credential verification, and editor state. Combine them with BaseFeed / BaseReview to register a platform.

Connection events โ€‹

wpsocialreviews/{platform}_api_connect_response โ€” A platform API returned a connection response

When it runs: Fires after a platform's connect/verify API call returns. Dedicated variants exist for feeds (e.g. instagram_feed_api_connect_response, facebook_feed_api_connect_response, tiktok_feed_api_connect_response).

Parameters:

  • $response (mixed): the raw API response.

Source: Services/Helper.php; Feeds/Instagram/Common.php; Feeds/Facebook/FacebookFeed.php; TikTok TiktokFeed.php

Usage:

php
add_action('wpsocialreviews/instagram_feed_api_connect_response', function ($response) {
    // log or audit a new Instagram connection
});
wpsocialreviews/{platform}_feed_app_permission_revoked โ€” A platform revoked app permission

When it runs: fires when a platform reports that the app's permission/token was revoked (Instagram, Facebook, TikTok).

Parameters: none

Source: Feeds/Instagram/Common.php, Feeds/Facebook/FacebookFeed.php, TikTok TiktokFeed.php

Usage:

php
add_action('wpsocialreviews/facebook_feed_app_permission_revoked', function () {
    // alert the admin that Facebook needs re-authorization
});
wpsocialreviews/active_platforms ยท before_display_tiktok_feed
HookArgsSource
wpsocialreviews/active_platforms$platformsPlatformController.php
wpsocialreviews/before_display_tiktok_feed$account_idsTikTok ShortcodeHandler.php

The dynamic _{platform} settings seam โ€‹

Replace {platform} with the platform slug (e.g. facebook_feed, google, tiktok). These route the admin UI and controllers to your platform's handlers.

wpsocialreviews/verify_credential_{platform} โ€” Verify a platform's credentials

When it runs: Fires when the admin submits credentials for a platform. Implement it to validate the API key/OAuth result and persist the connection.

Parameters:

  • $settings (array): the submitted credential settings.

Source: app/Http/Controllers/Platforms/Feeds/ConfigsController.php

Usage:

php
add_action('wpsocialreviews/verify_credential_myplatform', function ($settings) {
    if (empty($settings['api_key'])) {
        return;
    }
    // validate and store the connection for "myplatform"
});
Settings & editor hooks โ€” get/save_advance_settings, get/update/edit_editor_settings, clear-cache/verification

When they run: as the admin reads/writes a platform's advanced settings and template editor state, or clears its cache/verification.

HookArgs
wpsocialreviews/get_advance_settings_{platform}โ€”
wpsocialreviews/save_advance_settings_{platform}$settings
wpsocialreviews/clear_cache_{platform}$cacheType
wpsocialreviews/get_editor_settings_{platform}$data
wpsocialreviews/update_editor_settings_{platform}$settings, $postId
wpsocialreviews/edit_editor_settings_{platform}$settings, $postId
wpsocialreviews/get_verification_configs_{platform}โ€”
wpsocialreviews/clear_verification_configs_{platform}$userId
wpsocialreviews/clear_reviews_verification_configs_{platform}$sourceId

Source: SettingsController.php, Feeds/MetaController.php, Feeds/ConfigsController.php, Reviews/ConfigsController.php

Usage:

php
add_action('wpsocialreviews/save_advance_settings_myplatform', function ($settings) {
    update_option('wpsr_reviews_myplatform', $settings, 'no');
});

One argument only

save_advance_settings_{platform} is fired with exactly one argument โ€” do_action('wpsocialreviews/save_advance_settings_' . $platform, $settings) in SettingsController::update(). Registering with add_action(..., 10, 2) gains you nothing; declare a single parameter, and default it if your callback may be invoked elsewhere.

Chat settings โ€” get/update/delete_chat_settings

When they run: when chat widget settings are read, saved, or deleted.

Source: app/Http/Controllers/Platforms/Chats/MetaController.php

See Platform Services for how these combine with the base classes.

WP Social Ninja Developer Documentation