Developers

Filters

File Filter Name Description
/lib/includes/class-wp-to-social-pro-repost.php
  wp_to_socialpilot_pro_repost_get_post_ids Filters WP_Query arguments for fetching Post IDs for a given Post Type, that are then checked to see if reposting is required.
/lib/includes/class-wp-to-social-pro-bulk-publish.php
  wp_to_socialpilot_pro_bulk_publish_get_post_ids Filters WP_Query arguments for fetching Post IDs for a given Post Type, that are then checked to see if reposting is required.
/lib/includes/class-wp-to-social-pro-publish.php
  wp_to_socialpilot_pro_publish_statuses Determine the statuses to send, just before they're sent. Statuses can be added, edited and/or deleted as necessary here.
  wp_to_socialpilot_pro_publish_condition_passed Determine if a statuses meta conditionals have been met, where the conditional is not a plugin standard option.
  wp_to_socialpilot_pro_publish_builds_args_schedule_ statusschedule Allows integrations to define when the status should be scheduled for publication
  wp_to_socialpilot_pro_publish_text_to_image Defines the text to use for the text to image.
  wp_to_socialpilot_pro_publish_build_args Determine the standardised arguments array to send via the API for a status message's settings.
  wp_to_socialpilot_pro_publish_parse_text_term_name Defines the Taxonomy Term Name to replace the status template tag.
  wp_to_socialpilot_pro_publish_parse_text_term_hashtag_retain_case Defines the Taxonomy Term Hashtag to replace the status template tag.
  wp_to_socialpilot_pro_publish_parse_text_term_hashtag Defines the Taxonomy Term Hashtag to replace the status template tag.
  wp_to_socialpilot_pro_term Backward compat filter to define the Taxonomy Term Name to replace the status template tag. _publish_parse_text_term_name and _publish_parse_text_term_hashtag should be used instead.
  wp_to_socialpilot_pro_publish_parse_text Filters the parsed status message text on a status.
  wp_to_socialpilot_pro_publish_parse_google_business_start_date_ statusgooglebusinessstart_date_option Allows integrations to define the status' start date for a Google Business Profile Offer or Event.
  wp_to_socialpilot_pro_publish_parse_google_business_end_date_ statusgooglebusinessend_date_option Allows integrations to define the status' end date for a Google Business Profile Offer or Event.
  wp_to_socialpilot_pro_publish_apply_text_transformation Applies the given transformation to the given value
  wp_to_socialpilot_pro_process_profile_mentions Parses profile mentions, adding entities arguments to the $args array and updating the text that's sent to the API
  wp_to_socialpilot_pro_publish_get_all_possible_searches_replacements Registers any additional status message tags, and their Post data replacements, that are supported.
  wp_to_socialpilot_pro_publish_register_post_searches_replacements Registers any additional status message tags, and their Post data replacements, that are supported for the given Post.
  wp_to_socialpilot_pro_publish_register_author_searches_replacements Registers any additional status message tags, and their Author data replacements, that are supported for the given Post Author.
  wp_to_socialpilot_pro_publish_get_title Filters the dynamic {title} replacement, when a Post's status is being built.
  wp_to_socialpilot_pro_publish_get_excerpt Filters the dynamic {excerpt} replacement, when a Post's status is being built.
  wp_to_socialpilot_pro_publish_get_content Filters the dynamic {content} replacement, when a Post's status is being built.
  wp_to_socialpilot_pro_publish_get_date Returns the date in the locale specified in WordPress.private function get_date( $post ) {$date = date_i18n( get_option( 'date_format' ), strtotime( $post->post_date ) );/ Filters the dynamic {date} replacement, when a Post's status is being built.
  wp_to_socialpilot_pro_publish_get_permalink Filters the Post's Permalink, including or excluding a trailing slash, depending on the Plugin settings
  wp_to_socialpilot_pro_publish_get_short_permalink Filters the Post's Permalink, including or excluding a trailing slash, depending on the Plugin settings
  wp_to_socialpilot_pro_publish_apply_word_limit Applies the given word limit to the given text.
  wp_to_socialpilot_pro_publish_apply_sentence_limit Applies the given sentence limit to the given text.
  wp_to_socialpilot_pro_publish_apply_character_limit Filters the character limited text.
/lib/includes/class-wp-to-social-pro-bulk-actions.php
  wp_to_socialpilot_pro_bulk_actions_register_bulk_actions Defines Bulk Actions to be added to the select dropdown on WP_List_Tables.
/lib/includes/class-wp-to-social-pro-log.php
  wp_to_socialpilot_pro_get_log Filters the log entries before output.
  wp_to_socialpilot_pro_log_get_result_options Defines the available result options
  wp_to_socialpilot_pro_log_get_log_levels Defines the available log levels
/lib/includes/class-wp-to-social-pro-common.php
  wp_to_socialpilot_pro_get_days Defines the available days.
  wp_to_socialpilot_pro_get_schedule_options Defines the available schedule options for each individual status.
  wp_to_socialpilot_pro_get_schedule_relative_days Defines the available days for a status' Custom Time (Relative Format) option.
  wp_to_socialpilot_pro_get_schedule_custom_relation_options Defines the available schedule options, relative to a custom field, for each individual status.
  wp_to_socialpilot_pro_get_google_business_start_date_options Defines the available start date options for a Google Business Profile status.
  wp_to_socialpilot_pro_get_google_business_end_date_options Defines the available start date options for a Google Business Profile status.
  wp_to_socialpilot_pro_get_post_types Defines the available Post Type Objects that can have statues defined and be sent to social media.
  wp_to_socialpilot_pro_get_excluded_post_types Defines the Post Type Objects that cannot have statues defined and not be sent to social media.
  wp_to_socialpilot_pro_get_excluded_taxonomies Defines taxonomies to exclude from the Conditions: Taxonomies dropdowns for each individual status.
  wp_to_socialpilot_pro_get_taxonomies Defines available taxonomies for the given Post Type, which are used in the Conditions: Taxonomies dropdowns for each individual status.
  wp_to_socialpilot_pro_get_all_taxonomies Defines available taxonomies, regardless of Post Type, which are used in the Conditions: Taxonomies dropdowns for each individual status.
  wp_to_socialpilot_pro_get_user_roles Defines WordPress User Roles.
  wp_to_socialpilot_pro_get_excluded_user_roles Defines WordPress User Roles to exclude from Settings screens.
  wp_to_socialpilot_pro_get_repost_frequency_units Defines available Reposting frequency units when defining Repost status(es).
  wp_to_socialpilot_pro_get_tags Defines Dynamic Status Tags that can be inserted into status(es) for the given Post Type. These tags are also added to any 'Insert Tag' dropdowns.
  wp_to_socialpilot_pro_get_post_actions Defines the Post actions which trigger status(es) to be sent to social media.
  wp_to_socialpilot_pro_get_post_actions_past_tense Defines the Post actions which trigger status(es) to be sent to social media, with labels set to the past tense.
  wp_to_socialpilot_pro_get_condition_options Defines the available Options for Taxonomy Terms Conditionals.
  wp_to_socialpilot_pro_get_override_options Defines the available override options to display in the meta box for individual Posts.
  wp_to_socialpilot_pro_get_authors Defines the available override options to display in the meta box for individual Posts.
  wp_to_socialpilot_pro_get_meta_compare Backward compatible filter; defines the available Post comparison operators, used for Conditional Options on status(es).
  wp_to_socialpilot_pro_get_comparison_operators Defines the available Post comparison operators, used for Conditional Options on status(es).
  wp_to_socialpilot_pro_get_custom_field_comparison_operators Defines the available Custom Field comparison operators, used for Conditional Options on status(es).
  wp_to_socialpilot_pro_get_order_by Defines the available WP_Query compatible order by options.
  wp_to_socialpilot_pro_get_order Defines the available WP_Query compatible order options.
  wp_to_socialpilot_pro_get_tags_excluded_from_character_limit Defines the tags that cannot have a character limit applied to them, as doing so would wrongly concatenate data (e.g. a URL would become malformed).
  wp_to_socialpilot_pro_get_fonts Defines the available TTF fonts for use with Text to Image
  wp_to_socialpilot_pro_get_transient_expiration_time Defines the number of seconds before expiring transients.
  wp_to_socialpilot_pro_maybe_remove_profiles_by_role Defines the number of seconds before expiring transients.
  wp_to_socialpilot_pro_maybe_remove_post_types_by_role Defines the number of seconds before expiring transients.
  wp_to_socialpilot_pro_get_log_filters Defines the registered filters that can be used on the Log WP_List_Tables.
/lib/includes/class-wp-to-social-pro-validation.php
  wp_to_socialpilot_pro_validate_check_for_duplicates_status_keys Defines the key values to compare across all statuses for a Post Type and Social Profile combination, to ensure no duplicate statuses have been defined.
/lib/includes/class-wp-to-social-pro-settings.php
  wp_to_socialpilot_pro_get_settings Filters Post Type Settings before they are returned.
  wp_to_socialpilot_pro_update_settings Filters Post Type Settings before they are saved.
  wp_to_socialpilot_pro_default_installation_settings Filters Default Post Type Settings used on Plugin Activation before they are returned.
  wp_to_socialpilot_pro_settings_get_status_row_schedule Output Schedule settings for Integrations / Third Party Plugins
  wp_to_socialpilot_pro_settings_get_default_status Returns a skeleton status object for the given action, used when defining new status(es)
  wp_to_socialpilot_pro_settings_validate_status Filters status settings during validation, allowing them to be changed.
  wp_to_socialpilot_pro_update_access_token Filters the API access token before saving.
  wp_to_socialpilot_pro_update_refresh_token Filters the API refresh token before saving.
  wp_to_socialpilot_pro_update_token_expires Filters the API token expiry timestamp token before saving.
  wp_to_socialpilot_pro_update_option Filters the key and value pair before saving to the options table.
  wp_to_socialpilot_pro_get_all Filters the keys that are used to store Plugin data in the options table.
/lib/includes/class-wp-to-social-pro-date.php
  wp_to_socialpilot_pro_common_convert_wordpress_gmt_offset_to_offset_value Converts WordPress' GMT Offset (e.g. -5, +3.3) to an offset value compatible with WordPress' DateTime object (e.g. -0500, +0330)
/lib/includes/integrations/class-wp-to-social-pro-the-events-calendar.php
  wp_to_socialpilot_pro_publish_register_the_events_calendar_searches_replacements Registers any additional status message tags, and their Post data replacements, that are supported for The Events Calendar
/lib/includes/integrations/class-wp-to-social-pro-seopress.php
  wp_to_socialpilot_pro_publish_register_seopress_searches_replacements Registers any additional status message tags, and their Post data replacements, that are supported for SEOPress.
/lib/includes/integrations/class-wp-to-social-pro-woocommerce.php
  wp_to_socialpilot_pro_publish_register_woocommerce_searches_replacements Registers any additional status message tags, and their Post data replacements, that are supported for WooCommerce.
/lib/includes/integrations/class-wp-to-social-pro-featured-image-caption.php
  wp_to_socialpilot_pro_publish_register_featured_image_caption_searches_replacements Registers any additional status message tags, and their Post data replacements, that are supported for the Featured Image Caption Plugin.
/lib/includes/integrations/class-wp-to-social-pro-yoast-seo.php
  wp_to_socialpilot_pro_publish_register_yoast_seo_searches_replacements Registers any additional status message tags, and their Post data replacements, that are supported for Yoast SEO.
/lib/includes/integrations/class-wp-to-social-pro-rank-math.php
  wp_to_socialpilot_pro_publish_register_rank_math_searches_replacements Registers any additional status message tags, and their Post data replacements, that are supported for Rank Math SEO.
/lib/includes/integrations/class-wp-to-social-pro-aioseo.php
  wp_to_socialpilot_pro_publish_register_aio_seo_searches_replacements Registers any additional status message tags, and their Post data replacements, that are supported for AIOSEO.
/lib/includes/integrations/class-wp-to-social-pro-events-manager.php
  wp_to_socialpilot_pro_publish_register_events_manager_searches_replacements Registers any additional status message tags, and their Post data replacements, that are supported for Events Manager
/lib/includes/class-wp-to-social-pro-image.php
  wp_to_socialpilot_pro_get_featured_image_options Defines the available Featured Image select dropdown options on a status, depending on the Plugin and Social Network the status message is for.
  wp_to_socialpilot_pro_get_social_media_image_size Defines the image size limit for the given social media service.
  wp_to_socialpilot_pro_get_social_media_image_sizes Defines the optimal image sizes for each social network.
  wp_to_socialpilot_pro_get_opengraph_seo_plugins Defines the Plugins that output OpenGraph metadata on Posts, Pages and Custom Post Types.
/lib/includes/class-wp-to-social-pro-post.php
  wp_to_socialpilot_pro_get_post_meta Filters Status Settings for a specific Post.
/lib/includes/class-wp-to-social-pro-admin.php
  wp_to_socialpilot_pro_admin_get_autocomplete_configuration Defines configuration for tribute.js autocomplete instances for Tags, Facebook Pages and Twitter Username mentions.
  wp_to_socialpilot_pro_admin_admin_menu_minimum_capability Defines the minimum capability required to access the Media Library Organizer Menu and Sub Menus
/lib/includes/class-wp-to-social-pro-notices.php
  wp_to_socialpilot_pro_notices_get_success_notices Filters the success notices to return.
  wp_to_socialpilot_pro_notices_get_warning_notices Filters the error notices to return.
  wp_to_socialpilot_pro_notices_get_error_notices Filters the error notices to return.
  wp_to_socialpilot_pro_notices_get_notices Filters the success and error notices to return.
  wp_to_socialpilot_pro_notices_save Filters the success and error notices to save.

wp_to_socialpilot_pro_repost_get_post_ids /lib/includes/class-wp-to-social-pro-repost.php::310

Overview

Filters WP_Query arguments for fetching Post IDs for a given Post Type, that are then checked to see if reposting is required.

Parameters

Parameter Type Description
$args array WP_Query Arguments.
$post_type string Post Type.

Usage

add_filter( 'wp_to_socialpilot_pro_repost_get_post_ids', function( $args, $post_type ) {
	// ... your code here
	// Return value
	return $args;
}, 10, 2 );


wp_to_socialpilot_pro_bulk_publish_get_post_ids /lib/includes/class-wp-to-social-pro-bulk-publish.php::310

Overview

Filters WP_Query arguments for fetching Post IDs for a given Post Type, that are then checked to see if reposting is required.

Parameters

Parameter Type Description
$args array WP_Query Arguments.
$post_type string Post Type.
$params array Search Parameters.

Usage

add_filter( 'wp_to_socialpilot_pro_bulk_publish_get_post_ids', function( $args, $post_type, $params ) {
	// ... your code here
	// Return value
	return $args;
}, 10, 3 );


wp_to_socialpilot_pro_publish_statuses /lib/includes/class-wp-to-social-pro-publish.php::839

Overview

Determine the statuses to send, just before they're sent. Statuses can be added, edited and/or deleted as necessary here.

Parameters

Parameter Type Description
$statuses array Statuses to be sent to social media.
$post_id int Post ID.
$action string Action (publish, update, repost).

Usage

add_filter( 'wp_to_socialpilot_pro_publish_statuses', function( $statuses, $post_id, $action ) {
	// ... your code here
	// Return value
	return $statuses;
}, 10, 3 );


wp_to_socialpilot_pro_publish_condition_passed /lib/includes/class-wp-to-social-pro-publish.php::1502

Overview

Determine if a statuses meta conditionals have been met, where the conditional is not a plugin standard option.

Parameters

Parameter Type Description
$condition_passed bool Condition Passed.
$comparison string Comparison Method.
$type string Type (post|user).
$id int Post or Author ID.
$post_value string Post Value.
$condition_value string Condition Value.
$condition_key mixed Condition Key (false | string).

Usage

add_filter( 'wp_to_socialpilot_pro_publish_condition_passed', function( true, $comparison, $type, $id, $value, $condition_value, $condition_key = false ) {
	// ... your code here
	// Return value
	return true;
}, 10, 7 );


wp_to_socialpilot_pro_publish_builds_args_schedule_ statusschedule /lib/includes/class-wp-to-social-pro-publish.php::1704

Overview

Allows integrations to define when the status should be scheduled for publication

Parameters

Parameter Type Description
$scheduled_at string Schedule Status (yyyy-mm-dd hh:mm:ss format).
$status array Status.
WordPress WP_Post $post Post.

Usage

add_filter( 'wp_to_socialpilot_pro_publish_builds_args_schedule_  statusschedule', function( $scheduled_at, $status, $post ) {
	// ... your code here
	// Return value
	return $scheduled_at;
}, 10, 3 );


wp_to_socialpilot_pro_publish_text_to_image /lib/includes/class-wp-to-social-pro-publish.php::1775

Overview

Defines the text to use for the text to image.

Parameters

Parameter Type Description
$text_to_image string Text.
$post WP_Post WordPress Post.
$profile_id string Social Media Profile ID.
$service string Social Media Service.
$status array Parsed Status Message Settings.
$action string Action (publish|update|repost|bulk_publish).

Usage

add_filter( 'wp_to_socialpilot_pro_publish_text_to_image', function( $text_to_image, $post, $profile_id, $service, $status, $action ) {
	// ... your code here
	// Return value
	return $text_to_image;
}, 10, 6 );


wp_to_socialpilot_pro_publish_build_args /lib/includes/class-wp-to-social-pro-publish.php::1917

Overview

Determine the standardised arguments array to send via the API for a status message's settings.

Parameters

Parameter Type Description
$args array API standardised arguments.
$post WP_Post WordPress Post.
$profile_id string Social Media Profile ID.
$service string Social Media Service.
$status array Parsed Status Message Settings.
$action string Action (publish|update|repost|bulk_publish).

Usage

add_filter( 'wp_to_socialpilot_pro_publish_build_args', function( $args, $post, $profile_id, $service, $status, $action ) {
	// ... your code here
	// Return value
	return $args;
}, 10, 6 );


wp_to_socialpilot_pro_publish_parse_text_term_name /lib/includes/class-wp-to-social-pro-publish.php::2232

Overview

Defines the Taxonomy Term Name to replace the status template tag.

Parameters

Parameter Type Description
$term_name string Term Name.
$tag_params['taxonomy_term_format'] string Term
$term WP_Term Term.
$tag_params['taxonomy'] string Taxonomy.
$text string Status Text.

Usage

add_filter( 'wp_to_socialpilot_pro_publish_parse_text_term_name', function( $term_name, $tag_params['taxonomy_term_format'], $term, $tag_params['taxonomy'], $text ) {
	// ... your code here
	// Return value
	return $term_name;
}, 10, 5 );


wp_to_socialpilot_pro_publish_parse_text_term_hashtag_retain_case /lib/includes/class-wp-to-social-pro-publish.php::2258

Overview

Defines the Taxonomy Term Hashtag to replace the status template tag.

Parameters

Parameter Type Description
$term_name string Term Name.
$tag_params['taxonomy_term_format'] string Term
$term WP_Term Term.
$tag_params['taxonomy'] string Taxonomy.
$text string Status Text.

Usage

add_filter( 'wp_to_socialpilot_pro_publish_parse_text_term_hashtag_retain_case', function( $term_name, $tag_params['taxonomy_term_format'], $term, $tag_params['taxonomy'], $text ) {
	// ... your code here
	// Return value
	return $term_name;
}, 10, 5 );


wp_to_socialpilot_pro_publish_parse_text_term_hashtag /lib/includes/class-wp-to-social-pro-publish.php::2285

Overview

Defines the Taxonomy Term Hashtag to replace the status template tag.

Parameters

Parameter Type Description
$term_name string Term Name.
$tag_params['taxonomy_term_format'] string Term
$term WP_Term Term.
$tag_params['taxonomy'] string Taxonomy.
$text string Status Text.

Usage

add_filter( 'wp_to_socialpilot_pro_publish_parse_text_term_hashtag', function( $term_name, $tag_params['taxonomy_term_format'], $term, $tag_params['taxonomy'], $text ) {
	// ... your code here
	// Return value
	return $term_name;
}, 10, 5 );


wp_to_socialpilot_pro_term /lib/includes/class-wp-to-social-pro-publish.php::2301

Overview

Backward compat filter to define the Taxonomy Term Name to replace the status template tag. _publish_parse_text_term_name and _publish_parse_text_term_hashtag should be used instead.

Parameters

Parameter Type Description
$term_name string Term Name.
$term->name string Term Name.
$tag_params['taxonomy'] string Taxonomy.
$text string Status Text.
$tag_params['taxonomy_term_format'] string Term Format.

Usage

add_filter( 'wp_to_socialpilot_pro_term', function( $term_name, $term->name, $tag_params['taxonomy'], $text, $tag_params['taxonomy_term_format'] ) {
	// ... your code here
	// Return value
	return $term_name;
}, 10, 5 );


wp_to_socialpilot_pro_publish_parse_text /lib/includes/class-wp-to-social-pro-publish.php::2352

Overview

Filters the parsed status message text on a status.

Parameters

Parameter Type Description
$text string Parsed Text, no Tags.
$message string Unparsed Text with Tags.
$searches_replacements array Specific Tag Search and Replacements for the given Text.
$all_possible_searches_replacements array All Registered Tag Search and Replacements.
$post WP_Post WordPress Post.
$author WP_User WordPress User (Author).

Usage

add_filter( 'wp_to_socialpilot_pro_publish_parse_text', function( $text, $message, $searches_replacements, $all_possible_searches_replacements, $post, $author ) {
	// ... your code here
	// Return value
	return $text;
}, 10, 6 );


wp_to_socialpilot_pro_publish_parse_google_business_start_date_ statusgooglebusinessstart_date_option /lib/includes/class-wp-to-social-pro-publish.php::2450

Overview

Allows integrations to define the status' start date for a Google Business Profile Offer or Event.

Parameters

Parameter Type Description
Date bool|string $date (yyyy-mm-dd
$google_business_args array Google Business specific arguments for status.
$status array Status.
$post WP_Post WordPress Post.

Usage

add_filter( 'wp_to_socialpilot_pro_publish_parse_google_business_start_date_  statusgooglebusinessstart_date_option', function( $date, $google_business_args, $status, $post ) {
	// ... your code here
	// Return value
	return $date;
}, 10, 4 );


wp_to_socialpilot_pro_publish_parse_google_business_end_date_ statusgooglebusinessend_date_option /lib/includes/class-wp-to-social-pro-publish.php::2505

Overview

Allows integrations to define the status' end date for a Google Business Profile Offer or Event.

Parameters

Parameter Type Description
Date bool|string $date (yyyy-mm-dd
$google_business_args array Google Business specific arguments for status.
$status array Status.
$post WP_Post WordPress Post.

Usage

add_filter( 'wp_to_socialpilot_pro_publish_parse_google_business_end_date_  statusgooglebusinessend_date_option', function( $date, $google_business_args, $status, $post ) {
	// ... your code here
	// Return value
	return $date;
}, 10, 4 );


wp_to_socialpilot_pro_publish_apply_text_transformation /lib/includes/class-wp-to-social-pro-publish.php::2766

Overview

Applies the given transformation to the given value

Parameters

Parameter Type Description
$value string Value.
$transformation string Transformation.

Usage

add_filter( 'wp_to_socialpilot_pro_publish_apply_text_transformation', function( $value, $transformation ) {
	// ... your code here
	// Return value
	return $value;
}, 10, 2 );


wp_to_socialpilot_pro_process_profile_mentions /lib/includes/class-wp-to-social-pro-publish.php::2884

Overview

Parses profile mentions, adding entities arguments to the $args array and updating the text that's sent to the API

Parameters

Parameter Type Description
$args array API standardised arguments.
WordPress WP_Post $post Post.
$profile_id string Social Media Profile ID.
$service string Social Media Service.
$status array Parsed Status Message Settings.
$action string Action (publish|update|repost|bulk_publish).

Usage

add_filter( 'wp_to_socialpilot_pro_process_profile_mentions', function( $args, $post, $profile_id, $service, $status, $action ) {
	// ... your code here
	// Return value
	return $args;
}, 10, 6 );


wp_to_socialpilot_pro_publish_get_all_possible_searches_replacements /lib/includes/class-wp-to-social-pro-publish.php::2927

Overview

Registers any additional status message tags, and their Post data replacements, that are supported.

Parameters

Parameter Type Description
$searches_replacements array Registered Supported Tags and their Replacements.
$post WP_Post WordPress Post.
$author WP_User WordPress User (Author of the Post).

Usage

add_filter( 'wp_to_socialpilot_pro_publish_get_all_possible_searches_replacements', function( $searches_replacements, $post, $author ) {
	// ... your code here
	// Return value
	return $searches_replacements;
}, 10, 3 );


wp_to_socialpilot_pro_publish_register_post_searches_replacements /lib/includes/class-wp-to-social-pro-publish.php::3045

Overview

Registers any additional status message tags, and their Post data replacements, that are supported for the given Post.

Parameters

Parameter Type Description
$searches_replacements array Registered Supported Tags and their Replacements.
$post WP_Post WordPress Post.
$taxonomies array Post Taxonomies.

Usage

add_filter( 'wp_to_socialpilot_pro_publish_register_post_searches_replacements', function( $searches_replacements, $post, $taxonomies ) {
	// ... your code here
	// Return value
	return $searches_replacements;
}, 10, 3 );


wp_to_socialpilot_pro_publish_register_author_searches_replacements /lib/includes/class-wp-to-social-pro-publish.php::3012

Overview

Registers any additional status message tags, and their Author data replacements, that are supported for the given Post Author.

Parameters

Parameter Type Description
$searches_replacements array Registered Supported Tags and their Replacements.
$author WP_User WordPress Post Author.

Usage

add_filter( 'wp_to_socialpilot_pro_publish_register_author_searches_replacements', function( $searches_replacements, $author ) {
	// ... your code here
	// Return value
	return $searches_replacements;
}, 10, 2 );


wp_to_socialpilot_pro_publish_get_title /lib/includes/class-wp-to-social-pro-publish.php::3116

Overview

Filters the dynamic {title} replacement, when a Post's status is being built.

Parameters

Parameter Type Description
$title string Post Title.
$post WP_Post WordPress Post.

Usage

add_filter( 'wp_to_socialpilot_pro_publish_get_title', function( $title, $post ) {
	// ... your code here
	// Return value
	return $title;
}, 10, 2 );


wp_to_socialpilot_pro_publish_get_excerpt /lib/includes/class-wp-to-social-pro-publish.php::3161

Overview

Filters the dynamic {excerpt} replacement, when a Post's status is being built.

Parameters

Parameter Type Description
$excerpt string Post Excerpt.
$post WP_Post WordPress Post.

Usage

add_filter( 'wp_to_socialpilot_pro_publish_get_excerpt', function( $excerpt, $post ) {
	// ... your code here
	// Return value
	return $excerpt;
}, 10, 2 );


wp_to_socialpilot_pro_publish_get_content /lib/includes/class-wp-to-social-pro-publish.php::3238

Overview

Filters the dynamic {content} replacement, when a Post's status is being built.

Parameters

Parameter Type Description
$content string Post Content.
$post WP_Post WordPress Post.
$is_gutenberg_post_content bool Is Gutenberg Post Content.

Usage

add_filter( 'wp_to_socialpilot_pro_publish_get_content', function( $content, $post, $is_gutenberg_post_content ) {
	// ... your code here
	// Return value
	return $content;
}, 10, 3 );


wp_to_socialpilot_pro_publish_get_date /lib/includes/class-wp-to-social-pro-publish.php::3265

Overview

Returns the date in the locale specified in WordPress.private function get_date( $post ) {$date = date_i18n( get_option( 'date_format' ), strtotime( $post->post_date ) );/ Filters the dynamic {date} replacement, when a Post's status is being built.

Parameters

Parameter Type Description
WordPress WP_Post $post Post.
$date string Date.
$post WP_Post WordPress Post.

Usage

add_filter( 'wp_to_socialpilot_pro_publish_get_date', function( $date, $post ) {
	// ... your code here
	// Return value
	return $date;
}, 10, 2 );


Overview

Filters the Post's Permalink, including or excluding a trailing slash, depending on the Plugin settings

Parameters

Parameter Type Description
$url string WordPress Post Permalink.
$post WP_Post WordPress Post.
$force_trailing_forwardslash bool Force Trailing Forwardslash.

Usage

add_filter( 'wp_to_socialpilot_pro_publish_get_permalink', function( $url, $post, $force_trailing_forwardslash ) {
	// ... your code here
	// Return value
	return $url;
}, 10, 3 );


Overview

Filters the Post's Permalink, including or excluding a trailing slash, depending on the Plugin settings

Parameters

Parameter Type Description
$url string WordPress Post Permalink.
$post WP_Post WordPress Post.

Usage

add_filter( 'wp_to_socialpilot_pro_publish_get_short_permalink', function( $url, $post ) {
	// ... your code here
	// Return value
	return $url;
}, 10, 2 );


wp_to_socialpilot_pro_publish_apply_word_limit /lib/includes/class-wp-to-social-pro-publish.php::3449

Overview

Applies the given word limit to the given text.

Parameters

Parameter Type Description
$text string Text, with word limit applied.
$word_limit int Sentence Limit.
$original_text string Original Text, with no limit applied.

Usage

add_filter( 'wp_to_socialpilot_pro_publish_apply_word_limit', function( $text, $word_limit, $original_text ) {
	// ... your code here
	// Return value
	return $text;
}, 10, 3 );


wp_to_socialpilot_pro_publish_apply_sentence_limit /lib/includes/class-wp-to-social-pro-publish.php::3497

Overview

Applies the given sentence limit to the given text.

Parameters

Parameter Type Description
$text string Text, with word limit applied.
$sentence_limit int Sentence Limit.
$original_text string Original Text, with no limit applied.

Usage

add_filter( 'wp_to_socialpilot_pro_publish_apply_sentence_limit', function( $text, $sentence_limit, $original_text ) {
	// ... your code here
	// Return value
	return $text;
}, 10, 3 );


wp_to_socialpilot_pro_publish_apply_character_limit /lib/includes/class-wp-to-social-pro-publish.php::3536

Overview

Filters the character limited text.

Parameters

Parameter Type Description
$text string Text, with character limit applied.
$character_limit int Character Limit used.

Usage

add_filter( 'wp_to_socialpilot_pro_publish_apply_character_limit', function( $text, $character_limit ) {
	// ... your code here
	// Return value
	return $text;
}, 10, 2 );


wp_to_socialpilot_pro_bulk_actions_register_bulk_actions /lib/includes/class-wp-to-social-pro-bulk-actions.php::94

Overview

Defines Bulk Actions to be added to the select dropdown on WP_List_Tables.

Parameters

Parameter Type Description
$bulk_actions array Plugin Specific Bulk Actions.
$actions string Existing Registered Bulk Actions (excluding Plugin Specific Bulk Actions).

Usage

add_filter( 'wp_to_socialpilot_pro_bulk_actions_register_bulk_actions', function( $bulk_actions, $actions ) {
	// ... your code here
	// Return value
	return $bulk_actions;
}, 10, 2 );


wp_to_socialpilot_pro_get_log /lib/includes/class-wp-to-social-pro-log.php::459

Overview

Filters the log entries before output.

Parameters

Parameter Type Description
$log array Post Log.
$post_id int Post ID.

Usage

add_filter( 'wp_to_socialpilot_pro_get_log', function( $log, $post_id ) {
	// ... your code here
	// Return value
	return $log;
}, 10, 2 );


wp_to_socialpilot_pro_log_get_result_options /lib/includes/class-wp-to-social-pro-log.php::523

Overview

Defines the available result options

Parameters

Parameter Type Description
$result_options array Result Options.

Usage

add_filter( 'wp_to_socialpilot_pro_log_get_result_options', function( $result_options ) {
	// ... your code here
	// Return value
	return $result_options;
}, 10, 1 );


wp_to_socialpilot_pro_log_get_log_levels /lib/includes/class-wp-to-social-pro-log.php::555

Overview

Defines the available log levels

Parameters

Parameter Type Description
$log_levels array Log Levels.

Usage

add_filter( 'wp_to_socialpilot_pro_log_get_log_levels', function( $log_levels ) {
	// ... your code here
	// Return value
	return $log_levels;
}, 10, 1 );


wp_to_socialpilot_pro_get_days /lib/includes/class-wp-to-social-pro-common.php::67

Overview

Defines the available days.

Parameters

Parameter Type Description
$days array Days.

Usage

add_filter( 'wp_to_socialpilot_pro_get_days', function( $days ) {
	// ... your code here
	// Return value
	return $days;
}, 10, 1 );


wp_to_socialpilot_pro_get_schedule_options /lib/includes/class-wp-to-social-pro-common.php::187

Overview

Defines the available schedule options for each individual status.

Parameters

Parameter Type Description
$schedule array Schedule Options.
$post_type string Post Type.
$is_post_screen bool On Post Edit Screen.

Usage

add_filter( 'wp_to_socialpilot_pro_get_schedule_options', function( $schedule, $post_type, $is_post_screen ) {
	// ... your code here
	// Return value
	return $schedule;
}, 10, 3 );


wp_to_socialpilot_pro_get_schedule_relative_days /lib/includes/class-wp-to-social-pro-common.php::223

Overview

Defines the available days for a status' Custom Time (Relative Format) option.

Parameters

Parameter Type Description
$days array Days.

Usage

add_filter( 'wp_to_socialpilot_pro_get_schedule_relative_days', function( $days ) {
	// ... your code here
	// Return value
	return $days;
}, 10, 1 );


wp_to_socialpilot_pro_get_schedule_custom_relation_options /lib/includes/class-wp-to-social-pro-common.php::252

Overview

Defines the available schedule options, relative to a custom field, for each individual status.

Parameters

Parameter Type Description
$schedule array Schedule Options.

Usage

add_filter( 'wp_to_socialpilot_pro_get_schedule_custom_relation_options', function( $schedule ) {
	// ... your code here
	// Return value
	return $schedule;
}, 10, 1 );


wp_to_socialpilot_pro_get_google_business_start_date_options /lib/includes/class-wp-to-social-pro-common.php::281

Overview

Defines the available start date options for a Google Business Profile status.

Parameters

Parameter Type Description
$schedule array Schedule Options.

Usage

add_filter( 'wp_to_socialpilot_pro_get_google_business_start_date_options', function( $schedule, $post_type ) {
	// ... your code here
	// Return value
	return $schedule;
}, 10, 2 );


wp_to_socialpilot_pro_get_google_business_end_date_options /lib/includes/class-wp-to-social-pro-common.php::310

Overview

Defines the available start date options for a Google Business Profile status.

Parameters

Parameter Type Description
$schedule array Schedule Options.

Usage

add_filter( 'wp_to_socialpilot_pro_get_google_business_end_date_options', function( $schedule, $post_type ) {
	// ... your code here
	// Return value
	return $schedule;
}, 10, 2 );


wp_to_socialpilot_pro_get_post_types /lib/includes/class-wp-to-social-pro-common.php::349

Overview

Defines the available Post Type Objects that can have statues defined and be sent to social media.

Parameters

Parameter Type Description
$types array Post Types.

Usage

add_filter( 'wp_to_socialpilot_pro_get_post_types', function( $types ) {
	// ... your code here
	// Return value
	return $types;
}, 10, 1 );


wp_to_socialpilot_pro_get_excluded_post_types /lib/includes/class-wp-to-social-pro-common.php::380

Overview

Defines the Post Type Objects that cannot have statues defined and not be sent to social media.

Parameters

Parameter Type Description
$types array Post Types.

Usage

add_filter( 'wp_to_socialpilot_pro_get_excluded_post_types', function( $types ) {
	// ... your code here
	// Return value
	return $types;
}, 10, 1 );


wp_to_socialpilot_pro_get_excluded_taxonomies /lib/includes/class-wp-to-social-pro-common.php::409

Overview

Defines taxonomies to exclude from the Conditions: Taxonomies dropdowns for each individual status.

Parameters

Parameter Type Description
$taxonomies array Excluded Taxonomies.

Usage

add_filter( 'wp_to_socialpilot_pro_get_excluded_taxonomies', function( $taxonomies ) {
	// ... your code here
	// Return value
	return $taxonomies;
}, 10, 1 );


wp_to_socialpilot_pro_get_taxonomies /lib/includes/class-wp-to-social-pro-common.php::448

Overview

Defines available taxonomies for the given Post Type, which are used in the Conditions: Taxonomies dropdowns for each individual status.

Parameters

Parameter Type Description
$taxonomies array Taxonomies.
$post_type string Post Type.

Usage

add_filter( 'wp_to_socialpilot_pro_get_taxonomies', function( $taxonomies, $post_type ) {
	// ... your code here
	// Return value
	return $taxonomies;
}, 10, 2 );


wp_to_socialpilot_pro_get_all_taxonomies /lib/includes/class-wp-to-social-pro-common.php::485

Overview

Defines available taxonomies, regardless of Post Type, which are used in the Conditions: Taxonomies dropdowns for each individual status.

Parameters

Parameter Type Description
$taxonomies array Taxonomies.

Usage

add_filter( 'wp_to_socialpilot_pro_get_all_taxonomies', function( $taxonomies ) {
	// ... your code here
	// Return value
	return $taxonomies;
}, 10, 1 );


wp_to_socialpilot_pro_get_user_roles /lib/includes/class-wp-to-social-pro-common.php::519

Overview

Defines WordPress User Roles.

Parameters

Parameter Type Description
$roles array WordPress User Roles.

Usage

add_filter( 'wp_to_socialpilot_pro_get_user_roles', function( $roles ) {
	// ... your code here
	// Return value
	return $roles;
}, 10, 1 );


wp_to_socialpilot_pro_get_excluded_user_roles /lib/includes/class-wp-to-social-pro-common.php::547

Overview

Defines WordPress User Roles to exclude from Settings screens.

Parameters

Parameter Type Description
$excluded_roles array Excluded WordPress User Roles

Usage

add_filter( 'wp_to_socialpilot_pro_get_excluded_user_roles', function( $excluded_roles ) {
	// ... your code here
	// Return value
	return $excluded_roles;
}, 10, 1 );


wp_to_socialpilot_pro_get_repost_frequency_units /lib/includes/class-wp-to-social-pro-common.php::577

Overview

Defines available Reposting frequency units when defining Repost status(es).

Parameters

Parameter Type Description
$units array Repost Frequency Units.

Usage

add_filter( 'wp_to_socialpilot_pro_get_repost_frequency_units', function( $units ) {
	// ... your code here
	// Return value
	return $units;
}, 10, 1 );


wp_to_socialpilot_pro_get_tags /lib/includes/class-wp-to-social-pro-common.php::698

Overview

Defines Dynamic Status Tags that can be inserted into status(es) for the given Post Type. These tags are also added to any 'Insert Tag' dropdowns.

Parameters

Parameter Type Description
$tags array Dynamic Status Tags.
$post_type string Post Type.

Usage

add_filter( 'wp_to_socialpilot_pro_get_tags', function( $tags, $post_type ) {
	// ... your code here
	// Return value
	return $tags;
}, 10, 2 );


wp_to_socialpilot_pro_get_post_actions /lib/includes/class-wp-to-social-pro-common.php::772

Overview

Defines the Post actions which trigger status(es) to be sent to social media.

Parameters

Parameter Type Description
$actions array Post Actions.

Usage

add_filter( 'wp_to_socialpilot_pro_get_post_actions', function( $actions ) {
	// ... your code here
	// Return value
	return $actions;
}, 10, 1 );


wp_to_socialpilot_pro_get_post_actions_past_tense /lib/includes/class-wp-to-social-pro-common.php::804

Overview

Defines the Post actions which trigger status(es) to be sent to social media, with labels set to the past tense.

Parameters

Parameter Type Description
$actions array Post Actions.

Usage

add_filter( 'wp_to_socialpilot_pro_get_post_actions_past_tense', function( $actions ) {
	// ... your code here
	// Return value
	return $actions;
}, 10, 1 );


wp_to_socialpilot_pro_get_condition_options /lib/includes/class-wp-to-social-pro-common.php::835

Overview

Defines the available Options for Taxonomy Terms Conditionals.

Parameters

Parameter Type Description
$options array Condition Options.

Usage

add_filter( 'wp_to_socialpilot_pro_get_condition_options', function( $options ) {
	// ... your code here
	// Return value
	return $options;
}, 10, 1 );


wp_to_socialpilot_pro_get_override_options /lib/includes/class-wp-to-social-pro-common.php::873

Overview

Defines the available override options to display in the meta box for individual Posts.

Parameters

Parameter Type Description
$options array Condition Options.

Usage

add_filter( 'wp_to_socialpilot_pro_get_override_options', function( $options ) {
	// ... your code here
	// Return value
	return $options;
}, 10, 1 );


wp_to_socialpilot_pro_get_authors /lib/includes/class-wp-to-social-pro-common.php::910

Overview

Defines the available override options to display in the meta box for individual Posts.

Parameters

Parameter Type Description
$authors array WordPress Users.

Usage

add_filter( 'wp_to_socialpilot_pro_get_authors', function( $authors ) {
	// ... your code here
	// Return value
	return $authors;
}, 10, 1 );


wp_to_socialpilot_pro_get_meta_compare /lib/includes/class-wp-to-social-pro-common.php::949

Overview

Backward compatible filter; defines the available Post comparison operators, used for Conditional Options on status(es).

Parameters

Parameter Type Description
$comparison_operators array Comparison Operators.

Usage

add_filter( 'wp_to_socialpilot_pro_get_meta_compare', function( $comparison_operators ) {
	// ... your code here
	// Return value
	return $comparison_operators;
}, 10, 1 );


wp_to_socialpilot_pro_get_comparison_operators /lib/includes/class-wp-to-social-pro-common.php::958

Overview

Defines the available Post comparison operators, used for Conditional Options on status(es).

Parameters

Parameter Type Description
$comparison_operators array Comparison Operators.

Usage

add_filter( 'wp_to_socialpilot_pro_get_comparison_operators', function( $comparison_operators ) {
	// ... your code here
	// Return value
	return $comparison_operators;
}, 10, 1 );


wp_to_socialpilot_pro_get_custom_field_comparison_operators /lib/includes/class-wp-to-social-pro-common.php::998

Overview

Defines the available Custom Field comparison operators, used for Conditional Options on status(es).

Parameters

Parameter Type Description
$comparison_operators array Comparison Operators.

Usage

add_filter( 'wp_to_socialpilot_pro_get_custom_field_comparison_operators', function( $comparison_operators ) {
	// ... your code here
	// Return value
	return $comparison_operators;
}, 10, 1 );


wp_to_socialpilot_pro_get_order_by /lib/includes/class-wp-to-social-pro-common.php::1033

Overview

Defines the available WP_Query compatible order by options.

Parameters

Parameter Type Description
$order_by array Order By options.

Usage

add_filter( 'wp_to_socialpilot_pro_get_order_by', function( $order_by ) {
	// ... your code here
	// Return value
	return $order_by;
}, 10, 1 );


wp_to_socialpilot_pro_get_order /lib/includes/class-wp-to-social-pro-common.php::1062

Overview

Defines the available WP_Query compatible order options.

Parameters

Parameter Type Description
$order array Order options.

Usage

add_filter( 'wp_to_socialpilot_pro_get_order', function( $order ) {
	// ... your code here
	// Return value
	return $order;
}, 10, 1 );


wp_to_socialpilot_pro_get_tags_excluded_from_character_limit /lib/includes/class-wp-to-social-pro-common.php::1094

Overview

Defines the tags that cannot have a character limit applied to them, as doing so would wrongly concatenate data (e.g. a URL would become malformed).

Parameters

Parameter Type Description
$tags array Tags.

Usage

add_filter( 'wp_to_socialpilot_pro_get_tags_excluded_from_character_limit', function( $tags ) {
	// ... your code here
	// Return value
	return $tags;
}, 10, 1 );


wp_to_socialpilot_pro_get_fonts /lib/includes/class-wp-to-social-pro-common.php::1127

Overview

Defines the available TTF fonts for use with Text to Image

Parameters

Parameter Type Description
$fonts array Fonts.

Usage

add_filter( 'wp_to_socialpilot_pro_get_fonts', function( $fonts ) {
	// ... your code here
	// Return value
	return $fonts;
}, 10, 1 );


wp_to_socialpilot_pro_get_transient_expiration_time /lib/includes/class-wp-to-social-pro-common.php::1153

Overview

Defines the number of seconds before expiring transients.

Parameters

Parameter Type Description
$expiration_time int Transient Expiration Time, in seconds.

Usage

add_filter( 'wp_to_socialpilot_pro_get_transient_expiration_time', function( $expiration_time ) {
	// ... your code here
	// Return value
	return $expiration_time;
}, 10, 1 );


wp_to_socialpilot_pro_maybe_remove_profiles_by_role /lib/includes/class-wp-to-social-pro-common.php::1206

Overview

Defines the number of seconds before expiring transients.

Parameters

Parameter Type Description
$arr array Post Type or Post Settings.
$role string WordPress Role Name.

Usage

add_filter( 'wp_to_socialpilot_pro_maybe_remove_profiles_by_role', function( $arr, $role ) {
	// ... your code here
	// Return value
	return $arr;
}, 10, 2 );


wp_to_socialpilot_pro_maybe_remove_post_types_by_role /lib/includes/class-wp-to-social-pro-common.php::1251

Overview

Defines the number of seconds before expiring transients.

Parameters

Parameter Type Description
$post_types array Post Types.
$role string WordPress Role Name.

Usage

add_filter( 'wp_to_socialpilot_pro_maybe_remove_post_types_by_role', function( $post_types, $role ) {
	// ... your code here
	// Return value
	return $post_types;
}, 10, 2 );


wp_to_socialpilot_pro_get_log_filters /lib/includes/class-wp-to-social-pro-common.php::1285

Overview

Defines the registered filters that can be used on the Log WP_List_Tables.

Parameters

Parameter Type Description
$filters array Filters.

Usage

add_filter( 'wp_to_socialpilot_pro_get_log_filters', function( $filters ) {
	// ... your code here
	// Return value
	return $filters;
}, 10, 1 );


wp_to_socialpilot_pro_validate_check_for_duplicates_status_keys /lib/includes/class-wp-to-social-pro-validation.php::154

Overview

Defines the key values to compare across all statuses for a Post Type and Social Profile combination, to ensure no duplicate statuses have been defined.

Parameters

Parameter Type Description
$status_keys_to_compare array Status Key Values to Compare.

Usage

add_filter( 'wp_to_socialpilot_pro_validate_check_for_duplicates_status_keys', function( $status_keys_to_compare ) {
	// ... your code here
	// Return value
	return $status_keys_to_compare;
}, 10, 1 );


wp_to_socialpilot_pro_get_settings /lib/includes/class-wp-to-social-pro-settings.php::283

Overview

Filters Post Type Settings before they are returned.

Parameters

Parameter Type Description
$settings array Settings.
$type string Post Type.

Usage

add_filter( 'wp_to_socialpilot_pro_get_settings', function( $settings, $type ) {
	// ... your code here
	// Return value
	return $settings;
}, 10, 2 );


wp_to_socialpilot_pro_update_settings /lib/includes/class-wp-to-social-pro-settings.php::312

Overview

Filters Post Type Settings before they are saved.

Parameters

Parameter Type Description
$settings array Settings.
$type string Post Type.

Usage

add_filter( 'wp_to_socialpilot_pro_update_settings', function( $settings, $type ) {
	// ... your code here
	// Return value
	return $settings;
}, 10, 2 );


wp_to_socialpilot_pro_default_installation_settings /lib/includes/class-wp-to-social-pro-settings.php::399

Overview

Filters Default Post Type Settings used on Plugin Activation before they are returned.

Parameters

Parameter Type Description
$settings array Settings.
$type string Post Type.

Usage

add_filter( 'wp_to_socialpilot_pro_default_installation_settings', function( $settings ) {
	// ... your code here
	// Return value
	return $settings;
}, 10, 1 );


wp_to_socialpilot_pro_settings_get_status_row_schedule /lib/includes/class-wp-to-social-pro-settings.php::596

Overview

Output Schedule settings for Integrations / Third Party Plugins

Parameters

Parameter Type Description
$output string Output.
$status array Status.
$action string Action.
$post_type string Post Type.
$schedule array Schedule Options.

Usage

add_filter( 'wp_to_socialpilot_pro_settings_get_status_row_schedule', function( $output, $status, $action, $post_type, $schedule ) {
	// ... your code here
	// Return value
	return $output;
}, 10, 5 );


wp_to_socialpilot_pro_settings_get_default_status /lib/includes/class-wp-to-social-pro-settings.php::708

Overview

Returns a skeleton status object for the given action, used when defining new status(es)

Parameters

Parameter Type Description
$status array Status.

Usage

add_filter( 'wp_to_socialpilot_pro_settings_get_default_status', function( $status ) {
	// ... your code here
	// Return value
	return $status;
}, 10, 1 );


wp_to_socialpilot_pro_settings_validate_status /lib/includes/class-wp-to-social-pro-settings.php::829

Overview

Filters status settings during validation, allowing them to be changed.

Parameters

Parameter Type Description
$status array Status.

Usage

add_filter( 'wp_to_socialpilot_pro_settings_validate_status', function( $status ) {
	// ... your code here
	// Return value
	return $status;
}, 10, 1 );


wp_to_socialpilot_pro_update_access_token /lib/includes/class-wp-to-social-pro-settings.php::896

Overview

Filters the API access token before saving.

Parameters

Parameter Type Description
$access_token array Access Token.

Usage

add_filter( 'wp_to_socialpilot_pro_update_access_token', function( $access_token ) {
	// ... your code here
	// Return value
	return $access_token;
}, 10, 1 );


wp_to_socialpilot_pro_update_refresh_token /lib/includes/class-wp-to-social-pro-settings.php::947

Overview

Filters the API refresh token before saving.

Parameters

Parameter Type Description
$refresh_token array Refresh Token.

Usage

add_filter( 'wp_to_socialpilot_pro_update_refresh_token', function( $refresh_token ) {
	// ... your code here
	// Return value
	return $refresh_token;
}, 10, 1 );


wp_to_socialpilot_pro_update_token_expires /lib/includes/class-wp-to-social-pro-settings.php::998

Overview

Filters the API token expiry timestamp token before saving.

Parameters

Parameter Type Description
$token_expires array Token Expiry.

Usage

add_filter( 'wp_to_socialpilot_pro_update_token_expires', function( $token_expires ) {
	// ... your code here
	// Return value
	return $token_expires;
}, 10, 1 );


wp_to_socialpilot_pro_update_option /lib/includes/class-wp-to-social-pro-settings.php::1084

Overview

Filters the key and value pair before saving to the options table.

Parameters

Parameter Type Description
$value string Option Value.
$key string Option Key.

Usage

add_filter( 'wp_to_socialpilot_pro_update_option', function( $value, $key ) {
	// ... your code here
	// Return value
	return $value;
}, 10, 2 );


wp_to_socialpilot_pro_get_all /lib/includes/class-wp-to-social-pro-settings.php::1142

Overview

Filters the keys that are used to store Plugin data in the options table.

Parameters

Parameter Type Description
$keys array Option Keys.
$post_types array Post Types.

Usage

add_filter( 'wp_to_socialpilot_pro_get_all', function( $keys, $post_types ) {
	// ... your code here
	// Return value
	return $keys;
}, 10, 2 );


wp_to_socialpilot_pro_common_convert_wordpress_gmt_offset_to_offset_value /lib/includes/class-wp-to-social-pro-date.php::166

Overview

Converts WordPress' GMT Offset (e.g. -5, +3.3) to an offset value compatible with WordPress' DateTime object (e.g. -0500, +0330)

Parameters

Parameter Type Description
$gmt_offset string GMT Offset (e.g. -0500, +0330).

Usage

add_filter( 'wp_to_socialpilot_pro_common_convert_wordpress_gmt_offset_to_offset_value', function( $gmt_offset ) {
	// ... your code here
	// Return value
	return $gmt_offset;
}, 10, 1 );


wp_to_socialpilot_pro_publish_register_the_events_calendar_searches_replacements /lib/includes/integrations/class-wp-to-social-pro-the-events-calendar.php::331

Overview

Registers any additional status message tags, and their Post data replacements, that are supported for The Events Calendar

Parameters

Parameter Type Description
$searches_replacements array Registered Supported Tags and their Replacements.
$post WP_Post WordPress Post.
$author WP_User WordPress User (Author of the Post).

Usage

add_filter( 'wp_to_socialpilot_pro_publish_register_the_events_calendar_searches_replacements', function( $searches_replacements, $post, $author ) {
	// ... your code here
	// Return value
	return $searches_replacements;
}, 10, 3 );


wp_to_socialpilot_pro_publish_register_seopress_searches_replacements /lib/includes/integrations/class-wp-to-social-pro-seopress.php::124

Overview

Registers any additional status message tags, and their Post data replacements, that are supported for SEOPress.

Parameters

Parameter Type Description
$searches_replacements array Registered Supported Tags and their Replacements.
$post WP_Post WordPress Post.
$author WP_User WordPress User (Author of the Post).

Usage

add_filter( 'wp_to_socialpilot_pro_publish_register_seopress_searches_replacements', function( $searches_replacements, $post, $author ) {
	// ... your code here
	// Return value
	return $searches_replacements;
}, 10, 3 );


wp_to_socialpilot_pro_publish_register_woocommerce_searches_replacements /lib/includes/integrations/class-wp-to-social-pro-woocommerce.php::156

Overview

Registers any additional status message tags, and their Post data replacements, that are supported for WooCommerce.

Parameters

Parameter Type Description
$searches_replacements array Registered Supported Tags and their Replacements.
$post WP_Post WordPress Post.
WordPress WP_User $author User

Usage

add_filter( 'wp_to_socialpilot_pro_publish_register_woocommerce_searches_replacements', function( $searches_replacements, $post, $author ) {
	// ... your code here
	// Return value
	return $searches_replacements;
}, 10, 3 );


Overview

Registers any additional status message tags, and their Post data replacements, that are supported for the Featured Image Caption Plugin.

Parameters

Parameter Type Description
$searches_replacements array Registered Supported Tags and their Replacements..
$post WP_Post WordPress Post.
$author WP_User WordPress User (Author of the Post).

Usage

add_filter( 'wp_to_socialpilot_pro_publish_register_featured_image_caption_searches_replacements', function( $searches_replacements, $post, $author ) {
	// ... your code here
	// Return value
	return $searches_replacements;
}, 10, 3 );


wp_to_socialpilot_pro_publish_register_yoast_seo_searches_replacements /lib/includes/integrations/class-wp-to-social-pro-yoast-seo.php::176

Overview

Registers any additional status message tags, and their Post data replacements, that are supported for Yoast SEO.

Parameters

Parameter Type Description
$searches_replacements array Registered Supported Tags and their Replacements.
$post WP_Post WordPress Post.
$author WP_User WordPress User (Author of the Post).

Usage

add_filter( 'wp_to_socialpilot_pro_publish_register_yoast_seo_searches_replacements', function( $searches_replacements, $post, $author ) {
	// ... your code here
	// Return value
	return $searches_replacements;
}, 10, 3 );


wp_to_socialpilot_pro_publish_register_rank_math_searches_replacements /lib/includes/integrations/class-wp-to-social-pro-rank-math.php::145

Overview

Registers any additional status message tags, and their Post data replacements, that are supported for Rank Math SEO.

Parameters

Parameter Type Description
$searches_replacements array Registered Supported Tags and their Replacements.
$post WP_Post WordPress Post.
$author WP_User WordPress User (Author of the Post).

Usage

add_filter( 'wp_to_socialpilot_pro_publish_register_rank_math_searches_replacements', function( $searches_replacements, $post, $author ) {
	// ... your code here
	// Return value
	return $searches_replacements;
}, 10, 3 );


wp_to_socialpilot_pro_publish_register_aio_seo_searches_replacements /lib/includes/integrations/class-wp-to-social-pro-aioseo.php::147

Overview

Registers any additional status message tags, and their Post data replacements, that are supported for AIOSEO.

Parameters

Parameter Type Description
$searches_replacements array Registered Supported Tags and their Replacements.
$post WP_Post WordPress Post.
$author WP_User WordPress User (Author of the Post).

Usage

add_filter( 'wp_to_socialpilot_pro_publish_register_aio_seo_searches_replacements', function( $searches_replacements, $post, $author ) {
	// ... your code here
	// Return value
	return $searches_replacements;
}, 10, 3 );


wp_to_socialpilot_pro_publish_register_events_manager_searches_replacements /lib/includes/integrations/class-wp-to-social-pro-events-manager.php::352

Overview

Registers any additional status message tags, and their Post data replacements, that are supported for Events Manager

Parameters

Parameter Type Description
$searches_replacements array Registered Supported Tags and their Replacements.
$post WP_Post WordPress Post.
$author WP_User WordPress User (Author of the Post).

Usage

add_filter( 'wp_to_socialpilot_pro_publish_register_events_manager_searches_replacements', function( $searches_replacements, $post, $author ) {
	// ... your code here
	// Return value
	return $searches_replacements;
}, 10, 3 );


Overview

Defines the available Featured Image select dropdown options on a status, depending on the Plugin and Social Network the status message is for.

Parameters

Parameter Type Description
$options array Featured Image Dropdown Options.
$network string Social Network.

Usage

add_filter( 'wp_to_socialpilot_pro_get_featured_image_options', function( $options, $network ) {
	// ... your code here
	// Return value
	return $options;
}, 10, 2 );


wp_to_socialpilot_pro_get_social_media_image_size /lib/includes/class-wp-to-social-pro-image.php::260

Overview

Defines the image size limit for the given social media service.

Parameters

Parameter Type Description
$image_size array Image Size (width, height).
$service string Social Media Service.

Usage

add_filter( 'wp_to_socialpilot_pro_get_social_media_image_size', function( $image_size, $service ) {
	// ... your code here
	// Return value
	return $image_size;
}, 10, 2 );


wp_to_socialpilot_pro_get_social_media_image_sizes /lib/includes/class-wp-to-social-pro-image.php::488

Overview

Defines the optimal image sizes for each social network.

Parameters

Parameter Type Description
$image_sizes array Image Sizes

Usage

add_filter( 'wp_to_socialpilot_pro_get_social_media_image_sizes', function( $image_sizes ) {
	// ... your code here
	// Return value
	return $image_sizes;
}, 10, 1 );


wp_to_socialpilot_pro_get_opengraph_seo_plugins /lib/includes/class-wp-to-social-pro-image.php::516

Overview

Defines the Plugins that output OpenGraph metadata on Posts, Pages and Custom Post Types.

Parameters

Parameter Type Description
$plugins array Plugins

Usage

add_filter( 'wp_to_socialpilot_pro_get_opengraph_seo_plugins', function( $plugins ) {
	// ... your code here
	// Return value
	return $plugins;
}, 10, 1 );


wp_to_socialpilot_pro_get_post_meta /lib/includes/class-wp-to-social-pro-post.php::470

Overview

Filters Status Settings for a specific Post.

Parameters

Parameter Type Description
$settings array Post Settings.
$post_id int Post ID.

Usage

add_filter( 'wp_to_socialpilot_pro_get_post_meta', function( $settings, $post_id ) {
	// ... your code here
	// Return value
	return $settings;
}, 10, 2 );


wp_to_socialpilot_pro_admin_get_autocomplete_configuration /lib/includes/class-wp-to-social-pro-admin.php::595

Overview

Defines configuration for tribute.js autocomplete instances for Tags, Facebook Pages and Twitter Username mentions.

Parameters

Parameter Type Description
$autocomplete_configuration array Autocomplete Configuration.
$post_type string Post Type.

Usage

add_filter( 'wp_to_socialpilot_pro_admin_get_autocomplete_configuration', function( $autocomplete_configuration ) {
	// ... your code here
	// Return value
	return $autocomplete_configuration;
}, 10, 1 );


wp_to_socialpilot_pro_admin_admin_menu_minimum_capability /lib/includes/class-wp-to-social-pro-admin.php::626

Overview

Defines the minimum capability required to access the Media Library Organizer Menu and Sub Menus

Parameters

Parameter Type Description
$capability string Minimum Required Capability.

Usage

add_filter( 'wp_to_socialpilot_pro_admin_admin_menu_minimum_capability', function( $minimum_capability ) {
	// ... your code here
	// Return value
	return $minimum_capability;
}, 10, 1 );


wp_to_socialpilot_pro_notices_get_success_notices /lib/includes/class-wp-to-social-pro-notices.php::134

Overview

Filters the success notices to return.

Parameters

Parameter Type Description
$success_notices array Success Notices.
$notices object Success and Error Notices.

Usage

add_filter( 'wp_to_socialpilot_pro_notices_get_success_notices', function( $success_notices, $notices ) {
	// ... your code here
	// Return value
	return $success_notices;
}, 10, 2 );


wp_to_socialpilot_pro_notices_get_warning_notices /lib/includes/class-wp-to-social-pro-notices.php::205

Overview

Filters the error notices to return.

Parameters

Parameter Type Description
$warning_notices array Warning Notices.
$notices object Success, Warning and Error Notices.

Usage

add_filter( 'wp_to_socialpilot_pro_notices_get_warning_notices', function( $warning_notices, $notices ) {
	// ... your code here
	// Return value
	return $warning_notices;
}, 10, 2 );


wp_to_socialpilot_pro_notices_get_error_notices /lib/includes/class-wp-to-social-pro-notices.php::268

Overview

Filters the error notices to return.

Parameters

Parameter Type Description
$error_notices array Error Notices.
$notices object Success and Error Notices.

Usage

add_filter( 'wp_to_socialpilot_pro_notices_get_error_notices', function( $error_notices, $notices ) {
	// ... your code here
	// Return value
	return $error_notices;
}, 10, 2 );


wp_to_socialpilot_pro_notices_get_notices /lib/includes/class-wp-to-social-pro-notices.php::325

Overview

Filters the success and error notices to return.

Parameters

Parameter Type Description
$notices array Success and Error Notices.

Usage

add_filter( 'wp_to_socialpilot_pro_notices_get_notices', function( $notices ) {
	// ... your code here
	// Return value
	return $notices;
}, 10, 1 );


wp_to_socialpilot_pro_notices_save /lib/includes/class-wp-to-social-pro-notices.php::369

Overview

Filters the success and error notices to save.

Parameters

Parameter Type Description
$notices array Success and Error Notices.

Usage

add_filter( 'wp_to_socialpilot_pro_notices_save', function( $notices ) {
	// ... your code here
	// Return value
	return $notices;
}, 10, 1 );


Actions

File Filter Name Description
/lib/views/settings-post-action-status.php
  wp_to_socialpilot_pro_output_schedule_options_form_fields Output Schedule settings for Integrations / Third Party Plugins
/lib/views/settings-auth-required.php
  wp_to_socialpilot_pro_output_auth Allow the API to output its authentication button link or form, to authenticate with the API.
/lib/includes/class-wp-to-social-pro-admin.php
  wp_to_socialpilot_pro_save_settings_auth
  wp_to_socialpilot_pro_admin_menu_import_export
  wp_to_socialpilot_pro_admin_menu_support
/lib/includes/class-wp-to-social-pro-notices.php
  wp_to_socialpilot_pro_notices_delete_notices

wp_to_socialpilot_pro_output_schedule_options_form_fields /lib/views/settings-post-action-status.php::134

Overview

Output Schedule settings for Integrations / Third Party Plugins

Parameters

Parameter Type Description
$post_type string Post Type

Usage

add_action( 'wp_to_socialpilot_pro_output_schedule_options_form_fields', function( $post_type ) {
	// ... your code here
}, 10, 1 );


wp_to_socialpilot_pro_output_auth /lib/views/settings-auth-required.php::59

Overview

Allow the API to output its authentication button link or form, to authenticate with the API.

Parameters

Parameter Type Description
$schedule array Schedule Options

Usage

add_action( 'wp_to_socialpilot_pro_output_auth', function(  ) {
	// ... your code here
}, 10, 0 );


wp_to_socialpilot_pro_save_settings_auth /lib/includes/class-wp-to-social-pro-admin.php::76

Parameters

Parameter Type Description

Usage

add_action( 'wp_to_socialpilot_pro_save_settings_auth', function(  ) {
	// ... your code here
}, 10, 0 );


wp_to_socialpilot_pro_admin_menu_import_export /lib/includes/class-wp-to-social-pro-admin.php::659

Parameters

Parameter Type Description

Usage

add_action( 'wp_to_socialpilot_pro_admin_menu_import_export', function(  ) {
	// ... your code here
}, 10, 0 );


wp_to_socialpilot_pro_admin_menu_support /lib/includes/class-wp-to-social-pro-admin.php::665

Parameters

Parameter Type Description

Usage

add_action( 'wp_to_socialpilot_pro_admin_menu_support', function(  ) {
	// ... your code here
}, 10, 0 );


wp_to_socialpilot_pro_notices_delete_notices /lib/includes/class-wp-to-social-pro-notices.php::398

Parameters

Parameter Type Description

Usage

add_action( 'wp_to_socialpilot_pro_notices_delete_notices', function(  ) {
	// ... your code here
}, 10, 0 );