Filters
File
Filter Name
Description
/includes/admin/groups-ui.php
page_generator_pro_groups_ui_output_add_new_buttons
Registers buttons to be displayed in the WP_List_Table filters, which will be moved by JS to display next to the Add New button
page_generator_pro_groups_ui_remove_meta_boxes
Filters the metaboxes to remove from the Content Groups Screen.
page_generator_pro_common_get_featured_image_sources
Defines available Featured Image sources.
page_generator_pro_common_get_featured_image_tabs
Defines available Featured Image tabs.
page_generator_pro_common_get_featured_image_fields
Defines available Featured Image fields.
page_generator_pro_groups_ui_get_titles_and_messages
Filters the localization title and message strings used for Generation.
page_generator_pro_groups_ui_get_post_type_conditional_metaboxes
Define conditional metaboxes that should only display based on the value of Publish > Post Type in the Content Groups UI. For example, array( 'metabox_id' => array( 'post_type_to_display_metabox_on', 'another_post_type_to_display_metabox_on' ) )
/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/integrations.php
page_generator_pro_integrations_get
Return available integrations supported by this class.
page_generator_pro_integrations_get_settings_fields
Defines each integration's settings to display at Settings > Integrations
/includes/admin/log.php
page_generator_pro_log_get_filters
Defines the registered filters that can be used on the Log WP_List_Tables.
/includes/admin/groups-directory.php
page_generator_pro_groups_directory_get_related_links_heading
Defines the header to display before the Related Links shortcode when Content Groups are generated through the Groups Directory functionality.
page_generator_pro_groups_directory_get_related_links_shortcode
Defines the Related Links Shortcode to use when a Content Group is generated through the Groups Directory functionality.
/includes/admin/phone-area-codes.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/performance.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_performance_replace_customizer_page_dropdowns
Defines an array of Customizer Page Dropdown Controls that should be replaced with either an AJAX or ID for performance
/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_all_ids_names
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/integrations/yelp.php
page_generator_pro_shortcode_yelp
Filter the Yelp Shortcode HTML output, before returning.
/includes/admin/integrations/creative-commons.php
page_generator_pro_shortcode_creative_commons
Filter the Creative Commons HTML output, before returning.
page_generator_pro_creative_commons_photos_search_args
Filters the API arguments to send to the Creative Commons /images endpoint
/includes/admin/integrations/midjourney.php
page_generator_pro_shortcode_midjourney_image
Filter the Midjourney HTML output, before returning.
/includes/admin/integrations/open-weather-map.php
page_generator_pro_shortcode_open_weather_map
Filter the Open Weather Maps HTML output, before returning.
/includes/admin/integrations/openai-image.php
page_generator_pro_shortcode_openai_image
Filter the OpenAI HTML output, before returning.
/includes/admin/integrations/media-library.php
page_generator_pro_shortcode_media_library
Filter the Media Library HTML output, before returning.
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/integrations/acf.php
page_generator_pro_acf_match_content_group_location_rule
page_generator_pro_acf_match_term_group_location_rule
/includes/admin/integrations/pixabay.php
page_generator_pro_shortcode_pixabay
Filter the Pixabay HTML output, before returning.
page_generator_pro_pixabay_photos_search_args
Filters the API arguments to send to the Pexels /search endpoint
/includes/admin/integrations/wikipedia-image.php
page_generator_pro_shortcode_wikipedia_image
Filter the Wikipedia Image HTML output, before returning.
page_generator_pro_wikipedia_get_languages
Defines available Wikipedia languages.
/includes/admin/integrations/pexels.php
page_generator_pro_shortcode_pexels
Filter the Pexels HTML output, before returning.
page_generator_pro_pexels_photos_search_args
Filters the API arguments to send to the Pexels /search endpoint
/includes/admin/integrations/wpbakery-page-builder.php
page_generator_pro_pagebuilders_register_wpbakery_page_builder_support_roles
Filter the roles that need to be granted Page Builder access.
/includes/admin/integrations/youtube.php
page_generator_pro_shortcode_youtube
Filter the YouTube Shortcode URL, before returning.
/includes/admin/integrations/avia.php
page_generator_pro_pagebuilders_register_avia_layout_builder_support
Defines the Avia Meta Boxes to include in Content Groups.
/includes/admin/integrations/image-url.php
page_generator_pro_shortcode_image_url
Filter the Image URL HTML output, before returning.
/includes/admin/integrations/pagebuilders.php
page_generator_pro_groups_add_post_type_templates
Filter the Post Type Templates to register on Page Builders.
/includes/admin/integrations/wikipedia.php
page_generator_pro_shortcode_wikipedia
Filter the Wikipedia Shortcode HTML output, before returning.
page_generator_pro_wikipedia_get_languages
Defines available Wikipedia languages.
/includes/admin/ajax.php
page_generator_pro_ajax_delete_generated_count_number_of_items
/includes/admin/api.php
page_generator_pro_api_get_timeout
Defines the maximum time to allow the API request to run.
page_generator_pro_api_get_backoff_time
Returns the number of seconds to pause before attempting a request again when the first request returned a 429 rate limit reached.
/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 output for a table column in the Groups: Content 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_content_settings_before
Modify the Group's settings prior to starting the generation routine. Changes made only affect this item in the generation set, and are not persistent or saved. For Gutenberg and Page Builders with Blocks / Elements registered by this Plugin, this is a good time to convert JSON encoded strings into arrays/objects that can be iterated for better Keyword/Spintax detection.
page_generator_pro_generate_content_settings
Modify the Group's settings prior to parsing shortcodes and building the Post Arguments to use for generating a single Page, Post or Custom Post Type. Changes made only affect this item in the generation set, and are not persistent or saved. For Gutenberg and Page Builders with Blocks / Elements registered by this Plugin, this is a good time to convert them to a Shortcode Block / Element / Text
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_get_keywords_terms
Returns an array of keyword and term key / value pairs, before any search or replacement arrays are built.
page_generator_pro_generate_replace_keywords_in_array
Perform any other keyword replacements or string processing.
page_generator_pro_generate_remove_content_from_settings_ignored_keys
Defines Post Content related Meta Keys to remove from the Content Group's Settings, so that they are not processed and not copied to the existing Generated Page, as the Content Group's Overwrite Settings disable overwriting of content
page_generator_pro_generate_process_shortcodes_in_array
Filter to allow registering and processing shortcodes on a string.
page_generator_pro_generate_featured_image_ settingsfeatured_image_source
Defines the Featured Image for the given generated Post ID, if the Group Settings specify a Featured Image and (if overwriting) the Featured Image should be overwritten
page_generator_pro_generate_set_post_meta_ignored_keys
Defines Post Meta Keys in a Content Group to ignore and not copy to generated Posts / Groups.
page_generator_pro_generate_set_post_meta_ meta_key
Filters the Group Metadata for the given Key and Value, immediately before it's saved to the Generated Page.
page_generator_pro_generate_set_term_meta_ignored_keys
Defines Term Meta Keys in a Term Group to ignore and not copy to generated Terms / Groups.
page_generator_pro_generate_set_term_meta_ meta_key
Filters the Group Metadata for the given Key and Value, immediately before it's saved to the Generated Term.
page_generator_pro_generate_should_process_shortcodes_on_post_content
Flag whether the given Group should process shortcodes on the main Post Content (i.e. $post->post_content).
page_generator_pro_generate_comment_args
Filters arguments used for creating a Comment when running content generation for a specific Group ID and Post ID
/includes/admin/traits/featured-image-trait.php
page_generator_pro_featured_image_trait_get_featured_image_fields
/includes/admin/traits/shortcode-image-trait.php
page_generator_pro_shortcode_image_get_image_html
Filter the image HTML output, before returning.
/includes/admin/traits/shortcode-trait.php
page_generator_pro_shortcode_get_modal_dimensions
Sets the dimensions of TinyMCE and Quicktag modals for the given shortcode.
/includes/admin/keywords.php
page_generator_pro_keywords_register_sources
Register a Keyword Source.
page_generator_pro_keywords_refresh_terms_ keywordsource
Refresh the given Keyword's Columns and Terms by fetching them from the database immediately before starting generation.
page_generator_pro_keywords_validate_ datasource
Runs validation tests specific to this source for a Keyword immediately before it's saved to the database.
/includes/admin/admin.php
page_generator_pro_admin_body_class
Registers screen names that should add the wpzinc class to the tag
page_generator_pro_admin_admin_menu_minimum_capability
Defines the minimum capability required to access the Page Generator Pro Menu and Sub Menus
page_generator_pro_setting_panel
Filters the available panels / sections on the settings screen.
page_generator_pro_keywords_save_ source
Define the Keyword properties (data, delimiter and columns) for the given Source before saving the Keyword to the database.
/includes/admin/install.php
page_generator_pro_install_copy_mu_plugin
Enable automatic copying of the Must-Use Plugin each time Page Generator Pro is updated to a newer version.
/includes/admin/research.php
page_generator_pro_research_get_providers
Defines the available research providers supported by this Plugin
page_generator_pro_research_get_providers_settings_fields
Defines each spintax provider's settings to display at Settings > Research
page_generator_pro_research_research_ provider
Research content through the research provider for the given topic.
page_generator_pro_research_get_status_ provider
Get status of a research request for the research provider for the given article ID.
/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_settings_remove_orphaned_settings
Remove any orphaned data, such as Page Builder, SEO or Schema metadata, from the Group before generation is run, that might remain due to changing Page Builder, SEO or Schema Plugin.
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_ meta_key
Filters the Group Metadata for the given Key and Value
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.
page_generator_pro_groups_get_group_statuses
Defines available Post Statuses for generated content.
page_generator_pro_groups_duplicate_ignored_keys
Defines Post Meta Keys in a Content Group to ignore and not copy to generated Posts / Groups.
page_generator_pro_groups_generates_content
Determine if the given Content Group is eligible to generate content
/includes/admin/notices.php
page_generator_pro_notices_get_success_notices
Filters the success notices to return.
page_generator_pro_notices_get_warning_notices
Filters the error 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/editor.php
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_editor_get_tinymce_plugins
Returns an array of TinyMCE Plugins that aren't shortcodes/blocks, such as Autocomplete and Generate Spintax from Selected Text
page_generator_pro_editor_should_register_tinymce_plugins
Set a flag to denote whether we should register TinyMCE Plugins
/includes/class-page-generator-pro.php
page_generator_pro_is_admin_or_frontend_editor
Filters whether the current request is a WordPress Administration / Frontend Editor request or not. Page Builders can set this to true to allow Media Library Organizer and its Addons to load its functionality.
/includes/global/posttype.php
page_generator_pro_posttype_register_post_types
Filter the arguments for registering the Content Groups Post Type
page_generator_pro_posttype_supports
Define the supported features for Content Groups
/includes/global/common.php
page_generator_pro_common_get_generation_systems
Defines available Generation Systems
page_generator_pro_common_get_generation_results
Defines available Generation Results
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_all_user_ids
Defines available user IDs.
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_content_overwrite_sections
Defines available content overwrite sections.
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_autocomplete_configuration
Define autocompleters to use across Content Groups, Term Group and TinyMCE If false, autocomplete fields are for Related Links shortcode on a Page or Post.
page_generator_pro_common_get_autocomplete_enabled_fields
Defines an array of Javascript DOM selectors to enable the keyword autocomplete functionality on. If false, autocomplete fields are for Related Links shortcode on a Page or Post.
page_generator_pro_common_get_selectize_enabled_fields
Defines an array of Javascript DOM selectors to enable the selectize functionality on.
page_generator_pro_common_get_link_target_options
Defines target 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
Backward compat. filter. 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_locations_output_types_street_names
Defines available Street Names output types for Generate Locations.
page_generator_pro_common_get_locations_output_types_zipcodes
Defines available ZIP Code output types for Generate Locations.
page_generator_pro_common_get_locations_output_types_zipcode_districts
Defines available Zip Code Districts output types for Generate Locations.
page_generator_pro_common_get_locations_output_types_cities
Defines available Cities output types for Generate Locations.
page_generator_pro_common_get_locations_output_types_counties
Defines available Counties output types for Generate Locations.
page_generator_pro_common_get_locations_output_types_regions
Defines available Regions output types for Generate Locations.
page_generator_pro_common_get_phone_area_output_types
Defines available output types for Generate Phone Area Codes.
/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/frontend.php
page_generator_pro_frontend_filter_site_title
Modifies the Site Title immediately prior to it being output
page_generator_pro_frontend_filter_post_title
Modifies the Post Title immediately prior to it being output
page_generator_pro_frontend_filter_post_excerpt
Modifies the Post Excerpt immediately prior to it being output
page_generator_pro_frontend_filter_post_content
Modifies the Post Content immediately prior to it being output
/includes/global/spintax.php
page_generator_pro_spintax_get_providers
Defines the available spintax providers supported by this Plugin
page_generator_pro_spintax_get_providers_settings_fields
Defines each spintax provider's settings to display at Settings > Spintax
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/global/integrations/gutenberg.php
page_generator_pro_gutenberg_add_block_categories
Adds block categories to the default Gutenberg Block Categories
/includes/global/shortcodes/shortcode-research.php
page_generator_pro_shortcode_research_get_attributes_ provider
page_generator_pro_shortcode_research_get_fields_ provider
page_generator_pro_shortcode_research_get_tabs_ provider
page_generator_pro_shortcode_research_get_default_values_ provider
/includes/global/shortcodes/shortcode-related-links.php
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_related_links_get_excerpt
Filters the dynamic {excerpt} replacement, when a Post's status is being built.
/includes/global/shortcodes/shortcode-google-map.php
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.
/includes/global/shortcodes/shortcode-open-street-map.php
page_generator_pro_shortcode_open_street_map
Filter the Open Street Maps HTML output, before returning.
/includes/global/screen.php
page_generator_pro_screen_get_current_screen_before
Returns an array comprising of a simplified screen and section that we are viewing within the WordPress Administration interface, before we've performed any checks. This is useful for frontend Page Builders and AJAX requests where get_current_screen() below won't return anything.
page_generator_pro_screen_get_current_screen
Returns an array comprising of a simplified screen and section that we are viewing within the WordPress Administration interface.
/includes/global/shortcode.php
page_generator_pro_shortcode_add_shortcodes
page_generator_pro_shortcode_add_shortcodes_outside_of_content_groups
page_generator_pro_shortcode_get_css_prefix
Returns the CSS prefix to use.
page_generator_pro_groups_ui_output_add_new_buttons
/includes/admin/groups-ui.php::141
Overview
Registers buttons to be displayed in the WP_List_Table filters, which will be moved by JS to display next to the Add New button
Parameters
Parameter
Type
Description
Buttons.
array $buttons
N/A
Usage
add_filter( 'page_generator_pro_groups_ui_output_add_new_buttons', function( $buttons ) {
// ... your code here
// Return value
return $buttons;
}, 10, 1 );
page_generator_pro_groups_ui_remove_meta_boxes
/includes/admin/groups-ui.php::654
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_common_get_featured_image_sources
/includes/admin/groups-ui.php::1151
Overview
Defines available Featured Image sources.
Parameters
Parameter
Type
Description
$featured_image_sources
array
Featured Image Sources.
$settings
array
Group Settings.
Usage
add_filter( 'page_generator_pro_common_get_featured_image_sources', function( $featured_image_sources, $settings ) {
// ... your code here
// Return value
return $featured_image_sources;
}, 10, 2 );
page_generator_pro_common_get_featured_image_tabs
/includes/admin/groups-ui.php::1161
Overview
Defines available Featured Image tabs.
Parameters
Parameter
Type
Description
$featured_image_tabs
array
Featured Image Tabs.
$settings
array
Group Settings.
Usage
add_filter( 'page_generator_pro_common_get_featured_image_tabs', function( $featured_image_tabs, $settings ) {
// ... your code here
// Return value
return $featured_image_tabs;
}, 10, 2 );
page_generator_pro_common_get_featured_image_fields
/includes/admin/groups-ui.php::1171
Overview
Defines available Featured Image fields.
Parameters
Parameter
Type
Description
$featured_image_fields
array
Featured Image Sources.
$settings
array
Group Settings.
Usage
add_filter( 'page_generator_pro_common_get_featured_image_fields', function( $featured_image_fields, $settings ) {
// ... your code here
// Return value
return $featured_image_fields;
}, 10, 2 );
page_generator_pro_groups_ui_get_titles_and_messages
/includes/admin/groups-ui.php::1369
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_groups_ui_get_post_type_conditional_metaboxes
/includes/admin/groups-ui.php::1405
Overview
Define conditional metaboxes that should only display based on the value of Publish > Post Type in the Content Groups UI. For example, array( 'metabox_id' => array( 'post_type_to_display_metabox_on', 'another_post_type_to_display_metabox_on' ) )
Parameters
Parameter
Type
Description
$conditional_metaboxes
array
Metabox ID Keys and Post Type Values array.
Usage
add_filter( 'page_generator_pro_groups_ui_get_post_type_conditional_metaboxes', function( $conditional_metaboxes ) {
// ... your code here
// Return value
return $conditional_metaboxes;
}, 10, 1 );
page_generator_pro_groups_terms_ui_get_titles_and_messages
/includes/admin/groups-terms-ui.php::488
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_integrations_get
/includes/admin/integrations.php::57
Overview
Return available integrations supported by this class.
Parameters
Parameter
Type
Description
$integrations
array
Integrations.
Usage
add_filter( 'page_generator_pro_integrations_get', function( $integrations ) {
// ... your code here
// Return value
return $integrations;
}, 10, 1 );
page_generator_pro_integrations_get_settings_fields
/includes/admin/integrations.php::85
Overview
Defines each integration's settings to display at Settings > Integrations
Parameters
Parameter
Type
Description
$settings_fields
array
Settings Fields.
Usage
add_filter( 'page_generator_pro_integrations_get_settings_fields', function( $settings_fields ) {
// ... your code here
// Return value
return $settings_fields;
}, 10, 1 );
page_generator_pro_log_get_filters
/includes/admin/log.php::400
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( 'page_generator_pro_log_get_filters', function( $filters ) {
// ... your code here
// Return value
return $filters;
}, 10, 1 );
page_generator_pro_groups_directory_get_related_links_heading
/includes/admin/groups-directory.php::1200
Overview
Defines the header to display before the Related Links shortcode when Content Groups are generated through the Groups Directory functionality.
Parameters
Parameter
Type
Description
$html
string
HTML Markup for Heading
$heading
string
Heading Text without HTML
Usage
add_filter( 'page_generator_pro_groups_directory_get_related_links_heading', function( $html, $heading ) {
// ... your code here
// Return value
return $html;
}, 10, 2 );
page_generator_pro_groups_directory_get_related_links_shortcode
/includes/admin/groups-directory.php::1231
Overview
Defines the Related Links Shortcode to use when a Content Group is generated through the Groups Directory functionality.
Parameters
Parameter
Type
Description
$shortcode
string
Shortcode.
$group_id
int
Group ID.
$parent_slug
string
Parent Slug.
Usage
add_filter( 'page_generator_pro_groups_directory_get_related_links_shortcode', function( $shortcode, $group_id, $parent_slug ) {
// ... your code here
// Return value
return $shortcode;
}, 10, 3 );
page_generator_pro_geo_get_phone_area_code_countries
/includes/admin/phone-area-codes.php::173
Overview
Filters the supported countries for generating phone area codes.
Parameters
Parameter
Type
Description
$countries
array
Countries.
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/phone-area-codes.php::228
Overview
Filters the supported countries for generating phone area codes.
Parameters
Parameter
Type
Description
$countries
array
Countries.
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_maybe_remove_custom_fields_meta_box_meta_keys
/includes/admin/performance.php::88
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_performance_replace_customizer_page_dropdowns
/includes/admin/performance.php::266
Overview
Defines an array of Customizer Page Dropdown Controls that should be replaced with either an AJAX or ID for performance
Parameters
Parameter
Type
Description
$controls
array
Names of Controls to replace.
$customizer
WP_Customize_Manager
Customizer Manager.
Usage
add_filter( 'page_generator_pro_performance_replace_customizer_page_dropdowns', function( $controls, $customizer ) {
// ... your code here
// Return value
return $controls;
}, 10, 2 );
page_generator_pro_groups_terms_get_defaults
/includes/admin/groups-terms.php::132
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::186
Overview
Filters the Groups to return.
Parameters
Parameter
Type
Description
$groups_arr
array
Groups.
$groups
WP_Term_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_all_ids_names
/includes/admin/groups-terms.php::229
Overview
Filters the Groups to return.
Parameters
Parameter
Type
Description
$groups_arr
array
Groups.
$groups
WP_Term_Query
Groups Query.
Usage
add_filter( 'page_generator_pro_groups_terms_get_all_ids_names', 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::323
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::345
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::461
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::526
Overview
Define an optional success message based on the result of a custom row action on a Group.
Parameters
Parameter
Type
Description
$message
bool|string
Success Message.
$result
WP_Error|bool|string
Result.
$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::621
Overview
Performs several validations on the given Group Settings, to ensure that content generation will function successfully.
Parameters
Parameter
Type
Description
$result
WP_Error|bool
Validation Result.
$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_shortcode_yelp
/includes/admin/integrations/yelp.php::697
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_creative_commons
/includes/admin/integrations/creative-commons.php::328
Overview
Filter the Creative Commons HTML output, before returning.
Parameters
Parameter
Type
Description
$html
string
HTML Output.
$atts
array
Shortcode Attributes.
$image_id
bool|int
WordPress Media Library Image ID (false = not imported into Media Library as copy=0).
$images
array
Creative Commons Image Results.
$image
array
Creative Commons Image chosen at random and imported into the Media Library.
Usage
add_filter( 'page_generator_pro_shortcode_creative_commons', function( $html, $atts, $image_id, $images, $image ) {
// ... your code here
// Return value
return $html;
}, 10, 5 );
page_generator_pro_creative_commons_photos_search_args
/includes/admin/integrations/creative-commons.php::705
Overview
Filters the API arguments to send to the Creative Commons /images endpoint
Parameters
Parameter
Type
Description
$args
array
API arguments.
$query
string
Search Term(s).
$orientation
bool|array
Image Orientation (false, tall, wide, square).
$per_page
int
Number of Images to Return.
$page
int
Pagination Page Offset.
Usage
add_filter( 'page_generator_pro_creative_commons_photos_search_args', function( $args, $query, $orientation, $per_page, $page ) {
// ... your code here
// Return value
return $args;
}, 10, 5 );
page_generator_pro_shortcode_midjourney_image
/includes/admin/integrations/midjourney.php::372
Overview
Filter the Midjourney HTML output, before returning.
Parameters
Parameter
Type
Description
$html
string
HTML Output.
$atts
array
Shortcode Attributes.
$image_id
bool|int
WordPress Media Library Image ID.
$result
stdClass
ImagineAPI Image Result.
Usage
add_filter( 'page_generator_pro_shortcode_midjourney_image', function( $html, $atts, $image_id, $result ) {
// ... your code here
// Return value
return $html;
}, 10, 4 );
page_generator_pro_shortcode_open_weather_map
/includes/admin/integrations/open-weather-map.php::387
Overview
Filter the Open Weather 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_weather_map', function( $html, $atts ) {
// ... your code here
// Return value
return $html;
}, 10, 2 );
page_generator_pro_shortcode_openai_image
/includes/admin/integrations/openai-image.php::356
Overview
Filter the OpenAI HTML output, before returning.
Parameters
Parameter
Type
Description
$html
string
HTML Output.
$atts
array
Shortcode Attributes.
$image_id
bool|int
WordPress Media Library Image ID.
$result
stdClass
OpenAI Image Result.
Usage
add_filter( 'page_generator_pro_shortcode_openai_image', function( $html, $atts, $image_id, $result ) {
// ... your code here
// Return value
return $html;
}, 10, 4 );
page_generator_pro_shortcode_media_library
/includes/admin/integrations/media-library.php::701
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_media_library_get_random_image_html_tag_query
/includes/admin/integrations/media-library.php::848
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/integrations/media-library.php::858
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/integrations/media-library.php::895
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.
$query
array
WHERE query clauses.
Usage
add_filter( 'page_generator_pro_media_library_get_random_image_id', function( $image_id, $args, $images, $query ) {
// ... your code here
// Return value
return $image_id;
}, 10, 4 );
page_generator_pro_media_library_get_random_image_html_tag
/includes/admin/integrations/media-library.php::934
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.
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_acf_match_content_group_location_rule
/includes/admin/integrations/acf.php::271
Parameters
Parameter
Type
Description
$rule_matches
Unknown
N/A
$rule
Unknown
N/A
$options
Unknown
N/A
$field_group
Unknown
N/A
Usage
add_filter( 'page_generator_pro_acf_match_content_group_location_rule', function( $rule_matches, $rule, $options, $field_group ) {
// ... your code here
// Return value
return $rule_matches;
}, 10, 4 );
page_generator_pro_acf_match_term_group_location_rule
/includes/admin/integrations/acf.php::342
Parameters
Parameter
Type
Description
$rule_matches
Unknown
N/A
$rule
Unknown
N/A
$options
Unknown
N/A
$field_group
Unknown
N/A
$term_id
Unknown
N/A
Usage
add_filter( 'page_generator_pro_acf_match_term_group_location_rule', function( $rule_matches, $rule, $options, $field_group, $term_id ) {
// ... your code here
// Return value
return $rule_matches;
}, 10, 5 );
page_generator_pro_shortcode_pixabay
/includes/admin/integrations/pixabay.php::429
Overview
Filter the Pixabay HTML output, before returning.
Parameters
Parameter
Type
Description
$html
string
HTML Output.
$atts
array
Shortcode Attributes.
$image_id
bool|int
WordPress Media Library Image ID (false = not imported into Media Library as copy=0).
$images
array
Pixabay Image Results.
$image
array
Pixabay Image chosen at random and imported into the Media Library.
Usage
add_filter( 'page_generator_pro_shortcode_pixabay', function( $html, $atts, $image_id, $images, $image ) {
// ... your code here
// Return value
return $html;
}, 10, 5 );
page_generator_pro_pixabay_photos_search_args
/includes/admin/integrations/pixabay.php::944
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 ).
Image
bool|string $category
Category
$min_width
int
Minimum Image Width.
$min_height
int
Minimum Image Height.
Color
bool|string $color
(
$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_shortcode_wikipedia_image
/includes/admin/integrations/wikipedia-image.php::337
Overview
Filter the Wikipedia Image HTML output, before returning.
Parameters
Parameter
Type
Description
$html
string
HTML Output.
$atts
array
Shortcode Attributes.
$image_id
bool|int
WordPress Media Library Image ID (false = not imported into Media Library as copy=0).
$images
array
Wikipedia Image Results.
$image
array
Wikipedia Image chosen at random and imported into the Media Library.
Usage
add_filter( 'page_generator_pro_shortcode_wikipedia_image', function( $html, $atts, $image_id, $images, $image ) {
// ... your code here
// Return value
return $html;
}, 10, 5 );
page_generator_pro_wikipedia_get_languages
/includes/admin/integrations/wikipedia-image.php::919
Overview
Defines available Wikipedia languages.
Parameters
Parameter
Type
Description
$output_types
array
Output Types.
Usage
add_filter( 'page_generator_pro_wikipedia_get_languages', function( $languages ) {
// ... your code here
// Return value
return $languages;
}, 10, 1 );
page_generator_pro_shortcode_pexels
/includes/admin/integrations/pexels.php::332
Overview
Filter the Pexels HTML output, before returning.
Parameters
Parameter
Type
Description
$html
string
HTML Output.
$atts
array
Shortcode Attributes.
$image_id
bool|int
WordPress Media Library Image ID (false = not imported into Media Library as copy=0).
$images
array
Pexels Image Results.
$image
array
Pixabay Image chosen at random and imported into the Media Library.
Usage
add_filter( 'page_generator_pro_shortcode_pexels', function( $html, $atts, $image_id, $images, $image ) {
// ... your code here
// Return value
return $html;
}, 10, 5 );
page_generator_pro_pexels_photos_search_args
/includes/admin/integrations/pexels.php::618
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).
$orientation
bool|array
Image Orientation (false, portrait, landscape).
$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_pagebuilders_register_wpbakery_page_builder_support_roles
/includes/admin/integrations/wpbakery-page-builder.php::90
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_shortcode_youtube
/includes/admin/integrations/youtube.php::372
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_pagebuilders_register_avia_layout_builder_support
/includes/admin/integrations/avia.php::109
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 Boxes.
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_shortcode_image_url
/includes/admin/integrations/image-url.php::242
Overview
Filter the Image URL HTML output, before returning.
Parameters
Parameter
Type
Description
$html
string
HTML Output.
$atts
array
Shortcode Attributes.
$image_id
int
WordPress Media Library Image ID.
Usage
add_filter( 'page_generator_pro_shortcode_image_url', function( $html, $atts, $image_id ) {
// ... your code here
// Return value
return $html;
}, 10, 3 );
page_generator_pro_groups_add_post_type_templates
/includes/admin/integrations/pagebuilders.php::85
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_shortcode_wikipedia
/includes/admin/integrations/wikipedia.php::458
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.
$elements
array
Wikipedia Elements in Wikipedia Article based on $atts.
Usage
add_filter( 'page_generator_pro_shortcode_wikipedia', function( $html, $atts, $content, $elements ) {
// ... your code here
// Return value
return $html;
}, 10, 4 );
page_generator_pro_wikipedia_get_languages
/includes/admin/integrations/wikipedia.php::1437
Overview
Defines available Wikipedia languages.
Parameters
Parameter
Type
Description
$output_types
array
Output Types.
Usage
add_filter( 'page_generator_pro_wikipedia_get_languages', function( $languages ) {
// ... your code here
// Return value
return $languages;
}, 10, 1 );
page_generator_pro_ajax_delete_generated_count_number_of_items
/includes/admin/ajax.php::101
Parameters
Parameter
Type
Description
$limit
Unknown
N/A
Usage
add_filter( 'page_generator_pro_ajax_delete_generated_count_number_of_items', function( $limit ) {
// ... your code here
// Return value
return $limit;
}, 10, 1 );
page_generator_pro_api_get_timeout
/includes/admin/api.php::236
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_get_timeout', function( $timeout ) {
// ... your code here
// Return value
return $timeout;
}, 10, 1 );
page_generator_pro_api_get_backoff_time
/includes/admin/api.php::264
Overview
Returns the number of seconds to pause before attempting a request again when the first request returned a 429 rate limit reached.
Parameters
Parameter
Type
Description
$pause
int
Pause, in seconds
Usage
add_filter( 'page_generator_pro_api_get_backoff_time', function( $pause ) {
// ... your code here
// Return value
return $pause;
}, 10, 1 );
page_generator_pro_groups_terms_table_register_bulk_actions
/includes/admin/groups-terms-table.php::100
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
array
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::280
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::387
Overview
Filters the output for a non-standard column on the Groups: Terms WP_List_Table.
Parameters
Parameter
Type
Description
$column_name
string
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::434
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::101
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
array
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::316
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::442
Overview
Define items to output for a table column in the Groups: Content WP_List_Table.
Parameters
Parameter
Type
Description
$items
array
HTML Item(s) to output in the column.
$column_name
string
Column Name.
$post_id
int
Group ID.
$settings
array
Group Settings.
Usage
add_filter( 'page_generator_pro_groups_table_admin_columns_output', function( $items, $column_name, $post_id, $settings ) {
// ... your code here
// Return value
return $items;
}, 10, 4 );
page_generator_pro_groups_table_admin_row_actions
/includes/admin/groups-table.php::483
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_content_settings_before
/includes/admin/generate.php::612
Overview
Modify the Group's settings prior to starting the generation routine. Changes made only affect this item in the generation set, and are not persistent or saved. For Gutenberg and Page Builders with Blocks / Elements registered by this Plugin, this is a good time to convert JSON encoded strings into arrays/objects that can be iterated for better Keyword/Spintax detection.
Parameters
Parameter
Type
Description
$settings
array
Group Settings.
$group_id
int
Group ID.
$index
int
Keyword Index.
$test_mode
bool
Test Mode.
Usage
add_filter( 'page_generator_pro_generate_content_settings_before', function( $settings, $group_id, $index, $test_mode ) {
// ... your code here
// Return value
return $settings;
}, 10, 4 );
page_generator_pro_generate_content_settings
/includes/admin/generate.php::912
Overview
Modify the Group's settings prior to parsing shortcodes and building the Post Arguments to use for generating a single Page, Post or Custom Post Type. Changes made only affect this item in the generation set, and are not persistent or saved. For Gutenberg and Page Builders with Blocks / Elements registered by this Plugin, this is a good time to convert them to a Shortcode Block / Element / Text
Parameters
Parameter
Type
Description
$settings
array
Group Settings.
$group_id
int
Group ID.
$index
int
Keyword Index.
$test_mode
bool
Test Mode.
Usage
add_filter( 'page_generator_pro_generate_content_settings', function( $settings, $group_id, $index, $test_mode ) {
// ... your code here
// Return value
return $settings;
}, 10, 4 );
page_generator_pro_generate_post_args
/includes/admin/generate.php::947
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::1382
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::2132
Overview
Filter to perform non-standard keyword transformation.
Parameters
Parameter
Type
Description
$term
string
Term.
$transformation
string
Keyword Transformation.
$keyword
string
Keyword.
Keyword
string|bool $column
Column.
Usage
add_filter( 'page_generator_pro_generate_generate_content_apply_keyword_transformation', function( $term, $keyword_transformation, $keyword, $column ) {
// ... your code here
// Return value
return $term;
}, 10, 4 );
page_generator_pro_generate_get_keywords_terms
/includes/admin/generate.php::2565
Overview
Returns an array of keyword and term key / value pairs, before any search or replacement arrays are built.
Parameters
Parameter
Type
Description
$keywords_terms
array
Keywords and Terms for this Page Generation.
$method
string
Generation Method.
$index
int
Generation Index.
Usage
add_filter( 'page_generator_pro_generate_get_keywords_terms', function( $keywords_terms, $method, $index ) {
// ... your code here
// Return value
return $keywords_terms;
}, 10, 3 );
page_generator_pro_generate_replace_keywords_in_array
/includes/admin/generate.php::2797
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_remove_content_from_settings_ignored_keys
/includes/admin/generate.php::2984
Overview
Defines Post Content related Meta Keys to remove from the Content Group's Settings, so that they are not processed and not copied to the existing Generated Page, as the Content Group's Overwrite Settings disable overwriting of content
Parameters
Parameter
Type
Description
$ignored_keys
array
Ignored Keys (preg_match() compatible regex expressions are supported).
$settings
array
Group Settings.
Usage
add_filter( 'page_generator_pro_generate_remove_content_from_settings_ignored_keys', function( $ignored_keys, $settings ) {
// ... your code here
// Return value
return $ignored_keys;
}, 10, 2 );
page_generator_pro_generate_process_shortcodes_in_array
/includes/admin/generate.php::3064
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_generate_featured_image_ settingsfeatured_image_source
/includes/admin/generate.php::3276
Overview
Defines the Featured Image for the given generated Post ID, if the Group Settings specify a Featured Image and (if overwriting) the Featured Image should be overwritten
Parameters
Parameter
Type
Description
$image_id
WP_Error|bool|int
Image ID.
$post_id
int
Generated Post ID.
$group_id
int
Group ID.
$index
int
Generation Index.
$settings
array
Group Settings.
$post_args
array
wp_insert_post() / wp_update_post() arguments.
Usage
add_filter( 'page_generator_pro_generate_featured_image_ settingsfeatured_image_source', function( false, $post_id, $group_id, $index, $settings, $post_args ) {
// ... your code here
// Return value
return false;
}, 10, 6 );
page_generator_pro_generate_set_post_meta_ignored_keys
/includes/admin/generate.php::3604
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 (preg_match() compatible regex expressions are supported).
$post_id
int
Generated Post ID.
$settings
array
Group Settings.
$post_args
array
wp_insert_post() / wp_update_post() arguments.
Usage
add_filter( 'page_generator_pro_generate_set_post_meta_ignored_keys', function( $ignored_keys, $post_id, $settings, $post_args ) {
// ... your code here
// Return value
return $ignored_keys;
}, 10, 4 );
page_generator_pro_generate_set_post_meta_ meta_key
/includes/admin/generate.php::3640
Overview
Filters the Group Metadata for the given Key and Value, immediately before it's saved to the Generated Page.
Parameters
Parameter
Type
Description
$meta_value
array|string|int|bool
Meta
$post_id
int
Generated Post ID.
$group_id
int
Group ID.
$settings
array
Group Settings.
$post_args
array
wp_insert_post() / wp_update_post() arguments.
Usage
add_filter( 'page_generator_pro_generate_set_post_meta_ meta_key', function( $meta_value, $post_id, $group_id, $settings, $post_args ) {
// ... your code here
// Return value
return $meta_value;
}, 10, 5 );
page_generator_pro_generate_set_term_meta_ignored_keys
/includes/admin/generate.php::3697
Overview
Defines Term Meta Keys in a Term Group to ignore and not copy to generated Terms / Groups.
Parameters
Parameter
Type
Description
$ignored_keys
array
Ignored Keys (preg_match() compatible regex expressions are supported).
$term_id
int
Generated Term ID.
$settings
array
Group Settings.
$term_args
array
wp_insert_term() / wp_update_term() arguments.
Usage
add_filter( 'page_generator_pro_generate_set_term_meta_ignored_keys', function( $ignored_keys, $term_id, $settings, $term_args ) {
// ... your code here
// Return value
return $ignored_keys;
}, 10, 4 );
page_generator_pro_generate_set_term_meta_ meta_key
/includes/admin/generate.php::3729
Overview
Filters the Group Metadata for the given Key and Value, immediately before it's saved to the Generated Term.
Parameters
Parameter
Type
Description
$value
array|string|int|object
Meta Value.
Usage
add_filter( 'page_generator_pro_generate_set_term_meta_ meta_key', function( $meta_value ) {
// ... your code here
// Return value
return $meta_value;
}, 10, 1 );
page_generator_pro_generate_should_process_shortcodes_on_post_content
/includes/admin/generate.php::4090
Overview
Flag whether the given Group should process shortcodes on the main Post Content (i.e. $post->post_content).
Parameters
Parameter
Type
Description
$process
bool
Process Shortcodes on Post Content.
$settings
array
Group Settings.
Usage
add_filter( 'page_generator_pro_generate_should_process_shortcodes_on_post_content', function( $process, $settings ) {
// ... your code here
// Return value
return $process;
}, 10, 2 ); Overview
Filters arguments used for creating a Comment when running content generation for a specific Group ID and Post ID
Parameters
Parameter
Type
Description
$comment_args
array
wp_insert_comment() compatible arguments.
$settings
array
Content Group's Comment Settings.
Usage
add_filter( 'page_generator_pro_generate_comment_args', function( $comment_args, $settings ) {
// ... your code here
// Return value
return $comment_args;
}, 10, 2 );
page_generator_pro_featured_image_trait_get_featured_image_fields
/includes/admin/traits/featured-image-trait.php::109
Parameters
Parameter
Type
Description
$fields
Unknown
N/A
$group_settings
Unknown
N/A
Usage
add_filter( 'page_generator_pro_featured_image_trait_get_featured_image_fields', function( $fields, $group_settings ) {
// ... your code here
// Return value
return $fields;
}, 10, 2 );
page_generator_pro_shortcode_image_get_image_html
/includes/admin/traits/shortcode-image-trait.php::272
Overview
Filter the image HTML output, before returning.
Parameters
Parameter
Type
Description
$html
string
HTML Output.
$atts
array
Shortcode Attributes.
$image_id
int
WordPress Media Library Image ID.
$image
array
Third Party Image Data.
Usage
add_filter( 'page_generator_pro_shortcode_image_get_image_html', function( $html, $atts, $image_id, $image ) {
// ... your code here
// Return value
return $html;
}, 10, 4 );
page_generator_pro_shortcode_get_modal_dimensions
/includes/admin/traits/shortcode-trait.php::249
Overview
Sets the dimensions of TinyMCE and Quicktag modals for the given shortcode.
Parameters
Parameter
Type
Description
$dimensions
array
Dimensions
$shortcode
string
Shortcode.
Usage
add_filter( 'page_generator_pro_shortcode_get_modal_dimensions', function( $dimensions, $get_name( ) {
// ... your code here
// Return value
return $dimensions;
}, 10, 2 );
page_generator_pro_keywords_register_sources
/includes/admin/keywords.php::315
Overview
Register a Keyword Source.
Parameters
Parameter
Type
Description
$sources
array
Keyword Sources.
Usage
add_filter( 'page_generator_pro_keywords_register_sources', function( $sources ) {
// ... your code here
// Return value
return $sources;
}, 10, 1 );
page_generator_pro_keywords_refresh_terms_ keywordsource
/includes/admin/keywords.php::375
Overview
Refresh the given Keyword's Columns and Terms by fetching them from the database immediately before starting generation.
Parameters
Parameter
Type
Description
$terms
WP_Error|array
Terms.
$keyword
array
Keyword.
Usage
add_filter( 'page_generator_pro_keywords_refresh_terms_ keywordsource', function( array( ) {
// ... your code here
// Return value
return array(;
}, 10, 1 );
page_generator_pro_keywords_validate_ datasource
/includes/admin/keywords.php::1697
Overview
Runs validation tests specific to this source for a Keyword immediately before it's saved to the database.
Parameters
Parameter
Type
Description
$result
bool
Validation Result.
$data
array
Keyword.
$id
int
ID (if set, editing an existing Keyword).
Usage
add_filter( 'page_generator_pro_keywords_validate_ datasource', function( $result, $data, $id ) {
// ... your code here
// Return value
return $result;
}, 10, 3 );
page_generator_pro_admin_body_class
/includes/admin/admin.php::183
Overview
Registers screen names that should add the wpzinc class to the
tagParameters
Parameter
Type
Description
$screens
array
Screen Names.
Usage
add_filter( 'page_generator_pro_admin_body_class', function( $screens ) {
// ... your code here
// Return value
return $screens;
}, 10, 1 ); Overview
Defines the minimum capability required to access the Page Generator Pro Menu and Sub Menus
Parameters
Parameter
Type
Description
$capability
string
Minimum Required Capability.
Usage
add_filter( 'page_generator_pro_admin_admin_menu_minimum_capability', function( $minimum_capability ) {
// ... your code here
// Return value
return $minimum_capability;
}, 10, 1 );
page_generator_pro_setting_panel
/includes/admin/admin.php::1429
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_keywords_save_ source
/includes/admin/admin.php::2192
Overview
Define the Keyword properties (data, delimiter and columns) for the given Source before saving the Keyword to the database.
Parameters
Parameter
Type
Description
$keyword
array
Keyword arguments.
Usage
add_filter( 'page_generator_pro_keywords_save_ source', function( $keyword ) {
// ... your code here
// Return value
return $keyword;
}, 10, 1 );
page_generator_pro_install_copy_mu_plugin
/includes/admin/install.php::361
Overview
Enable automatic copying of the Must-Use Plugin each time Page Generator Pro is updated to a newer version.
Parameters
Parameter
Type
Description
$copy_mu_plugin
bool
Copy MU Plugin.
Usage
add_filter( 'page_generator_pro_install_copy_mu_plugin', function( $copy_mu_plugin ) {
// ... your code here
// Return value
return $copy_mu_plugin;
}, 10, 1 );
page_generator_pro_research_get_providers
/includes/admin/research.php::60
Overview
Defines the available research providers supported by this Plugin
Parameters
Parameter
Type
Description
$providers
array
Research Service Providers.
Usage
add_filter( 'page_generator_pro_research_get_providers', function( $providers ) {
// ... your code here
// Return value
return $providers;
}, 10, 1 );
page_generator_pro_research_get_providers_settings_fields
/includes/admin/research.php::85
Overview
Defines each spintax provider's settings to display at Settings > Research
Parameters
Parameter
Type
Description
$settings
array
Research Providers Settings Fields.
Usage
add_filter( 'page_generator_pro_research_get_providers_settings_fields', function( $settings_fields ) {
// ... your code here
// Return value
return $settings_fields;
}, 10, 1 );
page_generator_pro_research_research_ provider
/includes/admin/research.php::130
Overview
Research content through the research provider for the given topic.
Parameters
Parameter
Type
Description
$topic
string
Topic.
$content_type
string
Content Type.
$limit
int
Word Limit.
$language
string
Language code.
$spintax
bool
Return as spintax.
$temperature
float
Temperature.
$top_p
float
Top P / Nucleus Sampling.
$presence_penalty
float
Presence Penalty.
$frequency_penalty
float
Frequency Penalty.
Usage
add_filter( 'page_generator_pro_research_research_ provider', function( $topic, $content_type, $limit, $language, $spintax, $temperature, $top_p, $presence_penalty, $frequency_penalty ) {
// ... your code here
// Return value
return $topic;
}, 10, 9 );
page_generator_pro_research_get_status_ provider
/includes/admin/research.php::157
Overview
Get status of a research request for the research provider for the given article ID.
Parameters
Parameter
Type
Description
$id
string
Article Key / ID on research service.
Usage
add_filter( 'page_generator_pro_research_get_status_ provider', function( $id ) {
// ... your code here
// Return value
return $id;
}, 10, 1 );
page_generator_pro_groups_get_defaults
/includes/admin/groups.php::185
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_settings_remove_orphaned_settings
/includes/admin/groups.php::269
Overview
Remove any orphaned data, such as Page Builder, SEO or Schema metadata, from the Group before generation is run, that might remain due to changing Page Builder, SEO or Schema Plugin.
Parameters
Parameter
Type
Description
$group
array
Group Settings.
Usage
add_filter( 'page_generator_pro_groups_get_settings_remove_orphaned_settings', function( $settings ) {
// ... your code here
// Return value
return $settings;
}, 10, 1 );
page_generator_pro_groups_get_post_meta_ignored_keys
/includes/admin/groups.php::317
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_ meta_key
/includes/admin/groups.php::338
Overview
Filters the Group Metadata for the given Key and Value
Parameters
Parameter
Type
Description
$value
array|string|bool|int
Meta Value.
Usage
add_filter( 'page_generator_pro_groups_get_post_meta_ meta_key', function( $value ) {
// ... your code here
// Return value
return $value;
}, 10, 1 );
page_generator_pro_groups_get_post_meta
/includes/admin/groups.php::352
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::404
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::468
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::683
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::761
Overview
Define an optional success message based on the result of a custom row action on a Group.
Parameters
Parameter
Type
Description
$message
bool|string
Success Message.
$result
WP_Error|bool|string
Result.
$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::992
Overview
Performs several validations on the given Group Settings, to ensure that content generation will function successfully.
Parameters
Parameter
Type
Description
$result
WP_Error|bool
Validation Result.
$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_groups_get_group_statuses
/includes/admin/groups.php::1024
Overview
Defines available Post Statuses for generated content.
Parameters
Parameter
Type
Description
$statuses
array
Statuses.
Usage
add_filter( 'page_generator_pro_groups_get_group_statuses', function( $statuses ) {
// ... your code here
// Return value
return $statuses;
}, 10, 1 );
page_generator_pro_groups_duplicate_ignored_keys
/includes/admin/groups.php::1269
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
Usage
add_filter( 'page_generator_pro_groups_duplicate_ignored_keys', function( $ignored_keys ) {
// ... your code here
// Return value
return $ignored_keys;
}, 10, 1 );
page_generator_pro_groups_generates_content
/includes/admin/groups.php::1462
Overview
Determine if the given Content Group is eligible to generate content
Parameters
Parameter
Type
Description
$can_generate_content
bool
Can Generate Content.
$id
int
Group ID.
Usage
add_filter( 'page_generator_pro_groups_generates_content', function( $can_generate_content, $id ) {
// ... your code here
// Return value
return $can_generate_content;
}, 10, 2 );
page_generator_pro_notices_get_success_notices
/includes/admin/notices.php::134
Overview
Filters the success notices to return.
Parameters
Parameter
Type
Description
$success_notices
array
Success Notices.
$all_notices
array
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_warning_notices
/includes/admin/notices.php::205
Overview
Filters the error notices to return.
Parameters
Parameter
Type
Description
$warning_notices
array
Warning Notices.
$all_notices
array
Success, Warning and Error Notices.
Usage
add_filter( 'page_generator_pro_notices_get_warning_notices', function( $warning_notices, $notices ) {
// ... your code here
// Return value
return $warning_notices;
}, 10, 2 );
page_generator_pro_notices_get_error_notices
/includes/admin/notices.php::268
Overview
Filters the error notices to return.
Parameters
Parameter
Type
Description
$error_notices
array
Error Notices.
$all_notices
array
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::325
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::369
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_editor_register_tinymce_plugins
/includes/admin/editor.php::283
Overview
Defines the TinyMCE Plugins to register
Parameters
Parameter
Type
Description
$plugins
array
TinyMCE Plugins.
$screen
array
Screen and Section.
$shortcodes
array
Shortcodes.
Usage
add_filter( 'page_generator_pro_editor_register_tinymce_plugins', function( $plugins, $screen, $shortcodes ) {
// ... your code here
// Return value
return $plugins;
}, 10, 3 );
page_generator_pro_editor_register_tinymce_buttons
/includes/admin/editor.php::374
Overview
Defines the TinyMCE Buttons to register
Parameters
Parameter
Type
Description
$plugins
array
TinyMCE Plugins.
$screen
array
Screen and Section.
$shortcodes
array
Shortcodes.
Usage
add_filter( 'page_generator_pro_editor_register_tinymce_buttons', function( $buttons, $screen, $shortcodes ) {
// ... your code here
// Return value
return $buttons;
}, 10, 3 );
page_generator_pro_editor_get_tinymce_plugins
/includes/admin/editor.php::467
Overview
Returns an array of TinyMCE Plugins that aren't shortcodes/blocks, such as Autocomplete and Generate Spintax from Selected Text
Parameters
Parameter
Type
Description
$plugins
array
TinyMCE Plugins
Usage
add_filter( 'page_generator_pro_editor_get_tinymce_plugins', function( $plugins ) {
// ... your code here
// Return value
return $plugins;
}, 10, 1 );
page_generator_pro_editor_should_register_tinymce_plugins
/includes/admin/editor.php::507
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_is_admin_or_frontend_editor
/includes/class-page-generator-pro.php::636
Overview
Filters whether the current request is a WordPress Administration / Frontend Editor request or not. Page Builders can set this to true to allow Media Library Organizer and its Addons to load its functionality.
Parameters
Parameter
Type
Description
$is_admin_or_frontend_editor
bool
Is WordPress Administration / Frontend Editor request.
$request
array
Sanitized request data.
Usage
add_filter( 'page_generator_pro_is_admin_or_frontend_editor', function( $is_admin_or_frontend_editor, $request ) {
// ... your code here
// Return value
return $is_admin_or_frontend_editor;
}, 10, 2 );
page_generator_pro_posttype_register_post_types
/includes/global/posttype.php::116
Overview
Filter the arguments for registering the Content Groups Post Type
Parameters
Parameter
Type
Description
register_post_type()
array $args
compatible
Usage
add_filter( 'page_generator_pro_posttype_register_post_types', function( $args ) {
// ... your code here
// Return value
return $args;
}, 10, 1 );
page_generator_pro_posttype_supports
/includes/global/posttype.php::199
Overview
Define the supported features for Content Groups
Parameters
Parameter
Type
Description
$supports
array
Supported Featured.
Usage
add_filter( 'page_generator_pro_posttype_supports', function( $supports ) {
// ... your code here
// Return value
return $supports;
}, 10, 1 );
page_generator_pro_common_get_generation_systems
/includes/global/common.php::63
Overview
Defines available Generation Systems
Parameters
Parameter
Type
Description
$systems
array
Generation Systems.
Usage
add_filter( 'page_generator_pro_common_get_generation_systems', function( $systems ) {
// ... your code here
// Return value
return $systems;
}, 10, 1 );
page_generator_pro_common_get_generation_results
/includes/global/common.php::92
Overview
Defines available Generation Results
Parameters
Parameter
Type
Description
$results
array
Generation Results.
Usage
add_filter( 'page_generator_pro_common_get_generation_results', function( $results ) {
// ... your code here
// Return value
return $results;
}, 10, 1 );
page_generator_pro_common_get_post_types
/includes/global/common.php::131
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::280
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::310
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::341
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::395
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::441
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::501
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::538
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::568
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_all_user_ids
/includes/global/common.php::599
Overview
Defines available user IDs.
Parameters
Parameter
Type
Description
$user_ids
array
User IDs.
Usage
add_filter( 'page_generator_pro_common_get_all_user_ids', function( $user_ids ) {
// ... your code here
// Return value
return $user_ids;
}, 10, 1 );
page_generator_pro_common_get_post_statuses
/includes/global/common.php::631
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::662
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::694
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::724
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::773
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_content_overwrite_sections
/includes/global/common.php::814
Overview
Defines available content overwrite sections.
Parameters
Parameter
Type
Description
$sections
array
Content Overwrite Sections
Usage
add_filter( 'page_generator_pro_common_get_content_overwrite_sections', function( $sections ) {
// ... your code here
// Return value
return $sections;
}, 10, 1 );
page_generator_pro_common_get_order_by_options
/includes/global/common.php::853
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::885
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::914
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::949
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::978
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_autocomplete_configuration
/includes/global/common.php::1042
Overview
Define autocompleters to use across Content Groups, Term Group and TinyMCE If false, autocomplete fields are for Related Links shortcode on a Page or Post.
Parameters
Parameter
Type
Description
$autocomplete_configuration
array
Autocomplete Configuration.
$is_group
bool
If true, autocomplete fields are for a Content or Term Group.
Usage
add_filter( 'page_generator_pro_common_get_autocomplete_configuration', function( $autocomplete_configuration, $is_group ) {
// ... your code here
// Return value
return $autocomplete_configuration;
}, 10, 2 );
page_generator_pro_common_get_autocomplete_enabled_fields
/includes/global/common.php::1098
Overview
Defines an array of Javascript DOM selectors to enable the keyword autocomplete functionality on. If false, autocomplete fields are for Related Links shortcode on a Page or Post.
Parameters
Parameter
Type
Description
$fields
array
Supported Fields.
$is_group
bool
If true, autocomplete fields are for a Content or Term Group.
Usage
add_filter( 'page_generator_pro_common_get_autocomplete_enabled_fields', function( $fields, $is_group ) {
// ... your code here
// Return value
return $fields;
}, 10, 2 );
page_generator_pro_common_get_selectize_enabled_fields
/includes/global/common.php::1151
Overview
Defines an array of Javascript DOM selectors to enable the selectize functionality on.
Parameters
Parameter
Type
Description
$fields
array
Supported Fields
Usage
add_filter( 'page_generator_pro_common_get_selectize_enabled_fields', function( $fields ) {
// ... your code here
// Return value
return $fields;
}, 10, 1 );
page_generator_pro_common_get_link_target_options
/includes/global/common.php::1203
Overview
Defines target options.
Parameters
Parameter
Type
Description
$targets
array
Link Target Options.
Usage
add_filter( 'page_generator_pro_common_get_link_target_options', function( $targets ) {
// ... your code here
// Return value
return $targets;
}, 10, 1 );
page_generator_pro_common_get_media_library_image_size_options
/includes/global/common.php::1232
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::1262
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::1292
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::1750
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::1810
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::1843
Overview
Backward compat. filter. 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::1852
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_locations_output_types_street_names
/includes/global/common.php::1880
Overview
Defines available Street Names 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_street_names', function( $output_types ) {
// ... your code here
// Return value
return $output_types;
}, 10, 1 );
page_generator_pro_common_get_locations_output_types_zipcodes
/includes/global/common.php::1910
Overview
Defines available ZIP Code 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_zipcodes', function( $output_types ) {
// ... your code here
// Return value
return $output_types;
}, 10, 1 );
page_generator_pro_common_get_locations_output_types_zipcode_districts
/includes/global/common.php::1938
Overview
Defines available Zip Code Districts 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_zipcode_districts', function( $output_types ) {
// ... your code here
// Return value
return $output_types;
}, 10, 1 );
page_generator_pro_common_get_locations_output_types_cities
/includes/global/common.php::1981
Overview
Defines available Cities 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_cities', function( $output_types ) {
// ... your code here
// Return value
return $output_types;
}, 10, 1 );
page_generator_pro_common_get_locations_output_types_counties
/includes/global/common.php::2012
Overview
Defines available Counties 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_counties', function( $output_types ) {
// ... your code here
// Return value
return $output_types;
}, 10, 1 );
page_generator_pro_common_get_locations_output_types_regions
/includes/global/common.php::2043
Overview
Defines available Regions 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_regions', 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::2073
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_get_settings
/includes/global/settings.php::102
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::137
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::168
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_frontend_filter_site_title
/includes/global/frontend.php::143
Overview
Modifies the Site Title immediately prior to it being output
Parameters
Parameter
Type
Description
$site_title
string
Site Title.
$sep
string
Title Separator.
$sep_location
string
Location of Title Separator (left|right).
Usage
add_filter( 'page_generator_pro_frontend_filter_site_title', function( $site_title, $sep, $sep_location ) {
// ... your code here
// Return value
return $site_title;
}, 10, 3 );
page_generator_pro_frontend_filter_post_title
/includes/global/frontend.php::174
Overview
Modifies the Post Title immediately prior to it being output
Parameters
Parameter
Type
Description
$post_title
string
Post Title.
$post_id
int
Post ID.
Usage
add_filter( 'page_generator_pro_frontend_filter_post_title', function( $post_title, $post_id ) {
// ... your code here
// Return value
return $post_title;
}, 10, 2 );
page_generator_pro_frontend_filter_post_excerpt
/includes/global/frontend.php::198
Overview
Modifies the Post Excerpt immediately prior to it being output
Parameters
Parameter
Type
Description
$post_excerpt
string
Post Excerpt.
Usage
add_filter( 'page_generator_pro_frontend_filter_post_excerpt', function( $post_excerpt ) {
// ... your code here
// Return value
return $post_excerpt;
}, 10, 1 );
page_generator_pro_frontend_filter_post_content
/includes/global/frontend.php::232
Overview
Modifies the Post Content immediately prior to it being output
Parameters
Parameter
Type
Description
$post_content
string
Post Content.
$post_id
int
Post ID.
Usage
add_filter( 'page_generator_pro_frontend_filter_post_content', function( $post_content, $post_id ) {
// ... your code here
// Return value
return $post_content;
}, 10, 2 );
page_generator_pro_spintax_get_providers
/includes/global/spintax.php::208
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_spintax_get_providers', function( $providers ) {
// ... your code here
// Return value
return $providers;
}, 10, 1 );
page_generator_pro_spintax_get_providers_settings_fields
/includes/global/spintax.php::233
Overview
Defines each spintax provider's settings to display at Settings > Spintax
Parameters
Parameter
Type
Description
$settings
array
Spintax Providers Settings Fields.
Usage
add_filter( 'page_generator_pro_spintax_get_providers_settings_fields', function( $settings_fields ) {
// ... your code here
// Return value
return $settings_fields;
}, 10, 1 );
page_generator_pro_spintax_add_spintax_ provider
/includes/global/spintax.php::278
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/global/spintax.php::298
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/global/spintax.php::452
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/global/spintax.php::1432
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_gutenberg_add_block_categories
/includes/global/integrations/gutenberg.php::85
Overview
Adds block categories to the default Gutenberg Block Categories
Parameters
Parameter
Type
Description
$categories
array
Block Categories.
WordPress
WP_Post $post
Post.
Usage
add_filter( 'page_generator_pro_gutenberg_add_block_categories', function( $categories, $post ) {
// ... your code here
// Return value
return $categories;
}, 10, 2 );
page_generator_pro_shortcode_research_get_attributes_ provider
/includes/global/shortcodes/shortcode-research.php::185
Parameters
Parameter
Type
Description
array(
Unknown
N/A
Usage
add_filter( 'page_generator_pro_shortcode_research_get_attributes_ provider', function( array( ) {
// ... your code here
// Return value
return array(;
}, 10, 1 );
page_generator_pro_shortcode_research_get_fields_ provider
/includes/global/shortcodes/shortcode-research.php::207
Parameters
Parameter
Type
Description
false
Unknown
N/A
Usage
add_filter( 'page_generator_pro_shortcode_research_get_fields_ provider', function( false ) {
// ... your code here
// Return value
return false;
}, 10, 1 );
page_generator_pro_shortcode_research_get_tabs_ provider
/includes/global/shortcodes/shortcode-research.php::229
Parameters
Parameter
Type
Description
array(
Unknown
N/A
Usage
add_filter( 'page_generator_pro_shortcode_research_get_tabs_ provider', function( array( ) {
// ... your code here
// Return value
return array(;
}, 10, 1 );
page_generator_pro_shortcode_research_get_default_values_ provider
/includes/global/shortcodes/shortcode-research.php::251
Parameters
Parameter
Type
Description
array(
Unknown
N/A
Usage
add_filter( 'page_generator_pro_shortcode_research_get_default_values_ provider', function( array( ) {
// ... your code here
// Return value
return array(;
}, 10, 1 );
page_generator_pro_shortcode_related_links_defaults
/includes/global/shortcodes/shortcode-related-links.php::958
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/shortcodes/shortcode-related-links.php::1328
Overview
Filter the Related Links Shortcode HTML output, before returning.
Parameters
Parameter
Type
Description
$html
string
HTML Output.
$atts
array
Shortcode Attributes.
WP_Query
WP_Query $posts
for
$post
WP_Post
WordPress Post the shortcode is used on.
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_related_links_get_excerpt
/includes/global/shortcodes/shortcode-related-links.php::1509
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( 'page_generator_pro_shortcode_related_links_get_excerpt', function( $excerpt, $post ) {
// ... your code here
// Return value
return $excerpt;
}, 10, 2 );
page_generator_pro_shortcode_google_maps_url
/includes/global/shortcodes/shortcode-google-map.php::706
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.
$map_mode
string
Map Mode.
$title
string
iFrame title.
Usage
add_filter( 'page_generator_pro_shortcode_google_maps_url', function( $url, $atts, $args, $atts['map_mode'], $title ) {
// ... your code here
// Return value
return $url;
}, 10, 5 );
page_generator_pro_shortcode_google_maps
/includes/global/shortcodes/shortcode-google-map.php::719
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_open_street_map
/includes/global/shortcodes/shortcode-open-street-map.php::348
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_screen_get_current_screen_before
/includes/global/screen.php::80
Overview
Returns an array comprising of a simplified screen and section that we are viewing within the WordPress Administration interface, before we've performed any checks. This is useful for frontend Page Builders and AJAX requests where get_current_screen() below won't return anything.
Parameters
Parameter
Type
Description
$result
array
Screen and Section.
Usage
add_filter( 'page_generator_pro_screen_get_current_screen_before', function( $result ) {
// ... your code here
// Return value
return $result;
}, 10, 1 );
page_generator_pro_screen_get_current_screen
/includes/global/screen.php::334
Overview
Returns an array comprising of a simplified screen and section that we are viewing within the WordPress Administration interface.
Parameters
Parameter
Type
Description
$result
array
Screen and Section.
$screen_id
string
Screen.
$screen
WP_Screen
WordPress Screen object.
Usage
add_filter( 'page_generator_pro_screen_get_current_screen', function( $result, $screen_id, $screen ) {
// ... your code here
// Return value
return $result;
}, 10, 3 );
page_generator_pro_shortcode_add_shortcodes
/includes/global/shortcode.php::325
Parameters
Parameter
Type
Description
array(
Unknown
N/A
Usage
add_filter( 'page_generator_pro_shortcode_add_shortcodes', function( array( ) {
// ... your code here
// Return value
return array(;
}, 10, 1 );
page_generator_pro_shortcode_add_shortcodes_outside_of_content_groups
/includes/global/shortcode.php::357
Parameters
Parameter
Type
Description
array(
Unknown
N/A
Usage
add_filter( 'page_generator_pro_shortcode_add_shortcodes_outside_of_content_groups', function( array( ) {
// ... your code here
// Return value
return array(;
}, 10, 1 );
page_generator_pro_shortcode_get_css_prefix
/includes/global/shortcode.php::576
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 ); Actions
File
Filter Name
Description
/views/admin/settings.php
page_generator_pro_setting_panel_ current_tab
/includes/admin/groups-ui.php
page_generator_pro_groups_ui_add_meta_boxes
Action hook after all meta boxes are added for the Content Group UI
page_generator_pro_groups_ui_output_meta_box_featured_image
Output Featured Image options for additional sources on a Content Group
/includes/admin/groups-terms.php
page_generator_pro_generate_term_after
Runs any actions once Generate Content has finished.
/includes/admin/ajax.php
page_generator_pro_generate_content_before
Runs any actions before Generate Content has started.
page_generator_pro_generate_content_after
Runs any actions after Generate Content has finished.
page_generator_pro_generate_terms_before
Runs any actions after Generate Terms has finished.
page_generator_pro_generate_terms_after
Runs any actions after Generate Terms has finished.
/includes/admin/groups-terms-table.php
page_generator_pro_groups_terms_table_run_bulk_actions
Runs the given Bulk Action against the given Content Group IDs.
/includes/admin/groups-table.php
page_generator_pro_groups_table_run_bulk_actions
Runs the given Bulk Action against the given Content Group IDs.
/includes/admin/generate.php
page_generator_pro_generate_terms_before
Runs any actions before Generate Content has started.
page_generator_pro_generate_content_before
Runs any actions before Generate Content has started.
page_generator_pro_generate_terms_after
Runs any actions after Generate Terms has finished.
page_generator_pro_generate_content_after
Runs any actions after Generate Content has finished.
page_generator_pro_generate_content_started
Run any actions before an individual Page, Post or Custom Post Type is generated
page_generator_pro_generate_content_before_insert_update_post
Run any actions immediately before an individual Page, Post or Custom Post Type is generated.
page_generator_pro_generate_content_after_insert_update_post
Run any actions immediately after an individual Page, Post or Custom Post Type is generated, but before its Page Template, Featured Image, Custom Fields, Post Meta, Geodata or Taxonomy Terms have been assigned.
page_generator_pro_generate_content_finished
Run any actions after an individual Page, Post or Custom Post Type is generated successfully.
page_generator_pro_generate_term_started
Run any actions before an individual Term is generated successfully.
page_generator_pro_generate_term_before_insert_update_term
Run any actions immediately before an individual Term is generated.
page_generator_pro_generate_term_after_insert_update_term
Run any actions immediately after an individual Taxonomy Term is generated, but before its Custom Fields or Term Meta have been assigned.
page_generator_pro_generate_term_finished
Run any actions after an individual Term is generated successfully.
page_generator_pro_generate_set_page_template
Action to perform any further steps with the Content Group's Page Template after the Page Template has been copied from the Content Group to the Generated Content.
page_generator_pro_generate_set_custom_fields
Action to perform any further steps with the Content Group's Custom Fields, after all Custom Fields has been copied from the Content Group to the Generated Content.
page_generator_pro_generate_set_header_footer_code
Action to perform any further steps with the Content Group's Header and Footer Code, after Header and Footer code has been copied from the Content Group to the Generated Content.
page_generator_pro_generate_set_post_meta
Action to perform any further steps with the Content Group's Post Meta, after all Post Meta has been copied from the Content Group to the Generated Content.
page_generator_pro_generate_set_term_meta
Action to perform any further steps with the Term Group's Post Meta, after all Post Meta has been copied from the Term Group to the Generated Term.
page_generator_pro_generate_trash_content_finished
Run any actions after all generated content for a given Content Group has been trashd.
page_generator_pro_generate_delete_content_finished
Run any actions after all generated content for a given Content Group has been deleted.
page_generator_pro_generate_delete_comments_finished
Run any actions after all generated comments for a given Content Group and Generated Post has been deleted.
/includes/admin/admin.php
page_generator_pro_admin_admin_scripts_css
Enqueues CSS and JS
page_generator_pro_admin_menu_import_export
page_generator_pro_admin_menu_support
page_generator_pro_generate_terms_before
Runs any actions before Generate Terms has started.
page_generator_pro_generate_content_before
Runs any actions before Generate Content has started.
/includes/admin/groups.php
page_generator_pro_groups_save
Save data to Group Post's Meta
page_generator_pro_generate_content_after
Runs any actions once Generate Content has finished.
/includes/admin/notices.php
page_generator_pro_notices_delete_notices
page_generator_pro_setting_panel_ current_tab
/views/admin/settings.php::64
Parameters
Parameter
Type
Description
Usage
add_action( 'page_generator_pro_setting_panel_ current_tab', function( ) {
// ... your code here
}, 10, 0 );
page_generator_pro_groups_ui_add_meta_boxes
/includes/admin/groups-ui.php::613
Overview
Action hook after all meta boxes are added for the Content Group UI
Parameters
Parameter
Type
Description
$post_type_instance
Page_Generator_Pro_PostType
Post Type Instance.
$is_gutenberg_page
bool
If Gutenberg Editor is used on this Content Group.
Usage
add_action( 'page_generator_pro_groups_ui_add_meta_boxes', function( $base->get_class( 'post_type' ) {
// ... your code here
}, 10, 1 );
page_generator_pro_groups_ui_output_meta_box_featured_image
/includes/admin/groups-ui.php::1184
Overview
Output Featured Image options for additional sources on a Content Group
Parameters
Parameter
Type
Description
$post
WP_Post
WordPress Post.
$settings
array
Content Group Settings.
Usage
add_action( 'page_generator_pro_groups_ui_output_meta_box_featured_image', function( $post, $settings ) {
// ... your code here
}, 10, 2 );
page_generator_pro_generate_term_after
/includes/admin/groups-terms.php::819
Overview
Runs any actions once Generate Content has finished.
Parameters
Parameter
Type
Description
$group_id
int
Group ID.
$test_mode
bool
Test Mode
Usage
add_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::1063
Overview
Runs any actions before Generate Content has started.
Parameters
Parameter
Type
Description
$group_id
int
Group ID.
$test_mode
bool
Test Mode.
$system
string
System.
Usage
add_action( 'page_generator_pro_generate_content_before', function( $group['group_id'], false, 'browser' ) {
// ... your code here
}, 10, 3 );
page_generator_pro_generate_content_after
/includes/admin/ajax.php::1092
Overview
Runs any actions after Generate Content has finished.
Parameters
Parameter
Type
Description
$group_id
int
Group ID.
$test_mode
bool
Test Mode.
$system
string
System.
Usage
add_action( 'page_generator_pro_generate_content_after', function( $group['group_id'], false, 'browser' ) {
// ... your code here
}, 10, 3 );
page_generator_pro_generate_terms_before
/includes/admin/ajax.php::1159
Overview
Runs any actions after Generate Terms has finished.
Parameters
Parameter
Type
Description
$group_id
int
Group ID.
$test_mode
bool
Test Mode.
$system
string
System.
Usage
add_action( 'page_generator_pro_generate_terms_before', function( $group['group_id'], false, 'browser' ) {
// ... your code here
}, 10, 3 );
page_generator_pro_generate_terms_after
/includes/admin/ajax.php::1188
Overview
Runs any actions after Generate Terms has finished.
Parameters
Parameter
Type
Description
$group_id
int
Group ID.
$test_mode
bool
Test Mode.
$system
string
System.
Usage
add_action( 'page_generator_pro_generate_terms_after', function( $group['group_id'], false, 'browser' ) {
// ... your code here
}, 10, 3 );
page_generator_pro_groups_terms_table_run_bulk_actions
/includes/admin/groups-terms-table.php::244
Overview
Runs the given Bulk Action against the given Content Group IDs.
Parameters
Parameter
Type
Description
$action
string
Bulk Action Run.
$post_ids
array
Group IDs.
Usage
add_action( 'page_generator_pro_groups_terms_table_run_bulk_actions', function( $action, $post_ids ) {
// ... your code here
}, 10, 2 );
page_generator_pro_groups_table_run_bulk_actions
/includes/admin/groups-table.php::276
Overview
Runs the given Bulk Action against the given Content Group IDs.
Parameters
Parameter
Type
Description
$action
string
Bulk Action Run.
$post_ids
array
Group IDs.
Usage
add_action( 'page_generator_pro_groups_table_run_bulk_actions', function( $action, $post_ids ) {
// ... your code here
}, 10, 2 );
page_generator_pro_generate_terms_before
/includes/admin/generate.php::203
Overview
Runs any actions before Generate Content has started.
Parameters
Parameter
Type
Description
$group_id
int
Group ID.
$test_mode
bool
Test Mode.
$system
string
System.
Usage
add_action( 'page_generator_pro_generate_terms_before', function( $group_id, $test_mode, $system ) {
// ... your code here
}, 10, 3 );
page_generator_pro_generate_content_before
/includes/admin/generate.php::214
Overview
Runs any actions before Generate Content has started.
Parameters
Parameter
Type
Description
$group_id
int
Group ID.
$test_mode
bool
Test Mode.
$system
string
System.
Usage
add_action( 'page_generator_pro_generate_content_before', function( $group_id, $test_mode, $system ) {
// ... your code here
}, 10, 3 );
page_generator_pro_generate_terms_after
/includes/admin/generate.php::457
Overview
Runs any actions after Generate Terms has finished.
Parameters
Parameter
Type
Description
$group_id
int
Group ID.
$test_mode
bool
Test Mode.
$system
string
System.
Usage
add_action( 'page_generator_pro_generate_terms_after', function( $group_id, $test_mode, $system ) {
// ... your code here
}, 10, 3 );
page_generator_pro_generate_content_after
/includes/admin/generate.php::468
Overview
Runs any actions after Generate Content has finished.
Parameters
Parameter
Type
Description
$group_id
int
Group ID.
$test_mode
bool
Test Mode.
$system
string
System.
Usage
add_action( 'page_generator_pro_generate_content_after', function( $group_id, $test_mode, $system ) {
// ... your code here
}, 10, 3 );
page_generator_pro_generate_content_started
/includes/admin/generate.php::687
Overview
Run any actions before an individual Page, Post or Custom Post Type is generated
Parameters
Parameter
Type
Description
$group_id
int
Group ID.
$settings
array
Group Settings.
$index
int
Keyword Index.
$test_mode
bool
Test Mode
Usage
add_action( 'page_generator_pro_generate_content_started', function( $group_id, $settings, $index, $test_mode ) {
// ... your code here
}, 10, 4 );
page_generator_pro_generate_content_before_insert_update_post
/includes/admin/generate.php::959
Overview
Run any actions immediately before an individual Page, Post or Custom Post Type is generated.
Parameters
Parameter
Type
Description
$group_id
int
Group ID.
$settings
array
Group Settings.
$index
int
Keyword Index.
$test_mode
bool
Test Mode.
Usage
add_action( 'page_generator_pro_generate_content_before_insert_update_post', function( $group_id, $settings, $index, $test_mode ) {
// ... your code here
}, 10, 4 );
page_generator_pro_generate_content_after_insert_update_post
/includes/admin/generate.php::1131
Overview
Run any actions immediately after an individual Page, Post or Custom Post Type is generated, but before its Page Template, Featured Image, Custom Fields, Post Meta, Geodata or Taxonomy Terms have been assigned.
Parameters
Parameter
Type
Description
$post_id
int
Post ID.
$group_id
int
Group ID.
$settings
array
Group Settings.
$index
int
Keyword Index.
$test_mode
bool
Test Mode.
Usage
add_action( 'page_generator_pro_generate_content_after_insert_update_post', function( $post_id, $group_id, $settings, $index, $test_mode ) {
// ... your code here
}, 10, 5 );
page_generator_pro_generate_content_finished
/includes/admin/generate.php::1265
Overview
Run any actions after an individual Page, Post or Custom Post Type is generated successfully.
Parameters
Parameter
Type
Description
$post_id
int
Generated Post ID.
$group_id
int
Group ID.
$settings
array
Group Settings.
$index
int
Keyword Index.
$test_mode
bool
Test Mode.
$post_args
array
wp_insert_post() / wp_update_post() compatible arguments.
Usage
add_action( 'page_generator_pro_generate_content_finished', function( $post_id, $group_id, $settings, $index, $test_mode, $post_args ) {
// ... your code here
}, 10, 6 );
page_generator_pro_generate_term_started
/includes/admin/generate.php::1323
Overview
Run any actions before an individual Term is generated successfully.
Parameters
Parameter
Type
Description
$group_id
int
Group ID.
$settings
array
Group Settings.
$index
int
Keyword Index.
$test_mode
bool
Test Mode.
Usage
add_action( 'page_generator_pro_generate_term_started', function( $group_id, $settings, $index, $test_mode ) {
// ... your code here
}, 10, 4 );
page_generator_pro_generate_term_before_insert_update_term
/includes/admin/generate.php::1467
Overview
Run any actions immediately before an individual Term is generated.
Parameters
Parameter
Type
Description
$group_id
int
Group ID.
$settings
array
Group Settings.
$index
int
Keyword Index.
$test_mode
bool
Test Mode.
Usage
add_action( 'page_generator_pro_generate_term_before_insert_update_term', function( $group_id, $settings, $index, $test_mode ) {
// ... your code here
}, 10, 4 );
page_generator_pro_generate_term_after_insert_update_term
/includes/admin/generate.php::1576
Overview
Run any actions immediately after an individual Taxonomy Term is generated, but before its Custom Fields or Term Meta have been assigned.
Parameters
Parameter
Type
Description
$term
array
Generated Term.
$group_id
int
Group ID.
$settings
array
Group Settings.
$index
int
Keyword Index.
$test_mode
bool
Test Mode.
Usage
add_action( 'page_generator_pro_generate_term_after_insert_update_term', function( $term, $group_id, $settings, $index, $test_mode ) {
// ... your code here
}, 10, 5 );
page_generator_pro_generate_term_finished
/includes/admin/generate.php::1607
Overview
Run any actions after an individual Term is generated successfully.
Parameters
Parameter
Type
Description
$term
array
Generated Term.
$group_id
int
Group ID.
$settings
array
Group Settings.
$index
int
Keyword Index.
$test_mode
bool
Test Mode.
Usage
add_action( 'page_generator_pro_generate_term_finished', function( $term, $group_id, $settings, $index, $test_mode ) {
// ... your code here
}, 10, 5 );
page_generator_pro_generate_set_page_template
/includes/admin/generate.php::3445
Overview
Action to perform any further steps with the Content Group's Page Template after the Page Template has been copied from the Content Group to the Generated Content.
Parameters
Parameter
Type
Description
$post_id
int
Generated Page ID.
$settings
array
Group Settings.
$post_args
array
wp_insert_post() / wp_update_post() arguments.
Usage
add_action( 'page_generator_pro_generate_set_page_template', function( $post_id, $settings, $post_args ) {
// ... your code here
}, 10, 3 );
page_generator_pro_generate_set_custom_fields
/includes/admin/generate.php::3511
Overview
Action to perform any further steps with the Content Group's Custom Fields, after all Custom Fields has been copied from the Content Group to the Generated Content.
Parameters
Parameter
Type
Description
$post_id
int
Generated Page ID.
$group_id
int
Group ID.
$meta
array
Group Custom Fields.
$settings
array
Group Settings.
$post_args
array
wp_insert_post() / wp_update_post() arguments.
$keywords_terms
array
Keywords
Usage
add_action( 'page_generator_pro_generate_set_custom_fields', function( $post_id, $group_id, $settings['meta'], $settings, $post_args, $keywords_terms ) {
// ... your code here
}, 10, 6 ); Overview
Action to perform any further steps with the Content Group's Header and Footer Code, after Header and Footer code has been copied from the Content Group to the Generated Content.
Parameters
Parameter
Type
Description
$post_id
int
Generated Page ID.
$group_id
int
Group ID.
$settings
array
Group Settings.
$post_args
array
wp_insert_post() / wp_update_post() arguments.
$keywords_terms
array
Keywords
Usage
add_action( 'page_generator_pro_generate_set_header_footer_code', function( $post_id, $group_id, $settings, $post_args, $keywords_terms ) {
// ... your code here
}, 10, 5 );
page_generator_pro_generate_set_post_meta
/includes/admin/generate.php::3659
Overview
Action to perform any further steps with the Content Group's Post Meta, after all Post Meta has been copied from the Content Group to the Generated Content.
Parameters
Parameter
Type
Description
$post_id
int
Generated Page ID.
$group_id
int
Group ID.
$post_meta
array
Group Post Meta.
$settings
array
Group Settings.
$post_args
array
wp_insert_post() / wp_update_post() arguments.
Usage
add_action( 'page_generator_pro_generate_set_post_meta', function( $post_id, $group_id, $settings['post_meta'], $settings, $post_args ) {
// ... your code here
}, 10, 5 );
page_generator_pro_generate_set_term_meta
/includes/admin/generate.php::3748
Overview
Action to perform any further steps with the Term Group's Post Meta, after all Post Meta has been copied from the Term Group to the Generated Term.
Parameters
Parameter
Type
Description
$term_id
int
Generated Term ID.
$group_id
int
Group ID.
$term_meta
array
Group Term Meta.
$settings
array
Group Settings.
$term_args
array
wp_insert_term() / wp_update_term() arguments.
Usage
add_action( 'page_generator_pro_generate_set_term_meta', function( $term_id, $group_id, $settings['term_meta'], $settings, $term_args ) {
// ... your code here
}, 10, 5 );
page_generator_pro_generate_trash_content_finished
/includes/admin/generate.php::4369
Overview
Run any actions after all generated content for a given Content Group has been trashd.
Parameters
Parameter
Type
Description
$group_id
int
Group ID.
$post_ids
array
Generated Post IDs that were deleted.
Usage
add_action( 'page_generator_pro_generate_trash_content_finished', function( $group_id, $post_ids ) {
// ... your code here
}, 10, 2 );
page_generator_pro_generate_delete_content_finished
/includes/admin/generate.php::4424
Overview
Run any actions after all generated content for a given Content Group has been deleted.
Parameters
Parameter
Type
Description
$group_id
int
Group ID.
$post_ids
array
Generated Post IDs that were deleted.
Usage
add_action( 'page_generator_pro_generate_delete_content_finished', function( $group_id, $post_ids ) {
// ... your code here
}, 10, 2 ); Overview
Run any actions after all generated comments for a given Content Group and Generated Post has been deleted.
Parameters
Parameter
Type
Description
$group_id
int
Group ID.
$post_id
int
Generated Post ID.
$comment_ids
array
Generated Comment IDs that were deleted.
Usage
add_action( 'page_generator_pro_generate_delete_comments_finished', function( $group_id, $post_id, $comment_ids ) {
// ... your code here
}, 10, 3 );
page_generator_pro_admin_admin_scripts_css
/includes/admin/admin.php::822
Overview
Enqueues CSS and JS
Parameters
Parameter
Type
Description
$screen
array
Screen (screen, section).
$post
WP_Post
WordPress Post.
$minified
bool
Whether to load minified JS.
Usage
add_action( 'page_generator_pro_admin_admin_scripts_css', function( $screen, $post, $minified ) {
// ... your code here
}, 10, 3 ); Parameters
Parameter
Type
Description
Usage
add_action( 'page_generator_pro_admin_menu_import_export', function( ) {
// ... your code here
}, 10, 0 ); Parameters
Parameter
Type
Description
Usage
add_action( 'page_generator_pro_admin_menu_support', function( ) {
// ... your code here
}, 10, 0 );
page_generator_pro_generate_terms_before
/includes/admin/admin.php::2279
Overview
Runs any actions before Generate Terms has started.
Parameters
Parameter
Type
Description
$group_id
int
Group ID.
$test_mode
bool
Test Mode.
$system
string
System.
Usage
add_action( 'page_generator_pro_generate_terms_before', function( $id, false, 'browser' ) {
// ... your code here
}, 10, 3 );
page_generator_pro_generate_content_before
/includes/admin/admin.php::2290
Overview
Runs any actions before Generate Content has started.
Parameters
Parameter
Type
Description
$group_id
int
Group ID.
$test_mode
bool
Test Mode.
$system
string
System.
Usage
add_action( 'page_generator_pro_generate_content_before', function( $id, false, 'browser' ) {
// ... your code here
}, 10, 3 );
page_generator_pro_groups_save
/includes/admin/groups.php::891
Overview
Save data to Group Post's Meta
Parameters
Parameter
Type
Description
$group_id
int
Group ID.
$settings
array
Group Settings.
$_REQUEST
array
Request data.
Usage
add_action( 'page_generator_pro_groups_save', function( $group_id, $settings, $_REQUEST ) {
// ... your code here
}, 10, 3 );
page_generator_pro_generate_content_after
/includes/admin/groups.php::1384
Overview
Runs any actions once Generate Content has finished.
Parameters
Parameter
Type
Description
$group_id
int
Group ID.
$test_mode
bool
Test Mode.
$system
string
System.
Usage
add_action( 'page_generator_pro_generate_content_after', function( $id, true, 'browser' ) {
// ... your code here
}, 10, 3 );
page_generator_pro_notices_delete_notices
/includes/admin/notices.php::394
Parameters
Parameter
Type
Description
Usage
add_action( 'page_generator_pro_notices_delete_notices', function( ) {
// ... your code here
}, 10, 0 );