You might have come across scenarios where Rank Math is not able to detect the Table of Contents. In this article, we will discuss why Rank Math is not able to detect the Table of Contents and what you can do about that…
TOC Plugins Detected by Rank Math
Since there is no specific method to look for a Table of Contents inside your HTML code, Rank Math will check for the presence of a Table of Contents creation plugin on your site.
Assuming that you will use the Table of Contents and you have the plugin installed, Rank Math can detect the Table of Contents if any one of the below-supported plugins is used:
- Rank Math (use Rank Math Table of Contents block to clear the test)
- WP Shortcode Pro
- WP Shortcode
- TOC Pack – Table of Contents for Elementor
- Ultimate Blocks
- LuckyWP Table of Contents
- Elementor Pro
- Table of Contents Plus
- Divi Table Of Contents Maker
- TOP Table of Contents
Rank Math also has its own Table of Contents block, which makes it easier for your readers to navigate your content, allowing them to read exactly what they want. Follow this step-by-step guide to add a Table of Contents block by Rank Math to your WordPress posts and pages.
Adding Your Plugin to TOC List
But, if your plugin is not included in the above list, then you may need to add the following piece of code in your theme’s rank-math.php file. If you haven’t created the filter, you can check this KB article to learn how to create the rank-math.php file.
After creating the PHP file, go to the theme file editor. For the classic users, the navigation path is WordPress Dashboard → Appearance → Theme File Editor → rank-math.php and add the below-given code snippet. If you are using a block theme, then navigate to WordPress Dashboard → Tools → Theme File Editor.
/**
* Filter to add plugins to the TOC list.
*
* @param array TOC plugins.
*/
add_filter( 'rank_math/researches/toc_plugins', function( $toc_plugins ) {
$toc_plugins['plugin-directory/plugin-filename.php'] = 'Plugin Name';
return $toc_plugins;
});
In the above code snippet, you’ll need to replace,
plugin-directory/plugin-filename.php
– with the path to your TOC plugin file inside the WordPress plugins folderPlugin Name
– with the name of your TOC plugin
Once you’ve added the above piece of code, Rank Math can detect that you are using a Table of Contents section in your posts. We recommend adding this code to a child theme so that even when your theme developer releases updates to your main theme, changes are not overridden.
Disable Test for Table of Contents
In case if you’re adding Table of Contents by any other method that does not involve the usage of a plugin, then you can completely disable the test for Table of Contents.
To disable the test of the Table of Contents, add the following piece of code to your theme’s rank-math.php file.
/** * Filter to disable the table of contents test */ add_filter( 'rank_math/researches/tests', function( $tests, $type ) { unset( $tests['contentHasTOC'], ); return $tests; }, 10, 2 );
Once the code snippet has been added, Rank Math will completely ignore the test for Table of Contents while analyzing your content.
And, that’s it! We hope the tutorial helped you fix the issue. If you’re still facing the issue, please feel free to open a support ticket directly from here, and we’re always here to help.