Filters
File |
Filter Name |
Description |
/includes/admin/groups-ui.php |
|
page_generator_pro_groups_ui_remove_meta_boxes |
Filters the metaboxes to remove from the Content Groups Screen. |
|
page_generator_pro_groups_ui_get_titles_and_messages |
Filters the localization title and message strings used for Generation. |
/includes/admin/media-library.php |
|
page_generator_pro_shortcode_media_library_get_random_image_html_tag_query |
Filter the MySQL query (image type, ID) to fetch a random image ID from the Media Library. |
|
page_generator_pro_shortcode_media_library_get_random_image_html_tag_query_meta |
Filter the MySQL query meta (title, alt, caption, description) to fetch a random image ID from the Media Library. |
|
page_generator_pro_media_library_get_random_image_id |
Filter the Image ID before returning. |
|
page_generator_pro_media_library_get_random_image_html_tag |
Filter the HTML Image Tag before returning. |
/includes/admin/chimprewriter-api.php |
|
page_generator_pro_chimprewriter_api_request_timeout |
Defines the maximum number of seconds to allow an API request to run. |
/includes/admin/groups-terms-ui.php |
|
page_generator_pro_groups_terms_ui_get_titles_and_messages |
Filters the localization title and message strings used for Generation. |
/includes/admin/spinnerchief-api.php |
|
page_generator_pro_spinnerchief_api_request_timeout |
Defines the maximum number of seconds to allow an API request to run. |
/includes/admin/wordai-api.php |
|
page_generator_pro_wordai_api_request_timeout |
Defines the maximum number of seconds to allow an API request to run. |
/includes/admin/groups-terms.php |
|
page_generator_pro_groups_terms_get_defaults |
Defines the default settings structure when a new Term Group is created. |
|
page_generator_pro_groups_terms_get_all |
Filters the Groups to return. |
|
page_generator_pro_groups_terms_get_term_meta_ignored_keys |
Defines Term Meta Keys in a Content Group to ignore and not copy to generated Terms. |
|
page_generator_pro_groups_terms_get_term_meta |
Filters the Group Metadata to return. |
|
page_generator_pro_groups_terms_run_row_actions |
|
|
page_generator_pro_groups_terms_run_row_actions_success_message |
Define an optional success message based on the result of a custom row action on a Group. |
|
page_generator_pro_groups_terms_validate |
Performs several validations on the given Group Settings, to ensure that content generation will function successfully. |
/includes/admin/spintax.php |
|
page_generator_pro_spintax_add_spintax_ provider |
Filter to add spintax to content for a third party spintax provider. |
|
page_generator_pro_spintax_add_spintax |
Filter spintax content before returning |
|
page_generator_pro_spintax_get_protected_words |
Define the array of protected words to not apply spintax to |
|
page_generator_pro_spintax_get_spintax_words |
Defines the available spintax words |
/includes/admin/pixabay.php |
|
page_generator_pro_pixabay_photos_search_args |
Filters the API arguments to send to the Pexels /search endpoint |
|
page_generator_pro_pixabay_videos_search_args |
Filters the API arguments to send to the Pexels /search endpoint |
/includes/admin/api.php |
|
page_generator_pro_api_set_timeout |
Defines the maximum time to allow the API request to run. |
/includes/admin/pexels.php |
|
page_generator_pro_pexels_photos_search_args |
Filters the API arguments to send to the Pexels /search endpoint |
|
page_generator_pro_pexels_videos_search_args |
Filters the API arguments to send to the Pexels /search endpoint |
/includes/admin/groups-terms-table.php |
|
page_generator_pro_groups_terms_table_register_bulk_actions |
Defines Bulk Actions to be added to the select dropdown on the Groups Terms WP_List_Table. |
|
page_generator_pro_groups_terms_table_admin_columns |
Filters the columns to display on the Groups: Terms WP_List_Table. |
|
page_generator_pro_groups_terms_table_admin_columns_output |
Filters the output for a non-standard column on the Groups: Terms WP_List_Table. |
|
page_generator_pro_groups_terms_table_admin_row_actions |
Filters the row actions to output on each Content Group in the Groups: Content WP_List_Table. |
/includes/admin/groups-table.php |
|
page_generator_pro_groups_table_register_bulk_actions |
Defines Bulk Actions to be added to the select dropdown on the Groups WP_List_Table. |
|
page_generator_pro_groups_table_admin_columns |
Filters the columns to display on the Groups: Content WP_List_Table. |
|
page_generator_pro_groups_table_admin_columns_output |
Define items to ouptput for a non-standard column on the Groups: Terms WP_List_Table. |
|
page_generator_pro_groups_table_admin_row_actions |
Filters the row actions to output on each Content Group in the Groups: Content WP_List_Table. |
/includes/admin/generate.php |
|
page_generator_pro_generate_post_args |
Filters arguments used for creating or updating a Post when running content generation. |
|
page_generator_pro_generate_term_args |
Filters arguments used for creating or updating a Term when running content generation. |
|
page_generator_pro_generate_generate_content_apply_keyword_transformation |
Filter to perform non-standard keyword transformation. |
|
page_generator_pro_generate_replace_keywords_in_array |
Perform any other keyword replacements or string processing. |
|
page_generator_pro_generate_process_shortcodes_in_array |
Filter to allow registering and processing shortcodes on a string. |
/includes/admin/admin.php |
|
page_generator_pro_setting_panel |
Filters the available panels / sections on the settings screen. |
/includes/admin/geo.php |
|
page_generator_pro_geo_get_phone_area_code_countries |
Filters the supported countries for generating phone area codes. |
|
page_generator_pro_geo_get_phone_area_codes |
Filters the supported countries for generating phone area codes. |
/includes/admin/groups.php |
|
page_generator_pro_groups_get_defaults |
Defines the default settings structure when a new Content Group is created. |
|
page_generator_pro_groups_get_post_meta_ignored_keys |
Defines Post Meta Keys in a Content Group to ignore and not copy to generated Posts / Groups. |
|
page_generator_pro_groups_get_post_meta |
Filters the Group Metadata to return. |
|
page_generator_pro_groups_get_all |
Filters the Groups to return. |
|
page_generator_pro_groups_get_all_ids_names |
Filters the Groups to return. |
|
page_generator_pro_groups_run_row_actions |
|
|
page_generator_pro_groups_run_row_actions_success_message |
Define an optional success message based on the result of a custom row action on a Group. |
|
page_generator_pro_groups_validate |
Performs several validations on the given Group Settings, to ensure that content generation will function successfully. |
/includes/admin/notices.php |
|
page_generator_pro_notices_get_success_notices |
Filters the success notices to return. |
|
page_generator_pro_notices_get_error_notices |
Filters the error notices to return. |
|
page_generator_pro_notices_get_notices |
Filters the success and error notices to return. |
|
page_generator_pro_notices_save |
Filters the success and error notices to save. |
/includes/admin/wpzinc-api.php |
|
page_generator_pro_wpzinc_api_request_timeout |
Defines the maximum number of seconds to allow an API request to run. |
/includes/admin/spin-rewriter-api.php |
|
page_generator_pro_spin_rewriter_api_request_timeout |
Defines the maximum number of seconds to allow an API request to run. |
/includes/global/common.php |
|
page_generator_pro_common_get_spintax_providers |
Defines the available spintax providers supported by this Plugin |
|
page_generator_pro_common_get_post_types |
Defines the available public Post Type Objects that content can be generated for. |
|
page_generator_pro_common_get_hierarchical_post_types |
Defines the available public hierarchical Post Type Objects that content can be generated for. |
|
page_generator_pro_common_get_excerpt_post_types |
Defines the available public hierarchical Post Type Objects that content can be generated for. |
|
page_generator_pro_common_get_excluded_post_types |
Defines the Post Type Objects that content cannot be generated for. |
|
page_generator_pro_common_get_post_type_templates |
Defines available Theme Templates for each Post Type that can have content generated for it. |
|
page_generator_pro_common_get_taxonomies |
Defines available taxonomies. |
|
page_generator_pro_common_get_taxonomies_hierarchical_status |
Defines available hierarchical taxonomies. |
|
page_generator_pro_common_get_post_type_taxonomies |
Defines available taxonomies for the given Post Type. |
|
page_generator_pro_common_get_excluded_taxonomies |
Defines taxonomies to exclude from displaying on the Generate screens. |
|
page_generator_pro_common_get_authors |
Defines available authors for the Author dropdown on the Generate Content screen. |
|
page_generator_pro_common_get_post_statuses |
Defines available Post Statuses for generated content. |
|
page_generator_pro_common_get_date_options |
Defines available scheduling options for generated content. |
|
page_generator_pro_common_get_schedule_units |
Defines available scheduling units. |
|
page_generator_pro_common_get_methods |
Defines available content generation methods. |
|
page_generator_pro_common_get_overwrite_methods |
Defines available content overwrite options. |
|
page_generator_pro_common_get_overwrite_sections |
Defines available content overwrite sections. |
|
page_generator_pro_common_get_term_overwrite_methods |
Defines available term overwrite options. |
|
page_generator_pro_common_get_featured_image_sources |
Defines available Featured Image sources. |
|
page_generator_pro_common_get_order_by_options |
Defines WP_Query compatible order by options |
|
page_generator_pro_common_get_location_order_by_options |
Defines GeoRocket API compatible order by options |
|
page_generator_pro_common_get_order_options |
Defines WP_Query compatible order options |
|
page_generator_pro_common_get_comparison_operators |
Define MySQL compliant operator options |
|
page_generator_pro_common_get_operator_options |
Define MySQL compliant operator options |
|
page_generator_pro_common_get_keyword_transformation_options |
Defines available Keyword Transformation options. |
|
page_generator_pro_common_get_autocomplete_enabled_fields |
Defines an array of Javascript DOM selectors to enable the keyword autocomplete functionality on. |
|
page_generator_pro_common_get_unsplash_image_size_options |
Defines available Unsplash API Image Size options. |
|
page_generator_pro_common_get_unsplash_image_orientation_options |
Defines available Unsplash API Image Orientation options. |
|
page_generator_pro_common_get_media_library_image_size_options |
Defines available registered image sizes in WordPress |
|
page_generator_pro_common_get_capabilities_to_disable_on_group_content_generation |
Defines Role Capabilities that should be disabled when a Content Group is Generating Content. |
|
page_generator_pro_common_get_capabilities_to_disable_on_group_term_generation |
Defines Role Capabilities that should be disabled when a Term Group is Generating Terms. |
|
page_generator_pro_common_get_countries |
Defines available GeoRocket API country codes and names. |
|
page_generator_pro_common_get_locations_restrictions |
Defines available location restrictions for Generate Locations |
|
page_generator_pro_common_get_nearby_cities_zipcodes_output_types |
Defines available output types for Generate Locations. |
|
page_generator_pro_common_get_locations_output_types |
Defines available output types for Generate Locations. |
|
page_generator_pro_common_get_phone_area_output_types |
Defines available output types for Generate Phone Area Codes. |
|
page_generator_pro_common_get_wikipedia_languages |
Defines available Wikipedia languages. |
/includes/global/settings.php |
|
page_generator_pro_get_settings |
Filter the Settings before returning. |
|
page_generator_pro_update_setting |
Filter a specific setting before updating. |
|
page_generator_pro_update_settings |
Filter the Settings before updating. |
/includes/global/shortcode.php |
|
page_generator_pro_shortcode_get_shortcodes |
Defines an array comprising of plugin specific Shortcodes, and their attributes. This is used by both TinyMCE and Gutenberg, so that Shortcodes and Blocks are registered. |
|
page_generator_pro_shortcode_google_maps_url |
Filter the Google Maps iFrame URL, before output. |
|
page_generator_pro_shortcode_google_maps |
Filter the Google Maps HTML output, before returning. |
|
page_generator_pro_shortcode_media_library |
Filter the Media Library HTML output, before returning. |
|
page_generator_pro_shortcode_open_street_map |
Filter the Open Street Maps HTML output, before returning. |
|
page_generator_pro_shortcode_pexels |
Filter the Pexels HTML output, before returning. |
|
page_generator_pro_shortcode_pixabay |
Filter the Pexels HTML output, before returning. |
|
page_generator_pro_shortcode_related_links_defaults |
Filter the Related Links Shortcode Default Attributes. |
|
page_generator_pro_shortcode_related_links |
Filter the Related Links Shortcode HTML output, before returning. |
|
page_generator_pro_shortcode_wikipedia |
Filter the Wikipedia Shortcode HTML output, before returning. |
|
page_generator_pro_shortcode_yelp |
Filter the Yelp Shortcode HTML output, before returning. |
|
page_generator_pro_shortcode_youtube |
Filter the YouTube Shortcode URL, before returning. |
|
page_generator_pro_shortcode_get_css_prefix |
Returns the CSS prefix to use. |
/includes/global/pagebuilders.php |
|
page_generator_pro_pagebuilders_register_avia_layout_builder_support |
Defines the Avia Meta Boxes to include in Content Groups. |
|
page_generator_pro_pagebuilders_register_wpbakery_page_builder_support_roles |
Filter the roles that need to be granted Page Builder access. |
|
page_generator_pro_groups_add_post_type_templates |
Filter the Post Type Templates to register on Page Builders. |
/includes/global/editor.php |
|
page_generator_pro_maybe_remove_custom_fields_meta_box_meta_keys |
Defines the Meta Keys to make available in the Custom Fields dropdown. |
|
page_generator_pro_editor_should_register_tinymce_plugins |
Set a flag to denote whether we should register TinyMCE Plugins |
|
page_generator_pro_editor_register_tinymce_plugins |
Defines the TinyMCE Plugins to register |
|
page_generator_pro_editor_register_tinymce_buttons |
Defines the TinyMCE Buttons to register |
page_generator_pro_groups_ui_remove_meta_boxes
/includes/admin/groups-ui.php::543
Overview
Filters the metaboxes to remove from the Content Groups Screen.
Parameters
Parameter |
Type |
Description |
$remove_meta_boxes |
array |
Meta Boxes to Remove |
Usage
add_filter( 'page_generator_pro_groups_ui_remove_meta_boxes', function( $remove_meta_boxes ) {
// ... your code here
// Return value
return $remove_meta_boxes;
}, 10, 1 );
page_generator_pro_groups_ui_get_titles_and_messages
/includes/admin/groups-ui.php::1086
Overview
Filters the localization title and message strings used for Generation.
Parameters
Parameter |
Type |
Description |
$localization |
array |
Titles and Messages |
Usage
add_filter( 'page_generator_pro_groups_ui_get_titles_and_messages', function( $localization ) {
// ... your code here
// Return value
return $localization;
}, 10, 1 );
page_generator_pro_shortcode_media_library_get_random_image_html_tag_query
/includes/admin/media-library.php::75
Overview
Filter the MySQL query (image type, ID) to fetch a random image ID from the Media Library.
Parameters
Parameter |
Type |
Description |
$query |
array |
Query Conditions |
$args |
array |
Attributes |
Usage
add_filter( 'page_generator_pro_shortcode_media_library_get_random_image_html_tag_query', function( $query, $args ) {
// ... your code here
// Return value
return $query;
}, 10, 2 );
page_generator_pro_shortcode_media_library_get_random_image_html_tag_query_meta
/includes/admin/media-library.php::85
Overview
Filter the MySQL query meta (title, alt, caption, description) to fetch a random image ID from the Media Library.
Parameters
Parameter |
Type |
Description |
$query |
array |
Query Conditions |
$args |
array |
Attributes |
Usage
add_filter( 'page_generator_pro_shortcode_media_library_get_random_image_html_tag_query_meta', function( $query_meta, $args ) {
// ... your code here
// Return value
return $query_meta;
}, 10, 2 );
page_generator_pro_media_library_get_random_image_id
/includes/admin/media-library.php::122
Overview
Filter the Image ID before returning.
Parameters
Parameter |
Type |
Description |
$image_id |
int |
WordPress Media Library ID |
$args |
array |
Arguments |
$images |
array |
Image Results from Query |
Usage
add_filter( 'page_generator_pro_media_library_get_random_image_id', function( $image_id, $args, $images, $query, $query_string ) {
// ... your code here
// Return value
return $image_id;
}, 10, 5 );
page_generator_pro_media_library_get_random_image_html_tag
/includes/admin/media-library.php::169
Overview
Filter the HTML Image Tag before returning.
Parameters
Parameter |
Type |
Description |
$html |
string |
HTML Image Tag |
$args |
array |
Arguments |
$image_id |
int |
WordPress Media Library ID |
$images |
array |
Image Results from Query |
Usage
add_filter( 'page_generator_pro_media_library_get_random_image_html_tag', function( $html, $args, $image_id ) {
// ... your code here
// Return value
return $html;
}, 10, 3 );
page_generator_pro_chimprewriter_api_request_timeout
/includes/admin/chimprewriter-api.php::221
Overview
Defines the maximum number of seconds to allow an API request to run.
Parameters
Parameter |
Type |
Description |
$timeout |
int |
Timeout, in seconds |
Usage
add_filter( 'page_generator_pro_chimprewriter_api_request_timeout', function( $timeout ) {
// ... your code here
// Return value
return $timeout;
}, 10, 1 );
page_generator_pro_groups_terms_ui_get_titles_and_messages
/includes/admin/groups-terms-ui.php::423
Overview
Filters the localization title and message strings used for Generation.
Parameters
Parameter |
Type |
Description |
$localization |
array |
Titles and Messages |
Usage
add_filter( 'page_generator_pro_groups_terms_ui_get_titles_and_messages', function( $localization ) {
// ... your code here
// Return value
return $localization;
}, 10, 1 );
page_generator_pro_spinnerchief_api_request_timeout
/includes/admin/spinnerchief-api.php::187
Overview
Defines the maximum number of seconds to allow an API request to run.
Parameters
Parameter |
Type |
Description |
$timeout |
int |
Timeout, in seconds |
Usage
add_filter( 'page_generator_pro_spinnerchief_api_request_timeout', function( $timeout ) {
// ... your code here
// Return value
return $timeout;
}, 10, 1 );
page_generator_pro_wordai_api_request_timeout
/includes/admin/wordai-api.php::190
Overview
Defines the maximum number of seconds to allow an API request to run.
Parameters
Parameter |
Type |
Description |
$timeout |
int |
Timeout, in seconds |
Usage
add_filter( 'page_generator_pro_wordai_api_request_timeout', function( $timeout ) {
// ... your code here
// Return value
return $timeout;
}, 10, 1 );
page_generator_pro_groups_terms_get_defaults
/includes/admin/groups-terms.php::116
Overview
Defines the default settings structure when a new Term Group is created.
Parameters
Parameter |
Type |
Description |
$defaults |
array |
Default Settings |
Usage
add_filter( 'page_generator_pro_groups_terms_get_defaults', function( $defaults ) {
// ... your code here
// Return value
return $defaults;
}, 10, 1 );
page_generator_pro_groups_terms_get_all
/includes/admin/groups-terms.php::159
Overview
Filters the Groups to return.
Parameters
Parameter |
Type |
Description |
$groups_arr |
array |
Groups |
$groups |
WP_Query |
Groups Query |
Usage
add_filter( 'page_generator_pro_groups_terms_get_all', function( $groups_arr, $groups ) {
// ... your code here
// Return value
return $groups_arr;
}, 10, 2 );
page_generator_pro_groups_terms_get_term_meta_ignored_keys
/includes/admin/groups-terms.php::236
Overview
Defines Term Meta Keys in a Content Group to ignore and not copy to generated Terms.
Parameters
Parameter |
Type |
Description |
$ignored_keys |
array |
Ignored Keys |
$id |
int |
Group ID |
Usage
add_filter( 'page_generator_pro_groups_terms_get_term_meta_ignored_keys', function( $ignored_keys, $id ) {
// ... your code here
// Return value
return $ignored_keys;
}, 10, 2 );
page_generator_pro_groups_terms_get_term_meta
/includes/admin/groups-terms.php::258
Overview
Filters the Group Metadata to return.
Parameters
Parameter |
Type |
Description |
$meta |
array |
Metadata |
$id |
int |
Group ID |
Usage
add_filter( 'page_generator_pro_groups_terms_get_term_meta', function( $meta, $id ) {
// ... your code here
// Return value
return $meta;
}, 10, 2 );
page_generator_pro_groups_terms_run_row_actions
/includes/admin/groups-terms.php::372
Parameters
Parameter |
Type |
Description |
$result |
Unknown |
N/A |
$action |
Unknown |
N/A |
$id |
Unknown |
N/A |
Usage
add_filter( 'page_generator_pro_groups_terms_run_row_actions', function( $result, $action, $id ) {
// ... your code here
// Return value
return $result;
}, 10, 3 );
page_generator_pro_groups_terms_run_row_actions_success_message
/includes/admin/groups-terms.php::427
Overview
Define an optional success message based on the result of a custom row action on a Group.
Parameters
Parameter |
Type |
Description |
$message |
mixed |
Success Message (false | string) |
$result |
mixed |
Result (WP_Error | bool | string) |
$action |
string |
Action |
$id |
int |
Group ID |
Usage
add_filter( 'page_generator_pro_groups_terms_run_row_actions_success_message', function( $message, $result, $action, $id ) {
// ... your code here
// Return value
return $message;
}, 10, 4 );
page_generator_pro_groups_terms_validate
/includes/admin/groups-terms.php::521
Overview
Performs several validations on the given Group Settings, to ensure that content generation will function successfully.
Parameters
Parameter |
Type |
Description |
$rest |
mixed |
Validation Result (WP_Error | bool) |
$settings |
array |
Group Settings |
$id |
int |
Group ID |
Usage
add_filter( 'page_generator_pro_groups_terms_validate', function( $result, $settings, $id ) {
// ... your code here
// Return value
return $result;
}, 10, 3 );
page_generator_pro_spintax_add_spintax_ provider
/includes/admin/spintax.php::207
Overview
Filter to add spintax to content for a third party spintax provider.
Parameters
Parameter |
Type |
Description |
$content |
string |
Content |
$protected_words |
array |
Protected Words |
Usage
add_filter( 'page_generator_pro_spintax_add_spintax_ provider', function( $content, $protected_words ) {
// ... your code here
// Return value
return $content;
}, 10, 2 );
page_generator_pro_spintax_add_spintax
/includes/admin/spintax.php::231
Overview
Filter spintax content before returning
Parameters
Parameter |
Type |
Description |
$spintax_content |
string |
Spintax Content |
$content |
string |
Original Content |
$protected_words |
array |
Protected Words |
$provider |
string |
Spintax Provider |
Usage
add_filter( 'page_generator_pro_spintax_add_spintax', function( $spintax_content, $content, $protected_words, $provider ) {
// ... your code here
// Return value
return $spintax_content;
}, 10, 4 );
page_generator_pro_spintax_get_protected_words
/includes/admin/spintax.php::494
Overview
Define the array of protected words to not apply spintax to
Parameters
Parameter |
Type |
Description |
$protected_words |
array |
Protected Words |
$protected_words_settings |
array |
Protected Words from Plugin settings |
$keywords |
array |
Keywords preg_match_all() results |
$shortcodes |
array |
Shortcodes preg_match_all() results |
Usage
add_filter( 'page_generator_pro_spintax_get_protected_words', function( $protected_words, $protected_words_settings, $keywords, $shortcodes ) {
// ... your code here
// Return value
return $protected_words;
}, 10, 4 );
page_generator_pro_spintax_get_spintax_words
/includes/admin/spintax.php::1474
Overview
Defines the available spintax words
Parameters
Parameter |
Type |
Description |
$spintax |
array |
Spintax words |
Usage
add_filter( 'page_generator_pro_spintax_get_spintax_words', function( $spintax ) {
// ... your code here
// Return value
return $spintax;
}, 10, 1 );
page_generator_pro_pixabay_photos_search_args
/includes/admin/pixabay.php::270
Overview
Filters the API arguments to send to the Pexels /search endpoint
Parameters
Parameter |
Type |
Description |
$args |
array |
API arguments |
$query |
string |
Search Term(s) |
$language |
string |
Language ( see get_languages() for valid values ) |
$image_type |
string |
Image Type ( see get_image_types() for valid values ) |
$orientation |
string |
Image Orientation ( see get_image_orientations() for valid values ) |
$category |
string |
Image Category ( see get_categories() for valid values ) |
$min_width |
int |
Minimum Image Width |
$min_height |
int |
Minimum Image Height |
$color |
string |
Color ( see get_colors() for valid values ) |
$safe_search |
bool |
Safe Search |
$per_page |
int |
Number of Images to Return |
$page |
int |
Pagination Page Offset |
Usage
add_filter( 'page_generator_pro_pixabay_photos_search_args', function( $args, $query, $language, $image_type, $orientation, $category, $min_width, $min_height, $color, $safe_search, $per_page, $page ) {
// ... your code here
// Return value
return $args;
}, 10, 12 );
page_generator_pro_pixabay_videos_search_args
/includes/admin/pixabay.php::343
Overview
Filters the API arguments to send to the Pexels /search endpoint
Parameters
Parameter |
Type |
Description |
$args |
array |
API arguments |
$query |
string |
Search Term(s) |
$language |
string |
Language ( see get_languages() for valid values ) |
$video_type |
string |
Video Type ( see get_video_types() for valid values ) |
$category |
string |
Video Category ( see get_categories() for valid values ) |
$size |
string |
Video Size ( see get_video_sizes() for valid values ) |
$safe_search |
bool |
Safe Search |
$per_page |
int |
Number of Images to Return |
$page |
int |
Pagination Page Offset |
Usage
add_filter( 'page_generator_pro_pixabay_videos_search_args', function( $args, $query, $language, $video_type, $category, $size, $safe_search, $per_page, $page ) {
// ... your code here
// Return value
return $args;
}, 10, 9 );
page_generator_pro_api_set_timeout
/includes/admin/api.php::149
Overview
Defines the maximum time to allow the API request to run.
Parameters
Parameter |
Type |
Description |
$timeout |
int |
Timeout, in seconds |
Usage
add_filter( 'page_generator_pro_api_set_timeout', function( $timeout ) {
// ... your code here
// Return value
return $timeout;
}, 10, 1 );
page_generator_pro_pexels_photos_search_args
/includes/admin/pexels.php::103
Overview
Filters the API arguments to send to the Pexels /search endpoint
Parameters
Parameter |
Type |
Description |
$args |
array |
API arguments |
$query |
string |
Search Term(s) |
$size |
string |
Image Size (original, large, large2x, medium, small, portrait, landscape, tiny) |
$per_page |
int |
Number of Images to Return |
$page |
int |
Pagination Page Offset |
Usage
add_filter( 'page_generator_pro_pexels_photos_search_args', function( $args, $query, $size, $orientation, $per_page, $page ) {
// ... your code here
// Return value
return $args;
}, 10, 6 );
page_generator_pro_pexels_videos_search_args
/includes/admin/pexels.php::183
Overview
Filters the API arguments to send to the Pexels /search endpoint
Parameters
Parameter |
Type |
Description |
$args |
array |
API arguments |
$query |
string |
Search Term(s) |
$width |
int |
Video Width (640,960,1280,2560) |
$height |
int |
Video Height (360,540,720,1440) |
$min_duration |
int |
Minimum Duration |
$max_duration |
int |
Maximum Duration |
$per_page |
int |
Number of Videos to Return |
$page |
int |
Pagination Page Offset |
Usage
add_filter( 'page_generator_pro_pexels_videos_search_args', function( $args, $query, $width, $height, $min_duration, $max_duration, $per_page, $page ) {
// ... your code here
// Return value
return $args;
}, 10, 8 );
page_generator_pro_groups_terms_table_register_bulk_actions
/includes/admin/groups-terms-table.php::84
Overview
Defines Bulk Actions to be added to the select dropdown on the Groups Terms WP_List_Table.
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( 'page_generator_pro_groups_terms_table_register_bulk_actions', function( $bulk_actions, $actions ) {
// ... your code here
// Return value
return $bulk_actions;
}, 10, 2 );
page_generator_pro_groups_terms_table_admin_columns
/includes/admin/groups-terms-table.php::222
Overview
Filters the columns to display on the Groups: Terms WP_List_Table.
Parameters
Parameter |
Type |
Description |
$columns |
array |
Columns |
Usage
add_filter( 'page_generator_pro_groups_terms_table_admin_columns', function( $columns ) {
// ... your code here
// Return value
return $columns;
}, 10, 1 );
page_generator_pro_groups_terms_table_admin_columns_output
/includes/admin/groups-terms-table.php::323
Overview
Filters the output for a non-standard column on the Groups: Terms WP_List_Table.
Parameters
Parameter |
Type |
Description |
$columns |
array |
Columns |
$term_id |
int |
Group ID |
$settings |
array |
Group Settings |
Usage
add_filter( 'page_generator_pro_groups_terms_table_admin_columns_output', function( $column_name, $term_id, $settings ) {
// ... your code here
// Return value
return $column_name;
}, 10, 3 );
page_generator_pro_groups_terms_table_admin_row_actions
/includes/admin/groups-terms-table.php::370
Overview
Filters the row actions to output on each Content Group in the Groups: Content WP_List_Table.
Parameters
Parameter |
Type |
Description |
$actions |
array |
Row Actions |
$term |
WP_Term |
Term |
Usage
add_filter( 'page_generator_pro_groups_terms_table_admin_row_actions', function( $actions, $term ) {
// ... your code here
// Return value
return $actions;
}, 10, 2 );
page_generator_pro_groups_table_register_bulk_actions
/includes/admin/groups-table.php::85
Overview
Defines Bulk Actions to be added to the select dropdown on the Groups WP_List_Table.
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( 'page_generator_pro_groups_table_register_bulk_actions', function( $bulk_actions, $actions ) {
// ... your code here
// Return value
return $bulk_actions;
}, 10, 2 );
page_generator_pro_groups_table_admin_columns
/includes/admin/groups-table.php::244
Overview
Filters the columns to display on the Groups: Content WP_List_Table.
Parameters
Parameter |
Type |
Description |
$new_columns |
array |
New Columns |
$columns |
array |
Columns |
Usage
add_filter( 'page_generator_pro_groups_table_admin_columns', function( $new_columns, $columns ) {
// ... your code here
// Return value
return $new_columns;
}, 10, 2 );
page_generator_pro_groups_table_admin_columns_output
/includes/admin/groups-table.php::361
Overview
Define items to ouptput for a non-standard column on the Groups: Terms WP_List_Table.
Parameters
Parameter |
Type |
Description |
$column_name |
string |
Column Name |
$post_id |
int |
Group ID |
Usage
add_filter( 'page_generator_pro_groups_table_admin_columns_output', function( $items, $column_name, $post_id ) {
// ... your code here
// Return value
return $items;
}, 10, 3 );
page_generator_pro_groups_table_admin_row_actions
/includes/admin/groups-table.php::405
Overview
Filters the row actions to output on each Content Group in the Groups: Content WP_List_Table.
Parameters
Parameter |
Type |
Description |
$actions |
array |
Row Actions |
$post |
WP_Post |
Post |
Usage
add_filter( 'page_generator_pro_groups_table_admin_row_actions', function( $actions, $post ) {
// ... your code here
// Return value
return $actions;
}, 10, 2 );
page_generator_pro_generate_post_args
/includes/admin/generate.php::453
Overview
Filters arguments used for creating or updating a Post when running content generation.
Parameters
Parameter |
Type |
Description |
$post_args |
array |
wp_insert_post() / wp_update_post() compatible arguments |
$settings |
array |
Content Group Settings |
Usage
add_filter( 'page_generator_pro_generate_post_args', function( $post_args, $settings ) {
// ... your code here
// Return value
return $post_args;
}, 10, 2 );
page_generator_pro_generate_term_args
/includes/admin/generate.php::721
Overview
Filters arguments used for creating or updating a Term when running content generation.
Parameters
Parameter |
Type |
Description |
$term_args |
array |
wp_insert_term() / wp_update_term() compatible arguments |
$settings |
array |
Content Group Settings |
Usage
add_filter( 'page_generator_pro_generate_term_args', function( $term_args, $settings ) {
// ... your code here
// Return value
return $term_args;
}, 10, 2 );
page_generator_pro_generate_generate_content_apply_keyword_transformation
/includes/admin/generate.php::1002
Overview
Filter to perform non-standard keyword transformation.
Parameters
Parameter |
Type |
Description |
$term |
string |
Term |
$transformation |
string |
Keyword Transformation |
Usage
add_filter( 'page_generator_pro_generate_generate_content_apply_keyword_transformation', function( $term, $keyword_transformation ) {
// ... your code here
// Return value
return $term;
}, 10, 2 );
page_generator_pro_generate_replace_keywords_in_array
/includes/admin/generate.php::1606
Overview
Perform any other keyword replacements or string processing.
Parameters
Parameter |
Type |
Description |
$item |
string |
Group Setting String (this can be Post Meta, Custom Fields, Permalink, Title, Content etc) |
$key |
string |
Group Setting Key |
Usage
add_filter( 'page_generator_pro_generate_replace_keywords_in_array', function( $item, $key ) {
// ... your code here
// Return value
return $item;
}, 10, 2 );
page_generator_pro_generate_process_shortcodes_in_array
/includes/admin/generate.php::1732
Overview
Filter to allow registering and processing shortcodes on a string.
Parameters
Parameter |
Type |
Description |
$item |
string |
Group Setting String (this can be Post Meta, Custom Fields, Permalink, Title, Content etc) |
$key |
string |
Group Setting Key |
Usage
add_filter( 'page_generator_pro_generate_process_shortcodes_in_array', function( $item, $key ) {
// ... your code here
// Return value
return $item;
}, 10, 2 );
page_generator_pro_setting_panel
/includes/admin/admin.php::653
Overview
Filters the available panels / sections on the settings screen.
Parameters
Parameter |
Type |
Description |
$panels |
array |
Settings Panels |
Usage
add_filter( 'page_generator_pro_setting_panel', function( $panels ) {
// ... your code here
// Return value
return $panels;
}, 10, 1 );
page_generator_pro_geo_get_phone_area_code_countries
/includes/admin/geo.php::274
Overview
Filters the supported countries for generating phone area codes.
Parameters
Parameter |
Type |
Description |
Countries |
array $countries |
N/A |
Usage
add_filter( 'page_generator_pro_geo_get_phone_area_code_countries', function( $countries ) {
// ... your code here
// Return value
return $countries;
}, 10, 1 );
page_generator_pro_geo_get_phone_area_codes
/includes/admin/geo.php::327
Overview
Filters the supported countries for generating phone area codes.
Parameters
Parameter |
Type |
Description |
Countries |
array $countries |
N/A |
Usage
add_filter( 'page_generator_pro_geo_get_phone_area_codes', function( $area_codes ) {
// ... your code here
// Return value
return $area_codes;
}, 10, 1 );
page_generator_pro_groups_get_defaults
/includes/admin/groups.php::156
Overview
Defines the default settings structure when a new Content Group is created.
Parameters
Parameter |
Type |
Description |
$defaults |
array |
Default Settings |
Usage
add_filter( 'page_generator_pro_groups_get_defaults', function( $defaults ) {
// ... your code here
// Return value
return $defaults;
}, 10, 1 );
page_generator_pro_groups_get_post_meta_ignored_keys
/includes/admin/groups.php::241
Overview
Defines Post Meta Keys in a Content Group to ignore and not copy to generated Posts / Groups.
Parameters
Parameter |
Type |
Description |
$ignored_keys |
array |
Ignored Keys |
$id |
int |
Group ID |
Usage
add_filter( 'page_generator_pro_groups_get_post_meta_ignored_keys', function( $ignored_keys, $id ) {
// ... your code here
// Return value
return $ignored_keys;
}, 10, 2 );
page_generator_pro_groups_get_post_meta
/includes/admin/groups.php::276
Overview
Filters the Group Metadata to return.
Parameters
Parameter |
Type |
Description |
$meta |
array |
Metadata |
$id |
int |
Group ID |
Usage
add_filter( 'page_generator_pro_groups_get_post_meta', function( $meta, $id ) {
// ... your code here
// Return value
return $meta;
}, 10, 2 );
page_generator_pro_groups_get_all
/includes/admin/groups.php::324
Overview
Filters the Groups to return.
Parameters
Parameter |
Type |
Description |
$groups_arr |
array |
Groups |
$groups |
WP_Query |
Groups Query |
Usage
add_filter( 'page_generator_pro_groups_get_all', function( $groups_arr, $groups ) {
// ... your code here
// Return value
return $groups_arr;
}, 10, 2 );
page_generator_pro_groups_get_all_ids_names
/includes/admin/groups.php::368
Overview
Filters the Groups to return.
Parameters
Parameter |
Type |
Description |
$groups_arr |
array |
Groups |
$groups |
WP_Query |
Groups Query |
Usage
add_filter( 'page_generator_pro_groups_get_all_ids_names', function( $groups_arr, $groups ) {
// ... your code here
// Return value
return $groups_arr;
}, 10, 2 );
page_generator_pro_groups_run_row_actions
/includes/admin/groups.php::508
Parameters
Parameter |
Type |
Description |
$result |
Unknown |
N/A |
$action |
Unknown |
N/A |
$id |
Unknown |
N/A |
Usage
add_filter( 'page_generator_pro_groups_run_row_actions', function( $result, $action, $id ) {
// ... your code here
// Return value
return $result;
}, 10, 3 );
page_generator_pro_groups_run_row_actions_success_message
/includes/admin/groups.php::562
Overview
Define an optional success message based on the result of a custom row action on a Group.
Parameters
Parameter |
Type |
Description |
$message |
mixed |
Success Message (false | string) |
$result |
mixed |
Result (WP_Error | bool | string) |
$action |
string |
Action |
$id |
int |
Group ID |
Usage
add_filter( 'page_generator_pro_groups_run_row_actions_success_message', function( $message, $result, $action, $id ) {
// ... your code here
// Return value
return $message;
}, 10, 4 );
page_generator_pro_groups_validate
/includes/admin/groups.php::690
Overview
Performs several validations on the given Group Settings, to ensure that content generation will function successfully.
Parameters
Parameter |
Type |
Description |
$rest |
mixed |
Validation Result (WP_Error | bool) |
$settings |
array |
Group Settings |
$id |
int |
Group ID |
Usage
add_filter( 'page_generator_pro_groups_validate', function( $result, $settings, $id ) {
// ... your code here
// Return value
return $result;
}, 10, 3 );
page_generator_pro_notices_get_success_notices
/includes/admin/notices.php::126
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( 'page_generator_pro_notices_get_success_notices', function( $success_notices, $notices ) {
// ... your code here
// Return value
return $success_notices;
}, 10, 2 );
page_generator_pro_notices_get_error_notices
/includes/admin/notices.php::197
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( 'page_generator_pro_notices_get_error_notices', function( $error_notices, $notices ) {
// ... your code here
// Return value
return $error_notices;
}, 10, 2 );
page_generator_pro_notices_get_notices
/includes/admin/notices.php::255
Overview
Filters the success and error notices to return.
Parameters
Parameter |
Type |
Description |
$notices |
array |
Success and Error Notices |
Usage
add_filter( 'page_generator_pro_notices_get_notices', function( $notices ) {
// ... your code here
// Return value
return $notices;
}, 10, 1 );
page_generator_pro_notices_save
/includes/admin/notices.php::295
Overview
Filters the success and error notices to save.
Parameters
Parameter |
Type |
Description |
$notices |
array |
Success and Error Notices |
Usage
add_filter( 'page_generator_pro_notices_save', function( $notices ) {
// ... your code here
// Return value
return $notices;
}, 10, 1 );
page_generator_pro_wpzinc_api_request_timeout
/includes/admin/wpzinc-api.php::121
Overview
Defines the maximum number of seconds to allow an API request to run.
Parameters
Parameter |
Type |
Description |
$timeout |
int |
Timeout, in seconds |
Usage
add_filter( 'page_generator_pro_wpzinc_api_request_timeout', function( $timeout ) {
// ... your code here
// Return value
return $timeout;
}, 10, 1 );
page_generator_pro_spin_rewriter_api_request_timeout
/includes/admin/spin-rewriter-api.php::223
Overview
Defines the maximum number of seconds to allow an API request to run.
Parameters
Parameter |
Type |
Description |
$timeout |
int |
Timeout, in seconds |
Usage
add_filter( 'page_generator_pro_spin_rewriter_api_request_timeout', function( $timeout ) {
// ... your code here
// Return value
return $timeout;
}, 10, 1 );
page_generator_pro_common_get_spintax_providers
/includes/global/common.php::58
Overview
Defines the available spintax providers supported by this Plugin
Parameters
Parameter |
Type |
Description |
$providers |
array |
Spintax Service Providers |
Usage
add_filter( 'page_generator_pro_common_get_spintax_providers', function( $providers ) {
// ... your code here
// Return value
return $providers;
}, 10, 1 );
page_generator_pro_common_get_post_types
/includes/global/common.php::94
Overview
Defines the available public Post Type Objects that content can be generated for.
Parameters
Parameter |
Type |
Description |
$types |
array |
Post Types |
Usage
add_filter( 'page_generator_pro_common_get_post_types', function( $types ) {
// ... your code here
// Return value
return $types;
}, 10, 1 );
page_generator_pro_common_get_hierarchical_post_types
/includes/global/common.php::131
Overview
Defines the available public hierarchical Post Type Objects that content can be generated for.
Parameters
Parameter |
Type |
Description |
$types |
array |
Post Types |
Usage
add_filter( 'page_generator_pro_common_get_hierarchical_post_types', function( $types ) {
// ... your code here
// Return value
return $types;
}, 10, 1 );
page_generator_pro_common_get_excerpt_post_types
/includes/global/common.php::174
Overview
Defines the available public hierarchical Post Type Objects that content can be generated for.
Parameters
Parameter |
Type |
Description |
$types |
array |
Post Types |
Usage
add_filter( 'page_generator_pro_common_get_excerpt_post_types', function( $types ) {
// ... your code here
// Return value
return $types;
}, 10, 1 );
page_generator_pro_common_get_excluded_post_types
/includes/global/common.php::205
Overview
Defines the Post Type Objects that content cannot be generated for.
Parameters
Parameter |
Type |
Description |
$types |
array |
Post Types |
Usage
add_filter( 'page_generator_pro_common_get_excluded_post_types', function( $types ) {
// ... your code here
// Return value
return $types;
}, 10, 1 );
page_generator_pro_common_get_post_type_templates
/includes/global/common.php::249
Overview
Defines available Theme Templates for each Post Type that can have content generated for it.
Parameters
Parameter |
Type |
Description |
$templates |
array |
Templates by Post Type |
Usage
add_filter( 'page_generator_pro_common_get_post_type_templates', function( $templates ) {
// ... your code here
// Return value
return $templates;
}, 10, 1 );
page_generator_pro_common_get_taxonomies
/includes/global/common.php::296
Overview
Defines available taxonomies.
Parameters
Parameter |
Type |
Description |
$taxonomies |
array |
Taxonomies |
$excluded_taxonomies |
array |
Excluded Taxonomies (these have already been removed from $taxonomies) |
Usage
add_filter( 'page_generator_pro_common_get_taxonomies', function( $taxonomies, $excluded_taxonomies ) {
// ... your code here
// Return value
return $taxonomies;
}, 10, 2 );
page_generator_pro_common_get_taxonomies_hierarchical_status
/includes/global/common.php::338
Overview
Defines available hierarchical taxonomies.
Parameters
Parameter |
Type |
Description |
$taxonomies |
array |
Taxonomies |
$excluded_taxonomies |
array |
Excluded Taxonomies (these have already been removed from $taxonomies) |
Usage
add_filter( 'page_generator_pro_common_get_taxonomies_hierarchical_status', function( $taxonomies_hierarchical_status, $excluded_taxonomies ) {
// ... your code here
// Return value
return $taxonomies_hierarchical_status;
}, 10, 2 );
page_generator_pro_common_get_post_type_taxonomies
/includes/global/common.php::375
Overview
Defines available taxonomies for the given Post Type.
Parameters
Parameter |
Type |
Description |
$taxonomies |
array |
Taxonomies |
$excluded_taxonomies |
array |
Excluded Taxonomies (these have already been removed from $taxonomies) |
$post_type |
string |
Post Type |
Usage
add_filter( 'page_generator_pro_common_get_post_type_taxonomies', function( $taxonomies, $excluded_taxonomies, $post_type ) {
// ... your code here
// Return value
return $taxonomies;
}, 10, 3 );
page_generator_pro_common_get_excluded_taxonomies
/includes/global/common.php::405
Overview
Defines taxonomies to exclude from displaying on the Generate screens.
Parameters
Parameter |
Type |
Description |
$excluded_taxonomies |
array |
Excluded Taxonomies |
Usage
add_filter( 'page_generator_pro_common_get_excluded_taxonomies', function( $excluded_taxonomies ) {
// ... your code here
// Return value
return $excluded_taxonomies;
}, 10, 1 );
page_generator_pro_common_get_authors
/includes/global/common.php::433
Overview
Defines available authors for the Author dropdown on the Generate Content screen.
Parameters
Parameter |
Type |
Description |
$authors |
array |
Authors |
Usage
add_filter( 'page_generator_pro_common_get_authors', function( $authors ) {
// ... your code here
// Return value
return $authors;
}, 10, 1 );
page_generator_pro_common_get_post_statuses
/includes/global/common.php::464
Overview
Defines available Post Statuses for generated content.
Parameters
Parameter |
Type |
Description |
$statuses |
array |
Statuses |
Usage
add_filter( 'page_generator_pro_common_get_post_statuses', function( $statuses ) {
// ... your code here
// Return value
return $statuses;
}, 10, 1 );
page_generator_pro_common_get_date_options
/includes/global/common.php::494
Overview
Defines available scheduling options for generated content.
Parameters
Parameter |
Type |
Description |
$date_options |
array |
Date Options |
Usage
add_filter( 'page_generator_pro_common_get_date_options', function( $date_options ) {
// ... your code here
// Return value
return $date_options;
}, 10, 1 );
page_generator_pro_common_get_schedule_units
/includes/global/common.php::526
Overview
Defines available scheduling units.
Parameters
Parameter |
Type |
Description |
$units |
array |
Units |
Usage
add_filter( 'page_generator_pro_common_get_schedule_units', function( $units ) {
// ... your code here
// Return value
return $units;
}, 10, 1 );
page_generator_pro_common_get_methods
/includes/global/common.php::556
Overview
Defines available content generation methods.
Parameters
Parameter |
Type |
Description |
$methods |
array |
Content Generation Methods |
Usage
add_filter( 'page_generator_pro_common_get_methods', function( $methods ) {
// ... your code here
// Return value
return $methods;
}, 10, 1 );
page_generator_pro_common_get_overwrite_methods
/includes/global/common.php::588
Overview
Defines available content overwrite options.
Parameters
Parameter |
Type |
Description |
$methods |
array |
Content Overwrite Options |
Usage
add_filter( 'page_generator_pro_common_get_overwrite_methods', function( $methods ) {
// ... your code here
// Return value
return $methods;
}, 10, 1 );
page_generator_pro_common_get_overwrite_sections
/includes/global/common.php::624
Overview
Defines available content overwrite sections.
Parameters
Parameter |
Type |
Description |
$sections |
array |
Content Overwrite Sections |
Usage
add_filter( 'page_generator_pro_common_get_overwrite_sections', function( $sections ) {
// ... your code here
// Return value
return $sections;
}, 10, 1 );
page_generator_pro_common_get_term_overwrite_methods
/includes/global/common.php::654
Overview
Defines available term overwrite options.
Parameters
Parameter |
Type |
Description |
$methods |
array |
Term Overwrite Options |
Usage
add_filter( 'page_generator_pro_common_get_term_overwrite_methods', function( $methods ) {
// ... your code here
// Return value
return $methods;
}, 10, 1 );
page_generator_pro_common_get_featured_image_sources
/includes/global/common.php::686
Overview
Defines available Featured Image sources.
Parameters
Parameter |
Type |
Description |
$methods |
array |
Featured Image Sources |
Usage
add_filter( 'page_generator_pro_common_get_featured_image_sources', function( $sources ) {
// ... your code here
// Return value
return $sources;
}, 10, 1 );
page_generator_pro_common_get_order_by_options
/includes/global/common.php::724
Overview
Defines WP_Query compatible order by options
Parameters
Parameter |
Type |
Description |
$order_by |
array |
Order By options |
Usage
add_filter( 'page_generator_pro_common_get_order_by_options', function( $order_by ) {
// ... your code here
// Return value
return $order_by;
}, 10, 1 );
page_generator_pro_common_get_location_order_by_options
/includes/global/common.php::755
Overview
Defines GeoRocket API compatible order by options
Parameters
Parameter |
Type |
Description |
$order_by |
array |
GeoRocket API order by options |
Usage
add_filter( 'page_generator_pro_common_get_location_order_by_options', function( $order_by ) {
// ... your code here
// Return value
return $order_by;
}, 10, 1 );
page_generator_pro_common_get_order_options
/includes/global/common.php::784
Overview
Defines WP_Query compatible order options
Parameters
Parameter |
Type |
Description |
$order |
array |
Order options |
Usage
add_filter( 'page_generator_pro_common_get_order_options', function( $order ) {
// ... your code here
// Return value
return $order;
}, 10, 1 );
page_generator_pro_common_get_comparison_operators
/includes/global/common.php::820
Overview
Define MySQL compliant operator options
Parameters
Parameter |
Type |
Description |
$order |
array |
Order options |
Usage
add_filter( 'page_generator_pro_common_get_comparison_operators', function( $operators ) {
// ... your code here
// Return value
return $operators;
}, 10, 1 );
page_generator_pro_common_get_operator_options
/includes/global/common.php::849
Overview
Define MySQL compliant operator options
Parameters
Parameter |
Type |
Description |
$order |
array |
Order options |
Usage
add_filter( 'page_generator_pro_common_get_operator_options', function( $operators ) {
// ... your code here
// Return value
return $operators;
}, 10, 1 );
page_generator_pro_common_get_keyword_transformation_options
/includes/global/common.php::881
Overview
Defines available Keyword Transformation options.
Parameters
Parameter |
Type |
Description |
$transformation_options |
array |
Transformation Options |
Usage
add_filter( 'page_generator_pro_common_get_keyword_transformation_options', function( $transformation_options ) {
// ... your code here
// Return value
return $transformation_options;
}, 10, 1 );
page_generator_pro_common_get_autocomplete_enabled_fields
/includes/global/common.php::922
Overview
Defines an array of Javascript DOM selectors to enable the keyword autocomplete functionality on.
Parameters
Parameter |
Type |
Description |
$fields |
array |
Supported Fields |
Usage
add_filter( 'page_generator_pro_common_get_autocomplete_enabled_fields', function( $fields ) {
// ... your code here
// Return value
return $fields;
}, 10, 1 );
page_generator_pro_common_get_unsplash_image_size_options
/includes/global/common.php::954
Overview
Defines available Unsplash API Image Size options.
Parameters
Parameter |
Type |
Description |
$image_sizes |
array |
Image Sizes |
Usage
add_filter( 'page_generator_pro_common_get_unsplash_image_size_options', function( $image_sizes ) {
// ... your code here
// Return value
return $image_sizes;
}, 10, 1 );
page_generator_pro_common_get_unsplash_image_orientation_options
/includes/global/common.php::985
Overview
Defines available Unsplash API Image Orientation options.
Parameters
Parameter |
Type |
Description |
$image_orientations |
array |
Image Orientation options |
Usage
add_filter( 'page_generator_pro_common_get_unsplash_image_orientation_options', function( $image_orientations ) {
// ... your code here
// Return value
return $image_orientations;
}, 10, 1 );
page_generator_pro_common_get_media_library_image_size_options
/includes/global/common.php::1011
Overview
Defines available registered image sizes in WordPress
Parameters
Parameter |
Type |
Description |
$image_sizes |
array |
Image Sizes |
Usage
add_filter( 'page_generator_pro_common_get_media_library_image_size_options', function( $image_sizes ) {
// ... your code here
// Return value
return $image_sizes;
}, 10, 1 );
page_generator_pro_common_get_capabilities_to_disable_on_group_content_generation
/includes/global/common.php::1041
Overview
Defines Role Capabilities that should be disabled when a Content Group is Generating Content.
Parameters
Parameter |
Type |
Description |
$capabilities |
array |
Capabilities |
Usage
add_filter( 'page_generator_pro_common_get_capabilities_to_disable_on_group_content_generation', function( $capabilities ) {
// ... your code here
// Return value
return $capabilities;
}, 10, 1 );
page_generator_pro_common_get_capabilities_to_disable_on_group_term_generation
/includes/global/common.php::1071
Overview
Defines Role Capabilities that should be disabled when a Term Group is Generating Terms.
Parameters
Parameter |
Type |
Description |
$capabilities |
array |
Capabilities |
Usage
add_filter( 'page_generator_pro_common_get_capabilities_to_disable_on_group_term_generation', function( $capabilities ) {
// ... your code here
// Return value
return $capabilities;
}, 10, 1 );
page_generator_pro_common_get_countries
/includes/global/common.php::1343
Overview
Defines available GeoRocket API country codes and names.
Parameters
Parameter |
Type |
Description |
$countries |
array |
Countries |
Usage
add_filter( 'page_generator_pro_common_get_countries', function( $countries ) {
// ... your code here
// Return value
return $countries;
}, 10, 1 );
page_generator_pro_common_get_locations_restrictions
/includes/global/common.php::1403
Overview
Defines available location restrictions for Generate Locations
Parameters
Parameter |
Type |
Description |
$restrictions |
array |
Output Types |
Usage
add_filter( 'page_generator_pro_common_get_locations_restrictions', function( $restrictions ) {
// ... your code here
// Return value
return $restrictions;
}, 10, 1 );
page_generator_pro_common_get_nearby_cities_zipcodes_output_types
/includes/global/common.php::1475
Overview
Defines available output types for Generate Locations.
Parameters
Parameter |
Type |
Description |
$output_types |
array |
Output Types |
Usage
add_filter( 'page_generator_pro_common_get_nearby_cities_zipcodes_output_types', function( $output_types ) {
// ... your code here
// Return value
return $output_types;
}, 10, 1 );
page_generator_pro_common_get_locations_output_types
/includes/global/common.php::1446
Overview
Defines available output types for Generate Locations.
Parameters
Parameter |
Type |
Description |
$output_types |
array |
Output Types |
Usage
add_filter( 'page_generator_pro_common_get_locations_output_types', function( $output_types ) {
// ... your code here
// Return value
return $output_types;
}, 10, 1 );
page_generator_pro_common_get_phone_area_output_types
/includes/global/common.php::1505
Overview
Defines available output types for Generate Phone Area Codes.
Parameters
Parameter |
Type |
Description |
$output_types |
array |
Output Types |
Usage
add_filter( 'page_generator_pro_common_get_phone_area_output_types', function( $output_types ) {
// ... your code here
// Return value
return $output_types;
}, 10, 1 );
page_generator_pro_common_get_wikipedia_languages
/includes/global/common.php::1826
Overview
Defines available Wikipedia languages.
Parameters
Parameter |
Type |
Description |
$output_types |
array |
Output Types |
Usage
add_filter( 'page_generator_pro_common_get_wikipedia_languages', function( $languages ) {
// ... your code here
// Return value
return $languages;
}, 10, 1 );
page_generator_pro_get_settings
/includes/global/settings.php::94
Overview
Filter the Settings before returning.
Parameters
Parameter |
Type |
Description |
$settings |
array |
Settings |
$type |
string |
Setting Type |
Usage
add_filter( 'page_generator_pro_get_settings', function( $settings, $type ) {
// ... your code here
// Return value
return $settings;
}, 10, 2 );
page_generator_pro_update_setting
/includes/global/settings.php::129
Overview
Filter a specific setting before updating.
Parameters
Parameter |
Type |
Description |
$settings |
array |
Settings |
$type |
string |
Setting Type |
$key |
string |
Setting key |
$value |
string |
Setting Value |
Usage
add_filter( 'page_generator_pro_update_setting', function( $settings, $type, $key, $value ) {
// ... your code here
// Return value
return $settings;
}, 10, 4 );
page_generator_pro_update_settings
/includes/global/settings.php::160
Overview
Filter the Settings before updating.
Parameters
Parameter |
Type |
Description |
$settings |
array |
Settings |
$type |
string |
Setting Type |
Usage
add_filter( 'page_generator_pro_update_settings', function( $settings, $type ) {
// ... your code here
// Return value
return $settings;
}, 10, 2 );
page_generator_pro_shortcode_get_shortcodes
/includes/global/shortcode.php::625
Overview
Defines an array comprising of plugin specific Shortcodes, and their attributes. This is used by both TinyMCE and Gutenberg, so that Shortcodes and Blocks are registered.
Parameters
Parameter |
Type |
Description |
$shortcodes |
array |
Registered Shortcodes |
Usage
add_filter( 'page_generator_pro_shortcode_get_shortcodes', function( $shortcodes ) {
// ... your code here
// Return value
return $shortcodes;
}, 10, 1 );
page_generator_pro_shortcode_google_maps_url
/includes/global/shortcode.php::842
Overview
Filter the Google Maps iFrame URL, before output.
Parameters
Parameter |
Type |
Description |
$url |
string |
URL with Arguments |
$atts |
array |
Shortcode Attributes |
$args |
array |
URL Arguments |
$endpoint |
string |
URL Endpoint |
Usage
add_filter( 'page_generator_pro_shortcode_google_maps_url', function( $url, $atts, $args, $endpoint ) {
// ... your code here
// Return value
return $url;
}, 10, 4 );
page_generator_pro_shortcode_google_maps
/includes/global/shortcode.php::855
Overview
Filter the Google Maps HTML output, before returning.
Parameters
Parameter |
Type |
Description |
$html |
string |
HTML Output |
$atts |
array |
Shortcode Attributes |
Usage
add_filter( 'page_generator_pro_shortcode_google_maps', function( $html, $atts ) {
// ... your code here
// Return value
return $html;
}, 10, 2 );
page_generator_pro_shortcode_media_library
/includes/global/shortcode.php::897
Overview
Filter the Media Library HTML output, before returning.
Parameters
Parameter |
Type |
Description |
$html |
string |
HTML Output |
$atts |
array |
Shortcode Attributes |
Usage
add_filter( 'page_generator_pro_shortcode_media_library', function( $html, $atts ) {
// ... your code here
// Return value
return $html;
}, 10, 2 );
page_generator_pro_shortcode_open_street_map
/includes/global/shortcode.php::961
Overview
Filter the Open Street Maps HTML output, before returning.
Parameters
Parameter |
Type |
Description |
$html |
string |
HTML Output |
$atts |
array |
Shortcode Attributes |
Usage
add_filter( 'page_generator_pro_shortcode_open_street_map', function( $html, $atts ) {
// ... your code here
// Return value
return $html;
}, 10, 2 );
page_generator_pro_shortcode_pexels
/includes/global/shortcode.php::1052
Overview
Filter the Pexels HTML output, before returning.
Parameters
Parameter |
Type |
Description |
$html |
string |
HTML Output |
$atts |
array |
Shortcode Attributes |
$image_id |
int |
WordPress Media Library Image ID |
$images |
array |
Pexels Image Results |
Usage
add_filter( 'page_generator_pro_shortcode_pexels', function( $html, $atts, $image_id, $images ) {
// ... your code here
// Return value
return $html;
}, 10, 4 );
page_generator_pro_shortcode_pixabay
/includes/global/shortcode.php::1154
Overview
Filter the Pexels HTML output, before returning.
Parameters
Parameter |
Type |
Description |
$html |
string |
HTML Output |
$atts |
array |
Shortcode Attributes |
$image_id |
int |
WordPress Media Library Image ID |
$images |
array |
Pixabay Image Results |
Usage
add_filter( 'page_generator_pro_shortcode_pixabay', function( $html, $atts, $image_id, $images ) {
// ... your code here
// Return value
return $html;
}, 10, 4 );
page_generator_pro_shortcode_related_links_defaults
/includes/global/shortcode.php::1234
Overview
Filter the Related Links Shortcode Default Attributes.
Parameters
Parameter |
Type |
Description |
$defaults |
array |
Default Attributes |
$atts |
array |
Shortcode Attributes |
$post |
WP_Post |
WordPress Post |
Usage
add_filter( 'page_generator_pro_shortcode_related_links_defaults', function( $defaults, $atts, $post ) {
// ... your code here
// Return value
return $defaults;
}, 10, 3 );
page_generator_pro_shortcode_related_links
/includes/global/shortcode.php::1433
Overview
Filter the Related Links Shortcode HTML output, before returning.
Parameters
Parameter |
Type |
Description |
$html |
string |
HTML Output |
$atts |
array |
Shortcode Attributes |
$posts |
array |
Related Posts |
WordPress |
WP_Post $post |
Post |
Usage
add_filter( 'page_generator_pro_shortcode_related_links', function( $html, $atts, $posts, $post ) {
// ... your code here
// Return value
return $html;
}, 10, 4 );
page_generator_pro_shortcode_wikipedia
/includes/global/shortcode.php::1599
Overview
Filter the Wikipedia Shortcode HTML output, before returning.
Parameters
Parameter |
Type |
Description |
$html |
string |
HTML Output |
$atts |
array |
Shortcode Attributes |
$build |
string |
Wikipedia Content |
Usage
add_filter( 'page_generator_pro_shortcode_wikipedia', function( $html, $atts, $content, $paragraphs ) {
// ... your code here
// Return value
return $html;
}, 10, 4 );
page_generator_pro_shortcode_yelp
/includes/global/shortcode.php::1742
Overview
Filter the Yelp Shortcode HTML output, before returning.
Parameters
Parameter |
Type |
Description |
$html |
string |
HTML Output |
$atts |
array |
Shortcode Attributes |
Usage
add_filter( 'page_generator_pro_shortcode_yelp', function( $html, $atts ) {
// ... your code here
// Return value
return $html;
}, 10, 2 );
page_generator_pro_shortcode_youtube
/includes/global/shortcode.php::1853
Overview
Filter the YouTube Shortcode URL, before returning.
Parameters
Parameter |
Type |
Description |
$url |
string |
YouTube URL |
$atts |
array |
Shortcode Attributes |
$videos |
array |
Video Results |
$video_index |
int |
Video Index |
Usage
add_filter( 'page_generator_pro_shortcode_youtube', function( $url, $atts, $videos, $video_index ) {
// ... your code here
// Return value
return $url;
}, 10, 4 );
page_generator_pro_shortcode_get_css_prefix
/includes/global/shortcode.php::1911
Overview
Returns the CSS prefix to use.
Parameters
Parameter |
Type |
Description |
$css_prefix |
string |
CSS Prefix to use |
Usage
add_filter( 'page_generator_pro_shortcode_get_css_prefix', function( $css_prefix ) {
// ... your code here
// Return value
return $css_prefix;
}, 10, 1 );
page_generator_pro_pagebuilders_register_avia_layout_builder_support
/includes/global/pagebuilders.php::138
Overview
Defines the Avia Meta Boxes to include in Content Groups.
Parameters
Parameter |
Type |
Description |
$avia_meta_box_ids |
array |
Avia Meta Box IDs to include in Content Groups |
$meta_boxes |
array |
Meta Boes |
Usage
add_filter( 'page_generator_pro_pagebuilders_register_avia_layout_builder_support', function( $avia_meta_box_ids, $meta_boxes ) {
// ... your code here
// Return value
return $avia_meta_box_ids;
}, 10, 2 );
page_generator_pro_pagebuilders_register_wpbakery_page_builder_support_roles
/includes/global/pagebuilders.php::563
Overview
Filter the roles that need to be granted Page Builder access.
Parameters
Parameter |
Type |
Description |
$roles |
array |
WordPress User Roles |
Usage
add_filter( 'page_generator_pro_pagebuilders_register_wpbakery_page_builder_support_roles', function( $roles ) {
// ... your code here
// Return value
return $roles;
}, 10, 1 );
page_generator_pro_groups_add_post_type_templates
/includes/global/pagebuilders.php::634
Overview
Filter the Post Type Templates to register on Page Builders.
Parameters
Parameter |
Type |
Description |
$all_templates |
array |
All Post Templates |
$post_templates |
array |
Post Templates for the given $post_type |
$wp_theme |
WP_Theme |
WP Theme class object |
$post |
WP_Post |
WordPress Post |
$post_type |
string |
Post Type $post_templates are for |
Usage
add_filter( 'page_generator_pro_groups_add_post_type_templates', function( $all_templates, $post_templates, $wp_theme, $post, $post_type ) {
// ... your code here
// Return value
return $all_templates;
}, 10, 5 );
page_generator_pro_maybe_remove_custom_fields_meta_box_meta_keys
/includes/global/editor.php::80
Overview
Defines the Meta Keys to make available in the Custom Fields dropdown.
Parameters
Parameter |
Type |
Description |
$keys |
array |
Defined Meta Keys to use |
$meta_keys |
array |
Original Meta Keys |
WordPress |
WP_Post $post |
Post |
Usage
add_filter( 'page_generator_pro_maybe_remove_custom_fields_meta_box_meta_keys', function( $keys, $meta_keys, $post ) {
// ... your code here
// Return value
return $keys;
}, 10, 3 );
page_generator_pro_editor_should_register_tinymce_plugins
/includes/global/editor.php::293
Overview
Set a flag to denote whether we should register TinyMCE Plugins
Parameters
Parameter |
Type |
Description |
$should_register_tinymce_plugins |
bool |
Should Register TinyMCE Plugins |
Usage
add_filter( 'page_generator_pro_editor_should_register_tinymce_plugins', function( $should_register_tinymce_plugins ) {
// ... your code here
// Return value
return $should_register_tinymce_plugins;
}, 10, 1 );
page_generator_pro_editor_register_tinymce_plugins
/includes/global/editor.php::320
Overview
Defines the TinyMCE Plugins to register
Parameters
Parameter |
Type |
Description |
$plugins |
array |
TinyMCE Plugins |
Usage
add_filter( 'page_generator_pro_editor_register_tinymce_plugins', function( $plugins ) {
// ... your code here
// Return value
return $plugins;
}, 10, 1 );
page_generator_pro_editor_register_tinymce_buttons
/includes/global/editor.php::365
Overview
Defines the TinyMCE Buttons to register
Parameters
Parameter |
Type |
Description |
$plugins |
array |
TinyMCE Plugins |
Usage
add_filter( 'page_generator_pro_editor_register_tinymce_buttons', function( $buttons ) {
// ... your code here
// Return value
return $buttons;
}, 10, 1 );
Actions
page_generator_pro_setting_panel- tab
/views/admin/settings.php::55
Parameters
Parameter |
Type |
Description |
Usage
do_action( 'page_generator_pro_setting_panel- tab', function( ) {
// ... your code here
}, 10, 0 );
page_generator_pro_groups_ui_add_meta_boxes
/includes/admin/groups-ui.php::425
Parameters
Parameter |
Type |
Description |
$base->get_class( 'post_type' |
Unknown |
N/A |
Usage
do_action( 'page_generator_pro_groups_ui_add_meta_boxes', function( $base->get_class( 'post_type' ) {
// ... your code here
}, 10, 1 );
page_generator_pro_generate_term_after
/includes/admin/groups-terms.php::672
Overview
Runs any actions once Generate Content has finished.
Parameters
Parameter |
Type |
Description |
$group_id |
int |
Group ID |
$test_mode |
bool |
Test Mode |
Usage
do_action( 'page_generator_pro_generate_term_after', function( $id, true ) {
// ... your code here
}, 10, 2 );
page_generator_pro_generate_content_before
/includes/admin/ajax.php::731
Overview
Runs any actions before Generate Content has started.
Parameters
Parameter |
Type |
Description |
$group_id |
int |
Group ID |
$test_mode |
bool |
Test Mode |
Usage
do_action( 'page_generator_pro_generate_content_before', function( $group['group_id'], $group['test_mode'] ) {
// ... your code here
}, 10, 2 );
page_generator_pro_generate_content_after
/includes/admin/ajax.php::746
Overview
Runs any actions once Generate Content has finished.
Parameters
Parameter |
Type |
Description |
$group_id |
int |
Group ID |
$test_mode |
bool |
Test Mode |
Usage
do_action( 'page_generator_pro_generate_content_after', function( $group['group_id'], $group['test_mode'] ) {
// ... your code here
}, 10, 2 );
page_generator_pro_generate_terms_before
/includes/admin/ajax.php::771
Overview
Runs any actions before Generate Terms has started.
Parameters
Parameter |
Type |
Description |
$group_id |
int |
Group ID |
$test_mode |
bool |
Test Mode |
Usage
do_action( 'page_generator_pro_generate_terms_before', function( $group['group_id'], $group['test_mode'] ) {
// ... your code here
}, 10, 2 );
page_generator_pro_generate_terms_after
/includes/admin/ajax.php::786
Overview
Runs any actions once Generate Terms has finished.
Parameters
Parameter |
Type |
Description |
$group_id |
int |
Group ID |
$test_mode |
bool |
Test Mode |
Usage
do_action( 'page_generator_pro_generate_terms_after', function( $group['group_id'], $group['test_mode'] ) {
// ... your code here
}, 10, 2 );
page_generator_pro_gutenberg_add_blocks
/includes/admin/gutenberg.php::73
Overview
Add any blocks here, using register_block_type(), that should appear in the Gutenberg Editor. Shortcodes registered through the `page_generator_pro_shortcode_get_shortcodes` filter will have already been registered above, so they do not need to be manually registered here.
Parameters
Parameter |
Type |
Description |
$shortcodes |
array |
Shortcodes already registered as Gutenberg Blocks |
Usage
do_action( 'page_generator_pro_gutenberg_add_blocks', function( $shortcodes ) {
// ... your code here
}, 10, 1 );
Parameters
Parameter |
Type |
Description |
Usage
do_action( 'page_generator_pro_admin_menu_import_export', function( ) {
// ... your code here
}, 10, 0 );
Parameters
Parameter |
Type |
Description |
Usage
do_action( 'page_generator_pro_admin_menu_support', function( ) {
// ... your code here
}, 10, 0 );
page_generator_pro_generate_content_after
/includes/admin/groups.php::849
Overview
Runs any actions once Generate Content has finished.
Parameters
Parameter |
Type |
Description |
$group_id |
int |
Group ID |
$test_mode |
bool |
Test Mode |
Usage
do_action( 'page_generator_pro_generate_content_after', function( $id, true ) {
// ... your code here
}, 10, 2 );
page_generator_pro_notices_delete_notices
/includes/admin/notices.php::315
Parameters
Parameter |
Type |
Description |
Usage
do_action( 'page_generator_pro_notices_delete_notices', function( ) {
// ... your code here
}, 10, 0 );
page_generator_pro_shortcode_add_shortcodes
/includes/global/shortcode.php::112
Overview
Add any shortcodes here, using add_shortcode(), that should be processed using do_shortcode() when a Page is Generated. Do NOT register shortcodes that you do NOT want processing into HTML output on the resulting Pages.
Parameters
Parameter |
Type |
Description |
$generating_group |
bool |
Generating Pages from Group (true|false) |
Usage
do_action( 'page_generator_pro_shortcode_add_shortcodes', function( $generating_group ) {
// ... your code here
}, 10, 1 );