Rank Math SEO Filters and Hooks for Developers

Settings

1. Filter to add/remove tabs in Rank Math Metabox.

Use this filter to add new tabs into the Meta Box added by Rank Math below every post/page in WordPress Editor.

/**
 * Allow developers to add new tabs into main metabox.
 *
 * @param array $tabs Array of tabs.
 */
add_filter( 'rank_math/metabox/tabs', function( $tabs) {
 return $tabs;
});

2. Filter to change the Rank Math Metabox priority.

Use this filter to change the Rank Math metabox priority to low so it appears after other metaboxes like ACF fields.

/**
 * Change the Rank Math Metabox Priority
 *
 * @param array $priority Metabox Priority.
 */
add_filter( 'rank_math/metabox/priority', function( $priority ) {
 return 'low';
});

3. Filter to change the Focus Keyword Limit

Use this filter to increase or decrease the number of maximum focus keywords that can be added in the single post or page editor.

/**
 * Change the Focus Keyword Limit
 */
add_filter( 'rank_math/focus_keyword/maxtags', function() {
    return 10; // Number of Focus Keywords. 
});

4. Filter to add/remove section into the General Settings option panel.

This filter allows you to add or remove a section from the general settings options panel of Rank Math plugin.

/**
 * Allow developers to add new section into general setting option panel.
 *
 * @param array $tabs
 */
add_filter( 'rank_math/settings/general', function( $tabs) {
 return $tabs;
});

5. Filter to add/remove section into the Title Settings option panel.

You can add or remove a custom section to or from the Title Settings option panel with this setting.

/**
 * Allow developers to add new section into general setting option panel.
 *
 * @param array $tabs
 */
add_filter( 'rank_math/settings/title', function( $tabs) {
 return $tabs;
});

6. Filter to allow developers to add option fields to check against update. And if updated, flush the rewrite rules

/**
 * Allow developers to add option fields to check against updatation.
 * And if updated flush the rewrite rules.
 *
 * @param array $flush_fields Array of fields id for which we need to flush.
 */
add_filter( 'rank_math/flush_fields', function( $fields) {
 return $fields;
});

7. Filter to allow developers to add new tabs into the options panel.

/**
 * Allow developers to add new tabs into option panel.
 *
 * The dynamic part of hook is, page name without 'rank-math-' prefix.
 *
 * @param array $tabs
 */
add_filter( "rank_math/admin/options/{$filter}_tabs", function( $tabs ) {
 return $tabs;
});

8. Filter to add/update/remove Content Analysis test.

/**
 * Allow developers to modify the test or score.
 *
 * @param array  $tests Array of tests with score
 * @param string $type  Object type. Can be post, user or term.
 */
add_filter( 'rank_math/researches/tests', function( $tests, $type ) {
 return $tests;
}, 10, 2 );

9. Filter to change a number of items to import per run. Used when importing data from other plugins

/**
 * Number of items to import per run.
 *
 * @param int $items_per_page Default 100.
 */
add_filter( 'rank_math/importers/items_per_page', function( $items_per_page ) {
 return $items_per_page;
});

10. Filter to add/remove the item from the Admin Bar node.

Add or remove an item from the WordPress admin-bar menu that Rank Math adds to the frontend of your WordPress website.

/**
 * Add item to Rank Math admin bar node.
 *
 * @param array $items Array of nodes for Rank Math menu.
 */
add_filter( 'rank_math/admin_bar/items', function( $items ) {
 return $items;
});

11. Add Default value for General Settings during plugin installation.

Set a default value for general settings when Rank Math is installed on a WP website.

/**
 * Add defaults for general options.
 *
 * @param array $settings Array of settings and its values.
 */
add_filter( 'rank_math/settings/defaults/general', function( $settings ) {
 return $settings;
});

12. Add Default value for Title Settings during plugin installation.

/**
 * Add defaults for title options.
 *
 * @param array $settings Array of settings and its values.
 */
add_filter( 'rank_math/settings/defaults/titles', function( $settings ) {
 return $settings;
});

13. Add Default value for Sitemap Settings during plugin installation.

/**
 * Add defaults for Sitemap options.
 *
 * @param array $settings Array of settings and its values.
 */
add_filter( 'rank_math/settings/defaults/sitemap', function( $settings ) {
 return $settings;
});

14. Allow developers to add/remove/change Modules.

/**
 * Filters the array of modules available to be activated.
 *
 * @param array $modules Array of available modules.
 */
add_filter( 'rank_math/modules', function( $modules ) {
 return $modules;
});

15. Filter to change the Author base.

Use this filter to change the URL base for author archives.

/**
 * Allow developers to change the author base.
 *
 * @param string $base The author base.
 */
add_filter( 'rank_math/author_base', function( $base ) {
 return $base;
});

16. Filter to change the address part format.

/**
 * Allow developer to change the address part format.
 *
 * @param string $parts_format String format  how to output address part.
 */
add_filter( 'rank_math/shortcode/contact/address_parts_format', function( $format ) {
 return $format;
});

17. Filter to change Post type icons in the options panel.

/**
 * Allow developer to change post types icons.
 *
 * @param array $icons Array of available icons.
 */
add_filter( 'rank_math/post_type_icons', function( $icons ) {
 return $icons;
});

18. Filter to change Taxonomy icons in the options panel.

/**
 * Allow developer to change taxonomies icons.
 *
 * @param array $icons Array of available icons.
 */
add_filter( 'rank_math/taxonomy_icons', function( $icons ) {
 return $icons;
});

19. Filter to enable/disable overlay icon option in Social Tab in Post Settings.

/**
 * Allow developer to enable/disable overlay icon option in Post Settings.
 *
 * @param string $value   Default is set to off.
 * @param string $service Can be faceboo or twitter.
 *
 */
add_filter( 'rank_math/metabox/social/overlay_icon', function( $value, $service ) {
 return $value;
}, 10, 2 );

20. Filter to enable/disable Link Suggestion Metabox for the particular post type.

/**
 * Allow developer to enable/disable Link Suggestion Metabox for specific post type.
 *
 * @param string $default   Default is set to on.
 * @param string $post_type Post type name.
 *
 */
add_filter( 'rank_math/settings/titles/link_suggestions', function( $default, $post_type ) {
 return $default;
}, 10, 2 );

21. Filter to set default Snippet type for the post type.

/**
 * Allow developer to default Snippet type by post type.
 *
 * @param string $type      Snippet Type.
 * @param string $post_type Post type name.
 *
 */
add_filter( 'rank_math/settings/snippet/type', function( $type, $post_type ) {
 return $default;
}, 10, 2 );

22. Filter to set default Snippet Article type for the post type.

/**
 * Allow developer to default Snippet Article type by post type.
 *
 * @param string $type      Article Type.
 * @param string $post_type Post type name.
 *
 */
add_filter( 'rank_math/settings/snippet/article_type', function( $type, $post_type ) {
 return $default;
}, 10, 2 );

23. Filter to add custom variable replacements.

/**
 * Filter to add custom variables
 */
add_filter( 'rank_math/vars/replacements', function( $vars ) {
 return $vars;
});

24. Add Extra Variables to the Rank Math Dropdown in Title & Meta Settings

/**
 * Action: 'rank_math/vars/register_extra_replacements' - Allows adding extra variables.
 */add_action( 'rank_math/vars/register_extra_replacements', function(){
 rank_math_register_var_replacement(
 'custom_variable_slug',
 [
 'name'        => esc_html__( 'Custom variable name.', 'rank-math' ),
 'description' => esc_html__( 'Custom variable description.', 'rank-math' ),
 'variable'    => 'custom_variable_slug',
 'example'     => 'custom_variable_callback()',
 ],
 'custom_variable_callback()'
 );
});

25. Filter to show/hide SEO Metabox.

/**
 * Filter to show/hide SEO Metabox.
 */
add_filter( 'rank_math/metabox/add_seo_metabox', function( $default ) {
 return $default;
});

26. Filter to change Separator %sep%.

/**
 * Filter to change Separator %sep%.
 */
add_filter( 'rank_math/settings/title_separator', function( $sep ) {
 return $sep;
});

27. Filter to turn off auto-update notification emails.

/**
 * Filter to turn off auto-update notification emails.
 */
add_filter( 'rank_math/auto_update_send_email', '__return_false' );

28. Filter to edit the auto-update notification emails.

/**
 * Filter to edit the auto-update notification emails.
 */
add_filter( 'rank_math/auto_update_email', function( $email, $version, $plugin_upgrader_obj ) {
  $email['to_address'] = '[email protected]';
  $email['body'] = "Rank Math has been updated to version {$version}.";
  return $email;
});

29. Add Custom Power Words for Analysis

/**
 * Filter to add custom Power Words
 */
add_filter( 'rank_math/metabox/power_words', function( $words ){
	$new_words = [
		'test-word1',
		'test-word2',
		'test-word3',
	];
	return array_merge( $words, $new_words );
});

30. Replace Rank Math Google API App with your own

Please follow this tutorial before using this filter.

/**
 * Filter to replace Rank Math Google API App
 */
add_filter(
	'rank_math/search_console/alternate_app',
	function( $config ) {
		$config['application_name'] = 'Rank Math';
		$config['client_id']        = 'xxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx.apps.googleusercontent.com';
		$config['client_secret']    = 'xxxxxxxx-xxxxxxxxxxxxxxxxx';
		return $config;
	}
);

31. Filter to change default Settings Mode(Easy or Advanced)

/**
 * Filter to change default Settings Mode(Easy or Advanced)
 */
add_filter( 'rank_math/setup_mode', function( $mode ) {
    return $mode;
});

32. Filters to change the CSV separator character in the CSV Importer file

/**
 * Filters to change the CSV separator character in the CSV Importer file
 */
add_filter( 'rank_math/csv_import/separator', function( $separator ) {
    return ';';
} );

Sitemap

1. Filter to change the Sitemap URL Base

/**
 * Filter to change the Sitemap URL Base
 *
 * @param string $base New URL Base
 */
add_filter( 'rank_math/sitemap/base_url', function( $base ){
	return '/search-sitemaps/';
}, 10, 1 );

2. Filter to change the Sitemap Cache directory.

/**
 * Filter XML sitemap cache directory.
 *
 * @param string $unsigned Default cache directory
 */
add_filter( 'rank_math/sitemap/cache_directory', function( $directory) {
	return $directory;
});

3. Filter to enable/disable Sitemap caching.

/**
 * Filter if XML sitemap transient cache is enabled.
 *
 * @param boolean $unsigned Enable cache or not, defaults to true
 */
add_filter( 'rank_math/sitemap/enable_caching', '__return_true');

4. Filter to exclude post type from the Sitemap.

/**
 * Filter decision if post type is excluded from the XML sitemap.
 *
 * @param bool   $exclude Default false.
 * @param string $type    Post type name.
 */
add_filter( 'rank_math/sitemap/exclude_post_type', function( $exclude, $type ){
	return $exclude;
}, 10, 2 );

5. Filter sitemap item before it gets added to the sitemap.

/**
 * Filter URL entry before it gets added to the sitemap.
 *
 * @param array  $url  Array of URL parts.
 * @param string $type URL type. Can be user, post or term.
 * @param object $object Data object for the URL.
 */
add_filter( 'rank_math/sitemap/entry', function( $url, $type, $object ){
	return $url;
}, 10, 3 );

6. Filter to change/remove archive url, plugin uses in th XML Sitemap.

/**
 * Filter the URL Rank Math SEO uses in the XML sitemap for this post type archive.
 *
 * @param string $archive_url The URL of this archive
 * @param string $post_type   The post type this archive is for.
 */
add_filter( 'rank_math/sitemap/post_type_archive_link', function( $archive_url, $post_type ){
	return $archive_url;
}, 10, 2 );

7. Filter to change/remove Post URL, plugin uses in the sitemap.

/**
 * Filter the URL Rank Math SEO uses in the XML sitemap.
 *
 * Note that only absolute local URLs are allowed as the check after this removes external URLs.
 *
 * @param string $url  URL to use in the XML sitemap
 * @param object $post Post object for the URL.
 */
add_filter( 'rank_math/sitemap/xml_post_url', function( $url, $post){
	return $url;
}, 10, 2 );

8. Filter to exclude taxonomy from Sitemap.

/**
 * Filter decision if taxonomy is excluded from the XML sitemap.
 *
 * @param bool   $exclude Default false.
 * @param string $type    Taxonomy name.
 */
add_filter( 'rank_math/sitemap/exclude_taxonomy', function( $exclude, $type ){
	return $exclude;
}, 10, 2 );

9. Filter to exclude empty terms from Sitemap.

/**
 * Filter the setting of excluding empty terms from the XML sitemap.
 *
 * @param boolean $exclude        Defaults to true.
 * @param array   $taxonomy_names Array of names for the taxonomies being processed.
 */
add_filter( 'rank_math/sitemap/exclude_empty_terms', function( $exclude , $taxonomy_names ){
	return $exclude;
}, 10, 2 );

10. Filter to remove/change images included for the post in XML sitemap.

/**
 * Filter images to be included for the post in XML sitemap.
 *
 * @param array $images  Array of image items.
 * @param int   $post_id ID of the post.
 */
add_filter( 'rank_math/sitemap/urlimages', function( $images, $post_id ){
	return $images;
}, 10, 2);

11. Filter to Remove Sitemap credit.

/**
 * Filter to remove sitemap credit.
 *
 * @param boolean Defaults to false.
 */
add_filter( 'rank_math/sitemap/remove_credit', '__return_true');

12. Filter to Add Extra URLs in the Sitemap

/**
 Filter to add extra URLs to the XML sitemap by type.
 *
 Only runs for the first page, not on all.
 *
 @param string $content String content to add, defaults to empty.
 */
add_action( 'rank_math/sitemap/{$type}_content', function() {
return '<url>
<loc>https://rankmath.com/some-custom-url/</loc>
<lastmod>2020-06-10T20:20:20+00:00</lastmod>
</url>';
});

Replace {$type} with either post or page depending on if you want the URL to be include in the post or page sitemap – respectively.

13. Filter to add Locations KML file in the Sitemap

/**
 * Filter to add Locations KML file in the sitemap
 */
add_filter( 'rank_math/sitemap/locations', '__return_true' );

14. Filter to Add CDN Image URLs in the Sitemap

/**
 * Filter to Add CDN Image URLs in the Sitemap
 *
 * @param string $src  Image URL.
 * @param object $post Post object.
 */
add_filter( 'rank_math/sitemap/xml_img_src', function( $src, $post ){
	$src = str_replace( 'http://domain.com', 'https://cdn.domain.com', $src );
	return $src;
}, 10, 2);

15. Filter to detect third party sitemap URL in the Search Console

/**
 * Filter to detect Sitemap URL in the Search Console if you are using different plugin for sitemap.
 */
add_filter( 'rank_math/sitemap/sitemap_index_uri', function() { return 'sitemap.xml'; } );

16. Filter to change user query arguments for the sitemap listing

/**
 * Filter to change user query arguments for the sitemap listing
 */
add_filter( 'rank_math/sitemap/author/query', function( $args ) {
	$args['role__not_in'] = 'subscriber'; return $args;
} );

17. Filter to add `noindex` URLs in the Sitemap

/**
* Filter to add `noindex` URLs in the Sitemap
*
* @param bool $value Whether to include noindex terms in Sitemap.
* @param string $type Object Type.
*
* @return boolean
*/
add_filter( 'rank_math/sitemap/include_noindex', function( $value, $type ) {
	return true;
}, 10, 2 );

18. Filter to add external Sitemap to the Rank Math Sitemap

add_filter( 'rank_math/sitemap/index', function( $xml ) {
	$xml .= '
		<sitemap>
			<loc>http://example.com/new-sitemap.xml</loc>
			<lastmod>2020-09-14T20:34:15+00:00</lastmod>
		</sitemap>';
		return $xml;
}, 11 );