Rank Math Knowledge Base

https://rankmath.com/kb
Admin
Rank Math is a powerful SEO plugin for WordPress that helps users optimize their websites for search...
Tokens:886,099
Snippets:9,351
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Install Rank Math SEO Free and PRO via composer.json

Source: https://rankmath.com/kb/install-rank-math-pro-with-composer

Add this snippet to your composer.json file to install both Rank Math SEO Free and PRO. It requires both plugins to be installed and activated. Use `composer install` or `composer update` to install. To update the PRO plugin, delete composer.lock and update the version number in the JSON file.

```json
{
    "require": {
    "wpackagist-plugin/seo-by-rank-math":"*",
    "rankmath/seo-by-rank-math-pro": "*"
},
"repositories": [
    {
        "type": "composer",
        "url": "https://wpackagist.org"
    },
    {
        "type": "package",
        "package": {
            "name": "rankmath/seo-by-rank-math-pro",
            "type": "wordpress-plugin",
            "version": "2.7.0",
              "dist": {
                "type": "zip",
                "url": "https://rankmath.com/download/510590/?username=testcomposer&api_key=29d4f7d643804e96512114d420b76693"
            },
            "require": {
                "composer/installers": "*"
            }
        }
    }
],
"extra": {
    "installer-paths": {
        "wp-content/plugins/{$name}/": ["type:wordpress-plugin"]
    }
}
}
```

--------------------------------

### Schema Data JSON-LD Example

Source: https://rankmath.com/kb/editing-seo-meta-at-scale

Example of the JSON-LD Schema data stored in the `schema_data` column for a post. The example is shown in minified format and uses placeholders like `%post_thumbnail%`, `%seo_title%`, and `%date(Y-m-dTH:i:sP)%`.

```json
{
    "BlogPosting": {
        "metadata": {
            "title": "Article",
            "type": "template",
            "shortcode": "s-6130d16c7959d",
            "isPrimary": "1",
            "enableSpeakable": "disable"
        },
        "image": {
            "@type": "ImageObject",
            "url": "%post_thumbnail%"
        },
        "headline": "%seo_title%",
        "description": "%seo_description%",
        "keywords": "%keywords%",
        "@type": "BlogPosting",
        "author": {
            "@type": "Person",
            "name": "%name%"
        },
        "datePublished": "%date(Y-m-dTH:i:sP)%",
        "dateModified": "%modified(Y-m-dTH:i:sP)%"
    }
}
```

--------------------------------

### WebSite Schema JSON-LD Example

Source: https://rankmath.com/kb/website-schema

Use this JSON-LD markup to provide search engines with website details such as URL, name, and a search action. The potentialAction defines a SearchAction with a target URL containing the {query} placeholder and a query-input requirement. This example is typically placed on the homepage.

```JSON-LD
<script type="application/ld+json">
{
    "@context": "https://schema.org",
    "@type": "WebSite",
    "url": "http://example.com",
    "name": "Example",
    "potentialAction": {
      "@type": "SearchAction",
      "target": "http://example.com/search?q={query}",
      "query-input": "required name=query"
    }
}
</script>
```

--------------------------------

### Block Users Based on IP

Source: https://rankmath.com/kb/edit-htaccess

Blocks users based on IP address. The example blocks IPs starting with 255 and 123; you can specify exact IPs or partial patterns.

```apache
order allow,deny
deny from 255.x.x.x
deny from 123.x.x.x
allow from all
```

--------------------------------

### Example URL with UTM parameters

Source: https://rankmath.com/kb/utm-parameters-with-redirects

Shows a URL with all five UTM parameters: utm_source, utm_medium, utm_campaign, utm_term, and utm_content.

```text
https:/example.com?utm_source=newsletter&utm_medium=email&utm_campaign=sale&utm_term=running%2Bshoes&utm_content=textlink
```

--------------------------------

### Set Default General Settings with rank_math/settings/defaults/general

Source: https://rankmath.com/kb/make-theme-rank-math-compatible

This filter lets you set default values for Rank Math General Settings when users install Rank Math. The example shows the basic structure for modifying the $settings array.

```php
/**
 * 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;
});
```

--------------------------------

### rank_math/setup_mode

Source: https://rankmath.com/kb/filters-hooks-api-developer

Filter to change the default Settings Mode.

```APIDOC
## Filter: rank_math/setup_mode

### Description
This filter allows you to change the default Settings Mode (Easy or Advanced).

### Hook
`rank_math/setup_mode`

### Parameters
- **$mode** (string) - The current setup mode.

### Usage Example
```php
add_filter( 'rank_math/setup_mode', function( $mode ) {
    return $mode;
});
```
```

--------------------------------

### Create custom-sitemap.php with Custom Provider class

Source: https://rankmath.com/kb/custom-sitemaps

Create a custom sitemap provider class in a new file named custom-sitemap.php in your child theme. The class implements the Rank Math Provider interface and returns a sitemap index link and custom sitemap links. Replace the example.com URLs with your own links in the get_sitemap_links() function.

```php
<?php

namespace RankMath\Sitemap\Providers;

defined( 'ABSPATH' ) || exit;

class Custom implements Provider {

	public function handles_type( $type ) {
		return 'custom' === $type;
	}

	public function get_index_links( $max_entries ) {
		return [
			[
				'loc'     => \RankMath\Sitemap\Router::get_base_url( 'custom-sitemap.xml' ),
				'lastmod' => '',
			]
		];
	}

	public function get_sitemap_links( $type, $max_entries, $current_page ) {
		$links     = [ 
			[
				'loc' => 'http://www.example.com/',
				'mod' => '2023-10-08',
			],
			[
				'loc' => 'http://www.example.com/page-2/',
				'mod' => '2023-10-08',
			],
		];

		return $links;
	}

}
```

--------------------------------

### Exclude queries starting with #

Source: https://rankmath.com/kb/regex-in-google-search-console

This regex matches any string that does not start with a '#' character, useful for excluding queries that begin with a hash symbol.

```regex
^[^#]+$

```

--------------------------------

### Sample RSS content with variables

Source: https://rankmath.com/kb/general-settings?_gl=1%2A1j5lcd9%2A_ga%2AMTIxNTAzMTAwMS4xNjkxOTg0ODU3%2A_ga_WTF2SQ5LGQ%2AMTY5Mjg0NzcwMC4zNS4xLjE2OTI4NTY2OTYuMi4wLjA.

Example text using available variables for the RSS Before Content and RSS After Content settings. The variables %POSTLINK%, %BLOGLINK%, and %AUTHORLINK% are replaced with the post link, blog link, and author link respectively.

```text
The post %POSTLINK% first appeared on %BLOGLINK% and is written by %AUTHORLINK%.
```

--------------------------------

### Unzip and Install Rank Math Plugin via SSH

Source: https://rankmath.com/kb/installing-with-ssh

Commands to unzip and install the Rank Math plugin via SSH. Use gunzip to extract the downloaded zip file, then rm to remove the zip file. The final block shows the full sequence: wget to download the plugin, gunzip to extract it, and rm to delete the archive.

```bash
gunzip "filename"
```

```bash
rm "filename"
```

```bash
[yourserver@host /home/yourserver/public_html/wp-content/plugins/] : wget http://downloads.wordpress.org/plugin/rank-math.0.9.3.zip

[yourserver@host /home/yourserver/public_html/wp-content/plugins/] : gunzip rank-math.0.9.3.zip

[yourserver@host /home/yourserver/public_html/wp-content/plugins/] : rm rank-math.0.9.3.zip
```

--------------------------------

### Meta Description HTML Example

Source: https://rankmath.com/kb/ideal-meta-description-length

Example of a meta description HTML tag placed in the head section of a page. The content attribute holds the description that may appear in search results.

```html
<head>  <meta name="description"  content="This is an example of a meta description. This will often show up in search results."></head>
```

--------------------------------

### Disable Title Start with Keyword Test

Source: https://rankmath.com/kb/disable-seo-content-tests

Use this filter to disable the title start with keyword test in Rank Math's SEO content analysis. It removes the 'titleStartWithKeyword' test from the tests array.

```php
/**
 * Filter to disable Title starts with Keyword test
 */
add_filter('rank_math/researches/tests', function ($tests, $type) {
	unset($tests['titleStartWithKeyword']);
	return $tests;
}, 10, 2 );
```
Tokens:
Raw