WordPress to Hootsuite Pro: Filters and actions will start with wp_to_hootsuite_prowp_to_socialpilot_pro
Filters
File
Filter Name
Description
/lib/social/includes/class-common.php
wp_to_buffer_pro_get_daysDefines the available days.
wp_to_buffer_pro_get_status_post_type_optionsDefines the available status post type options.
wp_to_buffer_pro_get_schedule_optionsDefines the available schedule options for each individual status.
wp_to_buffer_pro_get_schedule_relative_daysDefines the available days for a status’ Custom Time (Relative Format) option.
wp_to_buffer_pro_get_schedule_custom_relation_optionsDefines the available schedule options, relative to a custom field, for each individual status.
wp_to_buffer_pro_get_google_business_start_date_optionsDefines the available start date options for a Google Business Profile status.
wp_to_buffer_pro_get_google_business_end_date_optionsDefines the available start date options for a Google Business Profile status.
wp_to_buffer_pro_get_post_typesDefines the available Post Type Objects that can have statues defined and be sent to social media.
wp_to_buffer_pro_get_excluded_post_typesDefines the Post Type Objects that cannot have statues defined and not be sent to social media.
wp_to_buffer_pro_get_excluded_taxonomiesDefines taxonomies to exclude from the Conditions: Taxonomies dropdowns for each individual status.
wp_to_buffer_pro_get_taxonomiesDefines available taxonomies for the given Post Type, which are used in the Conditions: Taxonomies dropdowns for each individual status.
wp_to_buffer_pro_get_all_taxonomiesDefines available taxonomies, regardless of Post Type, which are used in the Conditions: Taxonomies dropdowns for each individual status.
wp_to_buffer_pro_get_user_rolesDefines WordPress User Roles.
wp_to_buffer_pro_get_excluded_user_rolesDefines WordPress User Roles to exclude from Settings screens.
wp_to_buffer_pro_get_repost_frequency_unitsDefines available Reposting frequency units when defining Repost status(es).
wp_to_buffer_pro_get_tagsDefines 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_buffer_pro_get_post_actionsDefines the Post actions which trigger status(es) to be sent to social media.
wp_to_buffer_pro_get_post_actions_past_tenseDefines the Post actions which trigger status(es) to be sent to social media, with labels set to the past tense.
wp_to_buffer_pro_get_condition_optionsDefines the available Options for Taxonomy Terms Conditionals.
wp_to_buffer_pro_get_override_optionsDefines the available override options to display in the meta box for individual Posts.
wp_to_buffer_pro_get_authorsDefines the available override options to display in the meta box for individual Posts.
wp_to_buffer_pro_get_meta_compareBackward compatible filter; defines the available Post comparison operators, used for Conditional Options on status(es).
wp_to_buffer_pro_get_comparison_operatorsDefines the available Post comparison operators, used for Conditional Options on status(es).
wp_to_buffer_pro_get_custom_field_comparison_operatorsDefines the available Custom Field comparison operators, used for Conditional Options on status(es).
wp_to_buffer_pro_get_order_byDefines the available WP_Query compatible order by options.
wp_to_buffer_pro_get_orderDefines the available WP_Query compatible order options.
wp_to_buffer_pro_get_tags_excluded_from_character_limitDefines 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_buffer_pro_get_fontsDefines the available TTF fonts for use with Text to Image
wp_to_buffer_pro_get_transient_expiration_timeDefines the number of seconds before expiring transients.
wp_to_buffer_pro_maybe_remove_profiles_by_roleDefines the number of seconds before expiring transients.
wp_to_buffer_pro_maybe_remove_post_types_by_roleDefines the number of seconds before expiring transients.
wp_to_buffer_pro_get_log_filtersDefines the registered filters that can be used on the Log WP_List_Tables.
/lib/social/includes/class-settings.php
wp_to_buffer_pro_get_settingsFilters Post Type Settings before they are returned.
wp_to_buffer_pro_update_settingsFilters Post Type Settings before they are saved.
wp_to_buffer_pro_default_installation_settingsFilters Default Post Type Settings used on Plugin Activation before they are returned.
wp_to_buffer_pro_settings_get_status_row_scheduleOutput Schedule settings for Integrations / Third Party Plugins
wp_to_buffer_pro_settings_get_default_statusReturns a skeleton status object for the given action, used when defining new status(es)
wp_to_buffer_pro_update_optionFilters the key and value pair before saving to the options table.
wp_to_buffer_pro_get_allFilters the keys that are used to store Plugin data in the options table.
/lib/social/includes/class-log.php
wp_to_buffer_pro_get_logFilters the log entries before output.
wp_to_buffer_pro_log_get_result_optionsDefines the available result options
wp_to_buffer_pro_log_get_log_levelsDefines the available log levels
/lib/social/includes/class-api.php
wp_to_buffer_pro_api_request_timeoutDefines the number of seconds before timing out a request to the remote API.
/lib/social/includes/class-validation.php
wp_to_buffer_pro_validate_check_for_duplicates_status_keysDefines 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/social/includes/class-repost.php
wp_to_buffer_pro_repost_get_post_idsFilters WP_Query arguments for fetching Post IDs for a given Post Type, that are then checked to see if reposting is required.
/lib/social/includes/class-bulk-actions.php
wp_to_buffer_pro_bulk_actions_register_bulk_actionsDefines Bulk Actions to be added to the select dropdown on WP_List_Tables.
/lib/social/includes/class-image.php
wp_to_buffer_pro_get_status_video_optionsDefines the available video source options for a status.
wp_to_buffer_pro_get_status_image_optionsDefines the available Featured Image select dropdown options on a status, depending on the Plugin and Social Network the status message is for.
wp_to_buffer_pro_get_status_additional_image_optionsDefines the available Additional Images select dropdown options on a status.
wp_to_buffer_pro_get_social_media_image_sizeDefines the image size limit for the given social media service.
wp_to_buffer_pro_image_get_images_sources_convertDefines the image ID to use as the image or additional image for the status message. If an image’s mime type is not supported by the social media scheduling service, this filter can be used to convert the image to a supported type, store it in the Media Library and return the converted image ID. This is already performed for webp images.
wp_to_buffer_pro_get_social_media_image_sizesDefines the optimal image sizes for each social network.
/lib/social/includes/class-post.php
wp_to_buffer_pro_get_post_metaFilters Status Settings for a specific Post.
/lib/social/includes/integrations/class-yoast-seo.php
wp_to_buffer_pro_publish_register_yoast_seo_searches_replacementsRegisters any additional status message tags, and their Post data replacements, that are supported for Yoast SEO.
/lib/social/includes/integrations/class-seopress.php
wp_to_buffer_pro_publish_register_seopress_searches_replacementsRegisters any additional status message tags, and their Post data replacements, that are supported for SEOPress.
/lib/social/includes/integrations/class-rank-math.php
wp_to_buffer_pro_publish_register_rank_math_searches_replacementsRegisters any additional status message tags, and their Post data replacements, that are supported for Rank Math SEO.
/lib/social/includes/integrations/class-the-events-calendar.php
wp_to_buffer_pro_publish_register_the_events_calendar_searches_replacementsRegisters any additional status message tags, and their Post data replacements, that are supported for The Events Calendar
/lib/social/includes/integrations/class-aioseo.php
wp_to_buffer_pro_publish_register_aio_seo_searches_replacementsRegisters any additional status message tags, and their Post data replacements, that are supported for AIOSEO.
/lib/social/includes/integrations/class-modern-events-calendar.php
wp_to_buffer_pro_publish_register_modern_events_calendar_searches_replacementsRegisters any additional status message tags, and their Post data replacements, that are supported for Modern Events Calendar
/lib/social/includes/integrations/class-woocommerce.php
wp_to_buffer_pro_publish_register_woocommerce_searches_replacementsRegisters any additional status message tags, and their Post data replacements, that are supported for WooCommerce.
/lib/social/includes/integrations/class-featured-image-caption.php
wp_to_buffer_pro_publish_register_featured_image_caption_searches_replacementsRegisters any additional status message tags, and their Post data replacements, that are supported for the Featured Image Caption Plugin.
/lib/social/includes/integrations/class-events-manager.php
wp_to_buffer_pro_publish_register_events_manager_searches_replacementsRegisters any additional status message tags, and their Post data replacements, that are supported for Events Manager
/lib/social/includes/class-publish.php
wp_to_buffer_pro_publish_schedule_publish_delayDefine the number of seconds before the scheduled event should run, relative to the current time.
wp_to_buffer_pro_publish_status_conditions_metProcess condition settings for Integrations / Third Party Plugins
wp_to_buffer_pro_publish_statusesDetermine the statuses to send, just before they’re sent. Statuses can be added, edited and/or deleted as necessary here.
wp_to_buffer_pro_publish_condition_passedDetermine if a statuses meta conditionals have been met, where the conditional is not a plugin standard option.
wp_to_buffer_pro_publish_build_args_imageAllows third party integrations to define the image to use for the status.
wp_to_buffer_pro_publish_builds_args_schedule_ statusscheduleAllows integrations to define when the status should be scheduled for publication
wp_to_buffer_pro_publish_build_argsDetermine the standardised arguments array to send via the API for a status message’s settings.
wp_to_buffer_pro_publish_get_additional_imagesAllows third party integrations to define the additional images to use for the status.
wp_to_buffer_pro_publish_parse_text_term_nameDefines the Taxonomy Term Name to replace the status template tag.
wp_to_buffer_pro_publish_parse_text_term_hashtag_retain_caseDefines the Taxonomy Term Hashtag to replace the status template tag.
wp_to_buffer_pro_publish_parse_text_term_hashtag_underscoreDefines the Taxonomy Term Hashtag to replace the status template tag.
wp_to_buffer_pro_publish_parse_text_term_hashtagDefines the Taxonomy Term Hashtag to replace the status template tag.
wp_to_buffer_pro_termBackward 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_buffer_pro_publish_parse_textFilters the parsed status message text on a status.
wp_to_buffer_pro_publish_parse_google_business_start_date_ statusgooglebusinessstart_date_optionAllows integrations to define the status’ start date for a Google Business Profile Offer or Event.
wp_to_buffer_pro_publish_parse_google_business_end_date_ statusgooglebusinessend_date_optionAllows integrations to define the status’ end date for a Google Business Profile Offer or Event.
wp_to_buffer_pro_publish_apply_text_transformationApplies the given transformation to the given value
wp_to_buffer_pro_process_profile_mentionsParses profile mentions, adding annotations arguments to the $args array and updating the text that’s sent to the API
wp_to_buffer_pro_publish_get_all_possible_searches_replacementsRegisters any additional status message tags, and their Post data replacements, that are supported.
wp_to_buffer_pro_publish_register_post_searches_replacementsRegisters any additional status message tags, and their Post data replacements, that are supported for the given Post.
wp_to_buffer_pro_publish_register_author_searches_replacementsRegisters any additional status message tags, and their Author data replacements, that are supported for the given Post Author.
wp_to_buffer_pro_publish_get_titleFilters the dynamic {title} replacement, when a Post’s status is being built.
wp_to_buffer_pro_publish_get_excerptFilters the dynamic {excerpt} replacement, when a Post’s status is being built.
wp_to_buffer_pro_publish_get_contentFilters the dynamic {content} replacement, when a Post’s status is being built.
wp_to_buffer_pro_publish_get_dateReturns 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_buffer_pro_publish_get_permalinkFilters the Post’s Permalink, including or excluding a trailing slash, depending on the Plugin settings
wp_to_buffer_pro_publish_get_short_permalinkFilters the Post’s Permalink, including or excluding a trailing slash, depending on the Plugin settings
wp_to_buffer_pro_publish_apply_word_limitApplies the given word limit to the given text.
wp_to_buffer_pro_publish_apply_sentence_limitApplies the given sentence limit to the given text.
wp_to_buffer_pro_publish_apply_character_limitFilters the character limited text.
/lib/social/includes/class-bulk-publish.php
wp_to_buffer_pro_bulk_publish_get_post_idsFilters WP_Query arguments for fetching Post IDs for a given Post Type, that are then checked to see if reposting is required.
/lib/social/includes/class-cron.php
wp_to_buffer_pro_migrate_status_settings_batch_sizeFilters the batch size for the status settings migration CRON event.
/lib/social/includes/class-notices.php
wp_to_buffer_pro_notices_get_success_noticesFilters the success notices to return.
wp_to_buffer_pro_notices_get_warning_noticesFilters the error notices to return.
wp_to_buffer_pro_notices_get_error_noticesFilters the error notices to return.
wp_to_buffer_pro_notices_get_noticesFilters the success and error notices to return.
wp_to_buffer_pro_notices_saveFilters the success and error notices to save.
/lib/social/includes/class-admin.php
wp_to_buffer_pro_admin_get_autocomplete_configurationDefines configuration for tribute.js autocomplete instances for Tags, Facebook Pages and Twitter Username mentions.
wp_to_buffer_pro_admin_admin_menu_minimum_capabilityDefines the minimum capability required to access the Plugin’s Menu and Sub Menus
/lib/social/includes/class-media-library.php
wp_to_buffer_pro_media_cleanup_retention_daysThe number of days to retain Plugin generated images in the Media Library.
/lib/social/includes/class-date.php
wp_to_buffer_pro_common_convert_wordpress_gmt_offset_to_offset_valueConverts WordPress’ GMT Offset (e.g. -5, +3.3) to an offset value compatible with WordPress’ DateTime object (e.g. -0500, +0330)
/includes/class-buffer-api.php
wp_to_buffer_pro_pro_api_get_timeoutDefines the maximum time to allow the API request to run.
wp_to_buffer_pro_get_days
/lib/social/includes/class-common.php::69
Overview
Defines the available days.
Parameters
Parameter
Type
Description
$days
array
Days.
Usage
add_filter( 'wp_to_buffer_pro_get_days', function( $days ) {
// ... your code here
// Return value
return $days;
}, 10, 1 );
wp_to_buffer_pro_get_status_post_type_options
/lib/social/includes/class-common.php::102
Overview
Defines the available status post type options.
Parameters
Parameter
Type
Description
$status_post_type_options
array
Status Post Type Options.
Usage
add_filter( 'wp_to_buffer_pro_get_status_post_type_options', function( $status_post_type_options ) {
// ... your code here
// Return value
return $status_post_type_options;
}, 10, 1 );
wp_to_buffer_pro_get_schedule_options
/lib/social/includes/class-common.php::135
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_buffer_pro_get_schedule_options', function( $schedule, $post_type, $is_post_screen ) {
// ... your code here
// Return value
return $schedule;
}, 10, 3 );
wp_to_buffer_pro_get_schedule_relative_days
/lib/social/includes/class-common.php::171
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_buffer_pro_get_schedule_relative_days', function( $days ) {
// ... your code here
// Return value
return $days;
}, 10, 1 );
wp_to_buffer_pro_get_schedule_custom_relation_options
/lib/social/includes/class-common.php::200
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_buffer_pro_get_schedule_custom_relation_options', function( $schedule ) {
// ... your code here
// Return value
return $schedule;
}, 10, 1 );
wp_to_buffer_pro_get_google_business_start_date_options
/lib/social/includes/class-common.php::230
Overview
Defines the available start date options for a Google Business Profile status.
Parameters
Parameter
Type
Description
$schedule
array
Schedule Options.
Post
bool|string $post_type
Type
Usage
add_filter( 'wp_to_buffer_pro_get_google_business_start_date_options', function( $schedule, $post_type ) {
// ... your code here
// Return value
return $schedule;
}, 10, 2 );
wp_to_buffer_pro_get_google_business_end_date_options
/lib/social/includes/class-common.php::260
Overview
Defines the available start date options for a Google Business Profile status.
Parameters
Parameter
Type
Description
$schedule
array
Schedule Options.
Post
bool|string $post_type
Type
Usage
add_filter( 'wp_to_buffer_pro_get_google_business_end_date_options', function( $schedule, $post_type ) {
// ... your code here
// Return value
return $schedule;
}, 10, 2 );
wp_to_buffer_pro_get_post_types
/lib/social/includes/class-common.php::297
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_buffer_pro_get_post_types', function( $types ) {
// ... your code here
// Return value
return $types;
}, 10, 1 );
wp_to_buffer_pro_get_excluded_post_types
/lib/social/includes/class-common.php::328
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_buffer_pro_get_excluded_post_types', function( $types ) {
// ... your code here
// Return value
return $types;
}, 10, 1 );
wp_to_buffer_pro_get_excluded_taxonomies
/lib/social/includes/class-common.php::357
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_buffer_pro_get_excluded_taxonomies', function( $taxonomies ) {
// ... your code here
// Return value
return $taxonomies;
}, 10, 1 );
wp_to_buffer_pro_get_taxonomies
/lib/social/includes/class-common.php::396
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_buffer_pro_get_taxonomies', function( $taxonomies, $post_type ) {
// ... your code here
// Return value
return $taxonomies;
}, 10, 2 );
wp_to_buffer_pro_get_all_taxonomies
/lib/social/includes/class-common.php::433
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_buffer_pro_get_all_taxonomies', function( $taxonomies ) {
// ... your code here
// Return value
return $taxonomies;
}, 10, 1 );
wp_to_buffer_pro_get_user_roles
/lib/social/includes/class-common.php::467
Overview
Defines WordPress User Roles.
Parameters
Parameter
Type
Description
$roles
array
WordPress User Roles.
Usage
add_filter( 'wp_to_buffer_pro_get_user_roles', function( $roles ) {
// ... your code here
// Return value
return $roles;
}, 10, 1 );
wp_to_buffer_pro_get_excluded_user_roles
/lib/social/includes/class-common.php::495
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_buffer_pro_get_excluded_user_roles', function( $excluded_roles ) {
// ... your code here
// Return value
return $excluded_roles;
}, 10, 1 );
wp_to_buffer_pro_get_repost_frequency_units
/lib/social/includes/class-common.php::525
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_buffer_pro_get_repost_frequency_units', function( $units ) {
// ... your code here
// Return value
return $units;
}, 10, 1 );
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_buffer_pro_get_tags', function( $tags, $post_type ) {
// ... your code here
// Return value
return $tags;
}, 10, 2 );
wp_to_buffer_pro_get_post_actions
/lib/social/includes/class-common.php::725
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_buffer_pro_get_post_actions', function( $actions ) {
// ... your code here
// Return value
return $actions;
}, 10, 1 );
wp_to_buffer_pro_get_post_actions_past_tense
/lib/social/includes/class-common.php::757
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_buffer_pro_get_post_actions_past_tense', function( $actions ) {
// ... your code here
// Return value
return $actions;
}, 10, 1 );
wp_to_buffer_pro_get_condition_options
/lib/social/includes/class-common.php::788
Overview
Defines the available Options for Taxonomy Terms Conditionals.
Parameters
Parameter
Type
Description
$options
array
Condition Options.
Usage
add_filter( 'wp_to_buffer_pro_get_condition_options', function( $options ) {
// ... your code here
// Return value
return $options;
}, 10, 1 );
wp_to_buffer_pro_get_override_options
/lib/social/includes/class-common.php::818
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_buffer_pro_get_override_options', function( $options ) {
// ... your code here
// Return value
return $options;
}, 10, 1 );
wp_to_buffer_pro_get_authors
/lib/social/includes/class-common.php::855
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_buffer_pro_get_authors', function( $authors ) {
// ... your code here
// Return value
return $authors;
}, 10, 1 );
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_buffer_pro_get_meta_compare', function( $comparison_operators ) {
// ... your code here
// Return value
return $comparison_operators;
}, 10, 1 );
wp_to_buffer_pro_get_comparison_operators
/lib/social/includes/class-common.php::903
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_buffer_pro_get_comparison_operators', function( $comparison_operators ) {
// ... your code here
// Return value
return $comparison_operators;
}, 10, 1 );
wp_to_buffer_pro_get_custom_field_comparison_operators
/lib/social/includes/class-common.php::943
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_buffer_pro_get_custom_field_comparison_operators', function( $comparison_operators ) {
// ... your code here
// Return value
return $comparison_operators;
}, 10, 1 );
wp_to_buffer_pro_get_order_by
/lib/social/includes/class-common.php::978
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_buffer_pro_get_order_by', function( $order_by ) {
// ... your code here
// Return value
return $order_by;
}, 10, 1 );
wp_to_buffer_pro_get_order
/lib/social/includes/class-common.php::1007
Overview
Defines the available WP_Query compatible order options.
Parameters
Parameter
Type
Description
$order
array
Order options.
Usage
add_filter( 'wp_to_buffer_pro_get_order', function( $order ) {
// ... your code here
// Return value
return $order;
}, 10, 1 );
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_buffer_pro_get_tags_excluded_from_character_limit', function( $tags ) {
// ... your code here
// Return value
return $tags;
}, 10, 1 );
wp_to_buffer_pro_get_fonts
/lib/social/includes/class-common.php::1076
Overview
Defines the available TTF fonts for use with Text to Image
Parameters
Parameter
Type
Description
$fonts
array
Fonts.
Usage
add_filter( 'wp_to_buffer_pro_get_fonts', function( $fonts ) {
// ... your code here
// Return value
return $fonts;
}, 10, 1 );
wp_to_buffer_pro_get_transient_expiration_time
/lib/social/includes/class-common.php::1102
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_buffer_pro_get_transient_expiration_time', function( $expiration_time ) {
// ... your code here
// Return value
return $expiration_time;
}, 10, 1 );
wp_to_buffer_pro_maybe_remove_profiles_by_role
/lib/social/includes/class-common.php::1155
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_buffer_pro_maybe_remove_profiles_by_role', function( $arr, $role ) {
// ... your code here
// Return value
return $arr;
}, 10, 2 );
wp_to_buffer_pro_maybe_remove_post_types_by_role
/lib/social/includes/class-common.php::1200
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_buffer_pro_maybe_remove_post_types_by_role', function( $post_types, $role ) {
// ... your code here
// Return value
return $post_types;
}, 10, 2 );
wp_to_buffer_pro_get_log_filters
/lib/social/includes/class-common.php::1234
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_buffer_pro_get_log_filters', function( $filters ) {
// ... your code here
// Return value
return $filters;
}, 10, 1 );
wp_to_buffer_pro_get_settings
/lib/social/includes/class-settings.php::113
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_buffer_pro_get_settings', function( $settings, $type ) {
// ... your code here
// Return value
return $settings;
}, 10, 2 );
wp_to_buffer_pro_update_settings
/lib/social/includes/class-settings.php::146
Overview
Filters Post Type Settings before they are saved.
Parameters
Parameter
Type
Description
$settings
array
Settings.
$type
string
Post Type.
$existing_settings
array
Existing Settings.
Usage
add_filter( 'wp_to_buffer_pro_update_settings', function( $settings, $type, $existing_settings ) {
// ... your code here
// Return value
return $settings;
}, 10, 3 );
wp_to_buffer_pro_default_installation_settings
/lib/social/includes/class-settings.php::275
Overview
Filters Default Post Type Settings used on Plugin Activation before they are returned.
Parameters
Parameter
Type
Description
$settings
array
Settings.
Usage
add_filter( 'wp_to_buffer_pro_default_installation_settings', function( $settings ) {
// ... your code here
// Return value
return $settings;
}, 10, 1 );
wp_to_buffer_pro_settings_get_status_row_schedule
/lib/social/includes/class-settings.php::472
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_buffer_pro_settings_get_status_row_schedule', function( $output, $status, $action, $post_type, $schedule ) {
// ... your code here
// Return value
return $output;
}, 10, 5 );
wp_to_buffer_pro_settings_get_default_status
/lib/social/includes/class-settings.php::592
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_buffer_pro_settings_get_default_status', function( $status ) {
// ... your code here
// Return value
return $status;
}, 10, 1 );
wp_to_buffer_pro_update_option
/lib/social/includes/class-settings.php::1035
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_buffer_pro_update_option', function( $value, $key ) {
// ... your code here
// Return value
return $value;
}, 10, 2 );
wp_to_buffer_pro_get_all
/lib/social/includes/class-settings.php::1092
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_buffer_pro_get_all', function( $keys, $post_types ) {
// ... your code here
// Return value
return $keys;
}, 10, 2 );
wp_to_buffer_pro_get_log
/lib/social/includes/class-log.php::502
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_buffer_pro_get_log', function( $log, $post_id ) {
// ... your code here
// Return value
return $log;
}, 10, 2 );
wp_to_buffer_pro_log_get_result_options
/lib/social/includes/class-log.php::569
Overview
Defines the available result options
Parameters
Parameter
Type
Description
$result_options
array
Result Options.
Usage
add_filter( 'wp_to_buffer_pro_log_get_result_options', function( $result_options ) {
// ... your code here
// Return value
return $result_options;
}, 10, 1 );
wp_to_buffer_pro_log_get_log_levels
/lib/social/includes/class-log.php::601
Overview
Defines the available log levels
Parameters
Parameter
Type
Description
$log_levels
array
Log Levels.
Usage
add_filter( 'wp_to_buffer_pro_log_get_log_levels', function( $log_levels ) {
// ... your code here
// Return value
return $log_levels;
}, 10, 1 );
wp_to_buffer_pro_api_request_timeout
/lib/social/includes/class-api.php::110
Overview
Defines the number of seconds before timing out a request to the remote API.
Parameters
Parameter
Type
Description
$timeout
int
Timeout, in seconds.
Usage
add_filter( 'wp_to_buffer_pro_api_request_timeout', function( $timeout ) {
// ... your code here
// Return value
return $timeout;
}, 10, 1 );
wp_to_buffer_pro_validate_check_for_duplicates_status_keys
/lib/social/includes/class-validation.php::132
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_buffer_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_buffer_pro_repost_get_post_ids
/lib/social/includes/class-repost.php::336
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_buffer_pro_repost_get_post_ids', function( $args, $post_type ) {
// ... your code here
// Return value
return $args;
}, 10, 2 );
wp_to_buffer_pro_bulk_actions_register_bulk_actions
/lib/social/includes/class-bulk-actions.php::92
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
array
Existing Registered Bulk Actions (excluding Plugin Specific Bulk Actions).
Usage
add_filter( 'wp_to_buffer_pro_bulk_actions_register_bulk_actions', function( $bulk_actions, $actions ) {
// ... your code here
// Return value
return $bulk_actions;
}, 10, 2 );
wp_to_buffer_pro_get_status_video_options
/lib/social/includes/class-image.php::75
Overview
Defines the available video source options for a status.
Parameters
Parameter
Type
Description
$options
array
Video source options.
Usage
add_filter( 'wp_to_buffer_pro_get_status_video_options', function( $options ) {
// ... your code here
// Return value
return $options;
}, 10, 1 );
wp_to_buffer_pro_get_status_image_options
/lib/social/includes/class-image.php::127
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.
Social
bool|string $network
Network.
$post_type
string
Post Type.
Usage
add_filter( 'wp_to_buffer_pro_get_status_image_options', function( $options, $network, $post_type ) {
// ... your code here
// Return value
return $options;
}, 10, 3 );
wp_to_buffer_pro_get_status_additional_image_options
/lib/social/includes/class-image.php::211
Overview
Defines the available Additional Images select dropdown options on a status.
Parameters
Parameter
Type
Description
$options
array
Featured Image Dropdown Options.
Social
bool|string $network
Network.
$post_type
string
Post Type.
Usage
add_filter( 'wp_to_buffer_pro_get_status_additional_image_options', function( $options, $network, $post_type ) {
// ... your code here
// Return value
return $options;
}, 10, 3 );
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.
Status
bool|string $status_post_type
Post
Usage
add_filter( 'wp_to_buffer_pro_get_social_media_image_size', function( $image_size, $service, $status_post_type ) {
// ... your code here
// Return value
return $image_size;
}, 10, 3 );
wp_to_buffer_pro_image_get_images_sources_convert
/lib/social/includes/class-image.php::361
Overview
Defines the image ID to use as the image or additional image for the status message. If an image’s mime type is not supported by the social media scheduling service, this filter can be used to convert the image to a supported type, store it in the Media Library and return the converted image ID. This is already performed for webp images.
Parameters
Parameter
Type
Description
$image_id
int
Image ID.
$source
string
Source Image ID was derived from (plugin, featured_image, post_content, text_to_image).
$service
string
Social Media Service the image is for. If not defined, just return the large version.
$image_mime_type
string
Image MIME Type.
Usage
add_filter( 'wp_to_buffer_pro_image_get_images_sources_convert', function( $image_id, $source, $service, $image_mime_type ) {
// ... your code here
// Return value
return $image_id;
}, 10, 4 );
Overview
Defines the optimal image sizes for each social network.
Parameters
Parameter
Type
Description
$image_sizes
array
Image Sizes
Usage
add_filter( 'wp_to_buffer_pro_get_social_media_image_sizes', function( $image_sizes ) {
// ... your code here
// Return value
return $image_sizes;
}, 10, 1 );
wp_to_buffer_pro_get_post_meta
/lib/social/includes/class-post.php::496
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_buffer_pro_get_post_meta', function( $settings, $post_id ) {
// ... your code here
// Return value
return $settings;
}, 10, 2 );
wp_to_buffer_pro_publish_register_yoast_seo_searches_replacements
/lib/social/includes/integrations/class-yoast-seo.php::165
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_buffer_pro_publish_register_yoast_seo_searches_replacements', function( $searches_replacements, $post, $author ) {
// ... your code here
// Return value
return $searches_replacements;
}, 10, 3 );
wp_to_buffer_pro_publish_register_seopress_searches_replacements
/lib/social/includes/integrations/class-seopress.php::126
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_buffer_pro_publish_register_seopress_searches_replacements', function( $searches_replacements, $post, $author ) {
// ... your code here
// Return value
return $searches_replacements;
}, 10, 3 );
wp_to_buffer_pro_publish_register_rank_math_searches_replacements
/lib/social/includes/integrations/class-rank-math.php::126
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_buffer_pro_publish_register_rank_math_searches_replacements', function( $searches_replacements, $post, $author ) {
// ... your code here
// Return value
return $searches_replacements;
}, 10, 3 );
wp_to_buffer_pro_publish_register_the_events_calendar_searches_replacements
/lib/social/includes/integrations/class-the-events-calendar.php::335
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_buffer_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_buffer_pro_publish_register_aio_seo_searches_replacements
/lib/social/includes/integrations/class-aioseo.php::126
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_buffer_pro_publish_register_aio_seo_searches_replacements', function( $searches_replacements, $post, $author ) {
// ... your code here
// Return value
return $searches_replacements;
}, 10, 3 );
wp_to_buffer_pro_publish_register_modern_events_calendar_searches_replacements
/lib/social/includes/integrations/class-modern-events-calendar.php::351
Overview
Registers any additional status message tags, and their Post data replacements, that are supported for Modern 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_buffer_pro_publish_register_modern_events_calendar_searches_replacements', function( $searches_replacements, $post, $author ) {
// ... your code here
// Return value
return $searches_replacements;
}, 10, 3 );
wp_to_buffer_pro_publish_register_woocommerce_searches_replacements
/lib/social/includes/integrations/class-woocommerce.php::158
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_buffer_pro_publish_register_woocommerce_searches_replacements', function( $searches_replacements, $post, $author ) {
// ... your code here
// Return value
return $searches_replacements;
}, 10, 3 );
wp_to_buffer_pro_publish_register_featured_image_caption_searches_replacements
/lib/social/includes/integrations/class-featured-image-caption.php::131
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_buffer_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_buffer_pro_publish_register_events_manager_searches_replacements
/lib/social/includes/integrations/class-events-manager.php::356
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_buffer_pro_publish_register_events_manager_searches_replacements', function( $searches_replacements, $post, $author ) {
// ... your code here
// Return value
return $searches_replacements;
}, 10, 3 );
wp_to_buffer_pro_publish_schedule_publish_delay
/lib/social/includes/class-publish.php::551
Overview
Define the number of seconds before the scheduled event should run, relative to the current time.
Parameters
Parameter
Type
Description
$delay
int
Delay (in seconds).
$post_id
int
Post ID.
$action
string
Action (publish|update).
Usage
add_filter( 'wp_to_buffer_pro_publish_schedule_publish_delay', function( $delay, $post_id, $action ) {
// ... your code here
// Return value
return $delay;
}, 10, 3 );
wp_to_buffer_pro_publish_status_conditions_met
/lib/social/includes/class-publish.php::842
Overview
Process condition settings for Integrations / Third Party Plugins
Parameters
Parameter
Type
Description
$conditions_met
bool
Conditions
$status
array
Status
$post
\WP_Post
WordPress Post
$profile_id
string
Social Media Profile ID.
$service
string
Social Media Service.
$action
string
Action (publish|update|repost|bulk_publish).
Usage
add_filter( 'wp_to_buffer_pro_publish_status_conditions_met', function( $conditions_met, $status, $post, $profile_id, $service, $action ) {
// ... your code here
// Return value
return $conditions_met;
}, 10, 6 );
wp_to_buffer_pro_publish_statuses
/lib/social/includes/class-publish.php::954
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_buffer_pro_publish_statuses', function( $statuses, $post_id, $action ) {
// ... your code here
// Return value
return $statuses;
}, 10, 3 );
wp_to_buffer_pro_publish_condition_passed
/lib/social/includes/class-publish.php::1617
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_buffer_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_buffer_pro_publish_build_args_image
/lib/social/includes/class-publish.php::1880
Overview
Allows third party integrations to define the image to use for the status.
Parameters
Parameter
Type
Description
$image
false
Image.
$image_setting
int
Image Setting.
$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).
Status
bool|string $format
format
Usage
add_filter( 'wp_to_buffer_pro_publish_build_args_image', function( $image, $status['image'], $post, $profile_id, $service, $status, $action, $status['post_type'] ) {
// ... your code here
// Return value
return $image;
}, 10, 8 );
wp_to_buffer_pro_publish_builds_args_schedule_ statusschedule
/lib/social/includes/class-publish.php::2051
Overview
Allows integrations to define when the status should be scheduled for publication
Parameters
Parameter
Type
Description
Schedule
bool|string $scheduled_at
Status
$status
array
Status.
WordPress
\WP_Post $post
Post.
Usage
add_filter( 'wp_to_buffer_pro_publish_builds_args_schedule_ statusschedule', function( $scheduled_at, $status, $post ) {
// ... your code here
// Return value
return $scheduled_at;
}, 10, 3 );
wp_to_buffer_pro_publish_build_args
/lib/social/includes/class-publish.php::2094
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_buffer_pro_publish_build_args', function( $args, $post, $profile_id, $service, $status, $action ) {
// ... your code here
// Return value
return $args;
}, 10, 6 );
wp_to_buffer_pro_publish_get_additional_images
/lib/social/includes/class-publish.php::2249
Overview
Allows third party integrations to define the additional images to use for the status.
Parameters
Parameter
Type
Description
$images
bool|array
Images.
$additional_images_source
int
Additional Images Source.
$post
\WP_Post
Post.
$service
string
Service.
$status
array
Status Settings.
Status
bool|string $format
format
Usage
add_filter( 'wp_to_buffer_pro_publish_get_additional_images', function( $images, $status['image_additional'], $post, $service, $status, $format ) {
// ... your code here
// Return value
return $images;
}, 10, 6 );
wp_to_buffer_pro_publish_parse_text_term_name
/lib/social/includes/class-publish.php::2730
Overview
Defines the Taxonomy Term Name to replace the status template tag.
Parameters
Parameter
Type
Description
$term_name
string
Term Name.
$taxonomy_term_format
string
Term
$term
WP_Term
Term.
$taxonomy
string
Taxonomy.
$text
string
Status Text.
Usage
add_filter( 'wp_to_buffer_pro_publish_parse_text_term_name', function( $term_name, $taxonomy_term_format, $term, $taxonomy, $text ) {
// ... your code here
// Return value
return $term_name;
}, 10, 5 );
wp_to_buffer_pro_publish_parse_text_term_hashtag_retain_case
/lib/social/includes/class-publish.php::2756
Overview
Defines the Taxonomy Term Hashtag to replace the status template tag.
Parameters
Parameter
Type
Description
$term_name
string
Term Name.
$taxonomy_term_format
string
Term
$term
WP_Term
Term.
$taxonomy
string
Taxonomy.
$text
string
Status Text.
Usage
add_filter( 'wp_to_buffer_pro_publish_parse_text_term_hashtag_retain_case', function( $term_name, $taxonomy_term_format, $term, $taxonomy, $text ) {
// ... your code here
// Return value
return $term_name;
}, 10, 5 );
wp_to_buffer_pro_publish_parse_text_term_hashtag_underscore
/lib/social/includes/class-publish.php::2782
Overview
Defines the Taxonomy Term Hashtag to replace the status template tag.
Parameters
Parameter
Type
Description
$term_name
string
Term Name.
$taxonomy_term_format
string
Term
$term
WP_Term
Term.
$taxonomy
string
Taxonomy.
$text
string
Status Text.
Usage
add_filter( 'wp_to_buffer_pro_publish_parse_text_term_hashtag_underscore', function( $term_name, $taxonomy_term_format, $term, $taxonomy, $text ) {
// ... your code here
// Return value
return $term_name;
}, 10, 5 );
wp_to_buffer_pro_publish_parse_text_term_hashtag
/lib/social/includes/class-publish.php::2809
Overview
Defines the Taxonomy Term Hashtag to replace the status template tag.
Parameters
Parameter
Type
Description
$term_name
string
Term Name.
$taxonomy_term_format
string
Term
$term
WP_Term
Term.
$taxonomy
string
Taxonomy.
$text
string
Status Text.
Usage
add_filter( 'wp_to_buffer_pro_publish_parse_text_term_hashtag', function( $term_name, $taxonomy_term_format, $term, $taxonomy, $text ) {
// ... your code here
// Return value
return $term_name;
}, 10, 5 );
wp_to_buffer_pro_term
/lib/social/includes/class-publish.php::2825
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.
$taxonomy
string
Taxonomy.
$text
string
Status Text.
$taxonomy_term_format
string
Term Format.
Usage
add_filter( 'wp_to_buffer_pro_term', function( $term_name, $term->name, $taxonomy, $text, $taxonomy_term_format ) {
// ... your code here
// Return value
return $term_name;
}, 10, 5 );
wp_to_buffer_pro_publish_parse_text
/lib/social/includes/class-publish.php::2876
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_buffer_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_buffer_pro_publish_parse_google_business_start_date_ statusgooglebusinessstart_date_option
/lib/social/includes/class-publish.php::2978
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_buffer_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_buffer_pro_publish_parse_google_business_end_date_ statusgooglebusinessend_date_option
/lib/social/includes/class-publish.php::3038
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_buffer_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_buffer_pro_publish_apply_text_transformation
/lib/social/includes/class-publish.php::3299
Overview
Applies the given transformation to the given value
Parameters
Parameter
Type
Description
$value
string
Value.
$transformation
string
Transformation.
Usage
add_filter( 'wp_to_buffer_pro_publish_apply_text_transformation', function( $value, $transformation ) {
// ... your code here
// Return value
return $value;
}, 10, 2 );
wp_to_buffer_pro_process_profile_mentions
/lib/social/includes/class-publish.php::3407
Overview
Parses profile mentions, adding annotations 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_buffer_pro_process_profile_mentions', function( $args, $post, $profile_id, $service, $status, $action ) {
// ... your code here
// Return value
return $args;
}, 10, 6 );
wp_to_buffer_pro_publish_get_all_possible_searches_replacements
/lib/social/includes/class-publish.php::3480
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_buffer_pro_publish_get_all_possible_searches_replacements', function( $searches_replacements, $post, $author ) {
// ... your code here
// Return value
return $searches_replacements;
}, 10, 3 );
wp_to_buffer_pro_publish_register_post_searches_replacements
/lib/social/includes/class-publish.php::3598
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_buffer_pro_publish_register_post_searches_replacements', function( $searches_replacements, $post, $taxonomies ) {
// ... your code here
// Return value
return $searches_replacements;
}, 10, 3 );
wp_to_buffer_pro_publish_register_author_searches_replacements
/lib/social/includes/class-publish.php::3565
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_buffer_pro_publish_register_author_searches_replacements', function( $searches_replacements, $author ) {
// ... your code here
// Return value
return $searches_replacements;
}, 10, 2 );
wp_to_buffer_pro_publish_get_title
/lib/social/includes/class-publish.php::3738
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_buffer_pro_publish_get_title', function( $title, $post ) {
// ... your code here
// Return value
return $title;
}, 10, 2 );
wp_to_buffer_pro_publish_get_excerpt
/lib/social/includes/class-publish.php::3783
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_buffer_pro_publish_get_excerpt', function( $excerpt, $post ) {
// ... your code here
// Return value
return $excerpt;
}, 10, 2 );
wp_to_buffer_pro_publish_get_content
/lib/social/includes/class-publish.php::3860
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_request_content
bool
Is Gutenberg Post Content.
Usage
add_filter( 'wp_to_buffer_pro_publish_get_content', function( $content, $post, $is_gutenberg_request_content ) {
// ... your code here
// Return value
return $content;
}, 10, 3 );
wp_to_buffer_pro_publish_get_date
/lib/social/includes/class-publish.php::3887
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_buffer_pro_publish_get_date', function( $date, $post ) {
// ... your code here
// Return value
return $date;
}, 10, 2 );
wp_to_buffer_pro_publish_get_permalink
/lib/social/includes/class-publish.php::3930
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_buffer_pro_publish_get_permalink', function( $url, $post, $force_trailing_forwardslash ) {
// ... your code here
// Return value
return $url;
}, 10, 3 );
wp_to_buffer_pro_publish_get_short_permalink
/lib/social/includes/class-publish.php::3958
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_buffer_pro_publish_get_short_permalink', function( $url, $post ) {
// ... your code here
// Return value
return $url;
}, 10, 2 );
wp_to_buffer_pro_publish_apply_word_limit
/lib/social/includes/class-publish.php::4110
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_buffer_pro_publish_apply_word_limit', function( $text, $word_limit, $original_text ) {
// ... your code here
// Return value
return $text;
}, 10, 3 );
wp_to_buffer_pro_publish_apply_sentence_limit
/lib/social/includes/class-publish.php::4171
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_buffer_pro_publish_apply_sentence_limit', function( $text, $sentence_limit, $original_text ) {
// ... your code here
// Return value
return $text;
}, 10, 3 );
wp_to_buffer_pro_publish_apply_character_limit
/lib/social/includes/class-publish.php::4212
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_buffer_pro_publish_apply_character_limit', function( $text, $character_limit ) {
// ... your code here
// Return value
return $text;
}, 10, 2 );
wp_to_buffer_pro_bulk_publish_get_post_ids
/lib/social/includes/class-bulk-publish.php::311
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_buffer_pro_bulk_publish_get_post_ids', function( $args, $post_type, $params ) {
// ... your code here
// Return value
return $args;
}, 10, 3 );
wp_to_buffer_pro_migrate_status_settings_batch_size
/lib/social/includes/class-cron.php::456
Overview
Filters the batch size for the status settings migration CRON event.
Parameters
Parameter
Type
Description
$batch_size
int
Number of Posts to migrate per cron tick.
Usage
add_filter( 'wp_to_buffer_pro_migrate_status_settings_batch_size', function( $batch_size ) {
// ... your code here
// Return value
return $batch_size;
}, 10, 1 );
wp_to_buffer_pro_notices_get_success_notices
/lib/social/includes/class-notices.php::136
Overview
Filters the success notices to return.
Parameters
Parameter
Type
Description
$success_notices
array
Success Notices.
$notices
array
Success and Error Notices.
Usage
add_filter( 'wp_to_buffer_pro_notices_get_success_notices', function( $success_notices, $notices ) {
// ... your code here
// Return value
return $success_notices;
}, 10, 2 );
wp_to_buffer_pro_notices_get_warning_notices
/lib/social/includes/class-notices.php::207
Overview
Filters the error notices to return.
Parameters
Parameter
Type
Description
$warning_notices
array
Warning Notices.
$notices
array
Success, Warning and Error Notices.
Usage
add_filter( 'wp_to_buffer_pro_notices_get_warning_notices', function( $warning_notices, $notices ) {
// ... your code here
// Return value
return $warning_notices;
}, 10, 2 );
wp_to_buffer_pro_notices_get_error_notices
/lib/social/includes/class-notices.php::270
Overview
Filters the error notices to return.
Parameters
Parameter
Type
Description
$error_notices
array
Error Notices.
$notices
array
Success and Error Notices.
Usage
add_filter( 'wp_to_buffer_pro_notices_get_error_notices', function( $error_notices, $notices ) {
// ... your code here
// Return value
return $error_notices;
}, 10, 2 );
wp_to_buffer_pro_notices_get_notices
/lib/social/includes/class-notices.php::332
Overview
Filters the success and error notices to return.
Parameters
Parameter
Type
Description
$notices
array
Success and Error Notices.
Usage
add_filter( 'wp_to_buffer_pro_notices_get_notices', function( $notices ) {
// ... your code here
// Return value
return $notices;
}, 10, 1 );
wp_to_buffer_pro_notices_save
/lib/social/includes/class-notices.php::367
Overview
Filters the success and error notices to save.
Parameters
Parameter
Type
Description
$notices
array
Success and Error Notices.
Usage
add_filter( 'wp_to_buffer_pro_notices_save', function( $notices ) {
// ... your code here
// Return value
return $notices;
}, 10, 1 );
wp_to_buffer_pro_admin_get_autocomplete_configuration
/lib/social/includes/class-admin.php::739
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.
Usage
add_filter( 'wp_to_buffer_pro_admin_get_autocomplete_configuration', function( $autocomplete_configuration ) {
// ... your code here
// Return value
return $autocomplete_configuration;
}, 10, 1 );
Overview
Defines the minimum capability required to access the Plugin’s Menu and Sub Menus
Parameters
Parameter
Type
Description
$capability
string
Minimum Required Capability.
Usage
add_filter( 'wp_to_buffer_pro_admin_admin_menu_minimum_capability', function( $minimum_capability ) {
// ... your code here
// Return value
return $minimum_capability;
}, 10, 1 );
Overview
The number of days to retain Plugin generated images in the Media Library.
Parameters
Parameter
Type
Description
$retention_days
int
Number of days to retain plugin-generated attachments. Default: 7.
Usage
add_filter( 'wp_to_buffer_pro_media_cleanup_retention_days', function( $retention_days ) {
// ... your code here
// Return value
return $retention_days;
}, 10, 1 );
wp_to_buffer_pro_common_convert_wordpress_gmt_offset_to_offset_value
/lib/social/includes/class-date.php::168
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_buffer_pro_common_convert_wordpress_gmt_offset_to_offset_value', function( $gmt_offset ) {
// ... your code here
// Return value
return $gmt_offset;
}, 10, 1 );
wp_to_buffer_pro_pro_api_get_timeout
/includes/class-buffer-api.php::1244
Overview
Defines the maximum time to allow the API request to run.
Parameters
Parameter
Type
Description
$timeout
int
Timeout, in seconds.
Usage
add_filter( 'wp_to_buffer_pro_pro_api_get_timeout', function( $timeout ) {
// ... your code here
// Return value
return $timeout;
}, 10, 1 );
Actions
Overview
Output Schedule settings for Integrations / Third Party Plugins
Parameters
Parameter
Type
Description
$post_type
string
Post Type
Usage
do_action( 'wp_to_buffer_pro_output_schedule_options_form_fields', function( $post_type ) {
// ... your code here
}, 10, 1 );
Overview
Output condition settings for Integrations / Third Party Plugins
Parameters
Parameter
Type
Description
$post_type
string
Post Type
Usage
do_action( 'wp_to_buffer_pro_output_condition_form_fields', function( $post_type ) {
// ... your code here
}, 10, 1 );
wp_to_buffer_pro_output_auth
/lib/social/views/settings-auth-required.php::71
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
do_action( 'wp_to_buffer_pro_output_auth', function( ) {
// ... your code here
}, 10, 0 );
wp_to_buffer_pro_notices_delete_notices
/lib/social/includes/class-notices.php::396
Parameters
Parameter
Type
Description
Usage
do_action( 'wp_to_buffer_pro_notices_delete_notices', function( ) {
// ... your code here
}, 10, 0 );
wp_to_buffer_pro_save_settings_auth
/lib/social/includes/class-admin.php::203
Parameters
Parameter
Type
Description
Usage
do_action( 'wp_to_buffer_pro_save_settings_auth', function( ) {
// ... your code here
}, 10, 0 );
Overview
Add settings menus and sub menus for the Plugin’s settings.
Parameters
Parameter
Type
Description
$minimum_capability
string
Minimum capability required.
Usage
do_action( 'wp_to_buffer_pro_admin_admin_menu', function( $minimum_capability ) {
// ... your code here
}, 10, 1 );
wp_to_buffer_pro_api_refresh_token_error
/includes/class-buffer-api.php::441
Overview
Perform any actions when refreshing an expired access token fails.
Parameters
Parameter
Type
Description
$result
\WP_Error
Error from API.
$client_id
string
OAuth Client ID.
$access_token
string
Access Token.
$refresh_token
string
Refresh
Usage
do_action( 'wp_to_buffer_pro_api_refresh_token_error', function( $result, $client_id, $access_token, $refresh_token ) {
// ... your code here
}, 10, 4 );
wp_to_buffer_pro_api_refresh_token
/includes/class-buffer-api.php::469
Overview
Perform any actions with the new access token, such as saving it.
Parameters
Parameter
Type
Description
$result
array
New Access Token, Refresh Token and Expiry timestamp.
$client_id
string
OAuth Client ID.
$previous_access_token
string
Existing Access Token.
$previous_refresh_token
string
Existing Refresh Token.
Usage
do_action( 'wp_to_buffer_pro_api_refresh_token', function( $result, $client_id, $access_token, $refresh_token ) {
// ... your code here
}, 10, 4 );
