Creates SEO-friendly table of contents for your posts, pages or custom post types. Great customizable appearance.<\/p>\n\n
example.com\/faq\/#how_do_this<\/code>).<\/li>\n- RTL support.<\/li>\n
- Available override global settings for a particular post.<\/li>\n
- Highly compatible with WordPress themes and plugins.<\/li>\n<\/ul>\n\n
Auto Insert<\/h4>\n\n
For automatical insertion a table of contents in a posts, select option \"Auto Insert Table of Contents\" in the plugin settings (tab \"Auto Insert\").<\/p>\n\n
Supported positions:<\/p>\n\n
\n- before first heading;<\/li>\n
- after first heading;<\/li>\n
- after first block (paragraph or heading);<\/li>\n
- top of post content;<\/li>\n
- bottom of post content.<\/li>\n<\/ul>\n\n
You can also select post types to which the table of contents will be automatically added.<\/p>\n\n
Manual Insert<\/h4>\n\n
For manual insertion a table of content in a posts, use one of the ways:<\/p>\n\n
\n- button \"Table of Contents\" on toolbar in classic editor;<\/li>\n
- gutenberg block \"Table of Contents\";<\/li>\n
- shortcode
[lwptoc]<\/code>.<\/li>\n<\/ul>\n\nPretty hash in URL<\/h4>\n\n
By default, hash generated as heading text (for example, #How_Do_This<\/code>). You can change hash format in global settings, tab \"Misc.\".<\/p>\n\nFor non-English websites it is recommended to enable the Intl<\/code> PHP extension.<\/p>\n\nCompatibility<\/h3>\n\n
LuckyWP Table of Contents was successfully tested with the following plugins:<\/p>\n\n
\n- Elementor Page Builder<\/li>\n
- Beaver Builder and Beaver Builder Themer Add-On<\/li>\n
- WPBakery Page Builder<\/li>\n
- Oxygen<\/li>\n
- WordPress Multilingual Plugin (WPML), officially confirmed<\/a><\/li>\n
- Rank Math, officially confirmed<\/a><\/li>\n
- WP Rocket<\/li>\n
- Toolset Views and Toolset Access<\/li>\n<\/ul>\n\n
Hooks<\/h3>\n\nFilters lwptoc_before<\/code>, lwptoc_after<\/code><\/h4>\n\nUse for add custom HTML before\/after the table of contents.<\/p>\n\n
Example:<\/p>\n\n
add_filter('lwptoc_before', function ($before) {\n return '<p>Example text before TOC.<\/p>' . $before;\n});\n<\/code><\/pre>\n\nFilter lwptoc_shortcode_tag<\/code><\/h4>\n\nUse this filter for change shortcode tag name [lwptoc]<\/code>.<\/p>\n\nExample:<\/p>\n\n
add_filter('lwptoc_shortcode_tag', function ($tag) {\n return 'toc';\n});\n<\/code><\/pre>\n\nFilter lwptoc_heading_id<\/code><\/h4>\n\nUse for modify heading ID.<\/p>\n\n
Example:<\/p>\n\n
add_filter('lwptoc_heading_id', function ($id, $label) {\n return $id;\n}, 10, 2);\n<\/code><\/pre>\n\n\nInstalling from the WordPress control panel<\/h4>\n\n\n- Go to the page \"Plugins > Add New\".<\/li>\n
- Input the name \"LuckyWP Table of Contents\" in the search field<\/li>\n
- Find the \"LuckyWP Table of Contents\" plugin in the search result and click on the \"Install Now\" button, the installation process of plugin will begin.<\/li>\n
- Click \"Activate\" when the installation is complete.<\/li>\n<\/ol>\n\n
Installing with the archive<\/h4>\n\n\n- Go to the page \"Plugins > Add New\" on the WordPress control panel<\/li>\n
- Click on the \"Upload Plugin\" button, the form to upload the archive will be opened.<\/li>\n
- Select the archive with the plugin and click \"Install Now\".<\/li>\n
- Click on the \"Activate Plugin\" button when the installation is complete.<\/li>\n<\/ol>\n\n
Manual installation<\/h4>\n\n\n- Upload the folder
luckywp-table-of-contents<\/code> to a directory with the plugin, usually it is \/wp-content\/plugins\/<\/code>.<\/li>\n- Go to the page \"Plugins > Add New\" on the WordPress control panel<\/li>\n
- Find \"LuckyWP Table of Contents\" in the plugins list and click \"Activate\".<\/li>\n<\/ol>\n\n
After activation<\/h3>\n\n
Into classic editor will appear button \"Table of Contents\" (available on edit post\/page screen).<\/p>\n\n
Into Gutenberg editor will appear block \"Table of Contents\" (see \"Common Blocks\").<\/p>\n\n
The menu item \"Table of Contents\" will appear in the menu \"Settings\" of the WordPress control panel.<\/p>\n\n
For non-English websites it is recommended to enable the Intl<\/code> PHP extension.<\/p>\n\n\n2.1.14 \u2014 2025-04-16<\/h4>\n\n\n- Fix bug with array to string conversion.<\/li>\n<\/ul>\n\n
2.1.13 \u2014 2025-04-07<\/h4>\n\n\n- Minor performance improvements.<\/li>\n<\/ul>\n\n
2.1.12 \u2014 2025-04-07<\/h4>\n\n\n- Fix problems with square brackets usage in widget options.<\/li>\n<\/ul>\n\n
2.1.11 \u2014 2025-04-01<\/h4>\n\n\n- Fix non-critical vulnerability.<\/li>\n<\/ul>\n\n
2.1.10 \u2014 2025-01-24<\/h4>\n\n\n- Use in Oxygen Builder only page\/post content.<\/li>\n<\/ul>\n\n
2.1.9 \u2014 2024-11-08<\/h4>\n\n\n- Fix \"LuckyWP Plugins\" page.<\/li>\n<\/ul>\n\n
2.1.8 \u2014 2024-10-28<\/h4>\n\n\n- Adapt to WordPress 6.7.<\/li>\n<\/ul>\n\n
2.1.7 \u2014 2024-10-18<\/h4>\n\n\n- Fix non-critical vulnerability.<\/li>\n<\/ul>\n\n
2.1.6 \u2014 2024-10-04<\/h4>\n\n\n- Fix vulnerabilities.<\/li>\n<\/ul>\n\n
2.1.5 \u2014 2024-09-05<\/h4>\n\n\n- Minor refactoring.<\/li>\n<\/ul>\n\n
2.1.4 \u2014 2020-08-03<\/h4>\n\n\n- Minor refactoring.<\/li>\n<\/ul>\n\n
2.1.3 \u2014 2020-06-07<\/h4>\n\n\n- Added hook filter
lwptoc_allow<\/code>.<\/li>\n<\/ul>\n\n2.1.2 \u2014 2020-05-08<\/h4>\n\n\n- Added hook filter
lwptoc_title_tag<\/code>.<\/li>\n<\/ul>\n\n2.1.1 \u2014 2020-03-15<\/h4>\n\n\n- In heading ID duplicate hyphens are replaced with one.<\/li>\n
- Fixed: content of tags
<style><\/code> and <script><\/code> was included in heading label.<\/li>\n<\/ul>\n\n2.1 \u2014 2020-03-12<\/h4>\n\n\n- Added option \"Additional CSS Class(es)\".<\/li>\n
- Added option \"OL\/LI\" to \"List Markup Tags\".<\/li>\n
- Added support Oxygen Builder.<\/li>\n
- Removed class \"lwptoc_item\" from links.<\/li>\n
- Minor fixes for performance.<\/li>\n<\/ul>\n\n
2.0.9 \u2014 2020-03-07<\/h4>\n\n\n- Added hook filters
lwptoc_heading_html<\/code> and lwptoc_heading_label<\/code>.<\/li>\n- Fixed: in some cases don't register JS\/CSS files.<\/li>\n
- Minor fixes for compatibility with future versions of WordPress.<\/li>\n<\/ul>\n\n
2.0.8 \u2014 2020-02-23<\/h4>\n\n\n- Added hook filter
lwptoc_active<\/code>.<\/li>\n- Added tab \"LuckyWP Plugins\" to settings.<\/li>\n
- Improvement work option \"Skip headings by text\".<\/li>\n
- Fixed: in some cases shortcode incorrectly processed.<\/li>\n
- Fixed: in some cases auto insert work incorrectly.<\/li>\n
- Fixed: headings in table of contents not escaping.<\/li>\n
- Minor fixes in customize window.<\/li>\n<\/ul>\n\n
2.0.7 \u2014 2020-01-31<\/h4>\n\n\n- Added support child themes of \"Twenty Twenty\".<\/li>\n
- Fixed: incorrect smooth scroll behavior when on page use CSS
html {scroll-behavior: smooth;}<\/code>.<\/li>\n- Fixed: in some cases auto insert after first block work incorrectly.<\/li>\n<\/ul>\n\n
2.0.6 \u2014 2020-01-29<\/h4>\n\n\n- When enabled smooth scroll hash changed after complete animation.<\/li>\n
- Fixed: incorrectly processing conditional comments in content.<\/li>\n
- Fixed: JS don't work on asynchronous loading.<\/li>\n<\/ul>\n\n
2.0.5 \u2014 2020-01-26<\/h4>\n\n\n- Fixed: incorrectly processing HTML entities in links.<\/li>\n
- Fixed: incorrectly processing scripts, styles and CDATA in content.<\/li>\n<\/ul>\n\n
2.0.4 \u2014 2020-01-25<\/h4>\n\n\n- In debugging information for \"Site Health\" tool added \"intl Version\" and \"ICU Version\".<\/li>\n
- From hash is removed colon symbol when used hash format \"As heading without transliterate\".<\/li>\n
- Fixed: incorrectly processing HTML entities.<\/li>\n<\/ul>\n\n
2.0.3 \u2014 2020-01-19<\/h4>\n\n\n- Added support \"Twenty Twenty\" theme.<\/li>\n
- Minor code refactoring.<\/li>\n<\/ul>\n\n
2.0.2 \u2014 2020-01-10<\/h4>\n\n\n- Fixed: in some cases plugin incorrectly work with UTF-8.<\/li>\n
- Fixed: on automatically insertion table of contents with option \u201cBefore\/after first heading\u201d to posts without headings occurred error.<\/li>\n
- Fixed: if disabled show\/hide toggle occured JS error.<\/li>\n<\/ul>\n\n
2.0.1 \u2014 2020-01-08<\/h4>\n\n\n- Fixed: in some cases headings processing incorrectly.<\/li>\n<\/ul>\n\n
2.0 \u2014 2020-01-07<\/h4>\n\n\n- Added debugging information for \"Site Health\" tool.<\/li>\n
- CSS and JS are included only when table of content is displayed.<\/li>\n
- Removed dependency to jQuery on frontend.<\/li>\n
- Redesigned automatic insertion of table of contents using the PHP extension DOM (Document Object Model).<\/li>\n
- Redesigned processing headings using the PHP extension DOM (Document Object Model).<\/li>\n
- Minor enhancements in CSS.<\/li>\n<\/ul>\n\n
1.9.11 \u2014 2019-11-18<\/h4>\n\n\n- Added hook filters
lwptoc_force_wp_transliterate<\/code> and lwptoc_transliterator<\/code>.<\/li>\n- Fixed: in some cases for table of contents used a non-current post.<\/li>\n<\/ul>\n\n
1.9.10 \u2014 2019-11-10<\/h4>\n\n\n- Fixed: in some cases hash for heading without transliteration was generated incorrectly.<\/li>\n<\/ul>\n\n
1.9.9 \u2014 2019-11-06<\/h4>\n\n\n- Minor fixes for WPML compatibility.<\/li>\n<\/ul>\n\n
1.9.8 \u2014 2019-10-23<\/h4>\n\n\n- Minor fixes for compatibility with WordPress 5.3.<\/li>\n<\/ul>\n\n
1.9.7 \u2014 2019-10-17<\/h4>\n\n\n- Fixed: in some cases the widget was displayed incorrectly.<\/li>\n<\/ul>\n\n
1.9.6 \u2014 2019-10-11<\/h4>\n\n\n- Enhancements for more compatible with themes and plugins.<\/li>\n<\/ul>\n\n
1.9.5 \u2014 2019-10-09<\/h4>\n\n\n- Enhancements for more compatible with themes and plugins.<\/li>\n<\/ul>\n\n
1.9.4 \u2014 2019-09-04<\/h4>\n\n\n- Enhancements for more compatible with themes and plugins.<\/li>\n<\/ul>\n\n
1.9.3 \u2014 2019-08-25<\/h4>\n\n\n- Added WPML compatibility.<\/li>\n<\/ul>\n\n
1.9.2 \u2014 2019-08-11<\/h4>\n\n\n- Added support Elementor plugin.<\/li>\n<\/ul>\n\n
1.9.1 \u2014 2019-08-04<\/h4>\n\n\n- Added support Toolset Views plugin.<\/li>\n<\/ul>\n\n
1.9 \u2014 2019-08-04<\/h4>\n\n\n- Added special color scheme \"Inherit from theme\".<\/li>\n
- Added option \"List Markup Tags\".<\/li>\n
- Added support Beaver Builder Themer Add-On.<\/li>\n
- Implemented automatic removal of empty headings from table of contents.<\/li>\n
- Automatic insertion of table of contents \"after first block\" takes into account only paragraphs and headings.<\/li>\n
- Improved JS code to prevent reinitialization.<\/li>\n
- Minor changes in strings, fixed typos.<\/li>\n
- Added tips for translators in code.<\/li>\n<\/ul>\n\n
1.8 \u2014 2019-07-29<\/h4>\n\n\n- Added option \"Use rel=\"nofollow\" for links\"<\/li>\n
- Added compatibility with Rank Math SEO plugin.<\/li>\n
- Option \"Auto Insert Table of Contents\" is disabled by default.<\/li>\n
- In notice \"Rate the plugin\" action \"I've already rated the plugin\" replaced to \"Don't show again\".<\/li>\n
- Added tips for translators in code.<\/li>\n<\/ul>\n\n
1.7 \u2014 2019-07-18<\/h4>\n\n\n- Added option \"Replace underscores (_) with dashes (-)\" for hash.<\/li>\n
- Added option \"Convert to lowercase\" for hash.<\/li>\n
- Minor changes in strings.<\/li>\n
- Added tips for translators in code.<\/li>\n
- Fixed: in some cases, incorrectly worked skip headings.<\/li>\n<\/ul>\n\n
1.6.1 \u2014 2019-07-14<\/h4>\n\n\n- For hash format added option \"As heading w\/o transliterate\".<\/li>\n
- Added hebrew translate, thanks to @cdk-comp and @0enaro.<\/li>\n
- Added spanish translate, thanks to @fernandot, @sanbec and @nobnob.<\/li>\n
- Improved generate hash with option \"As heading\".<\/li>\n<\/ul>\n\n
1.6 \u2014 2019-07-13<\/h4>\n\n\n- Added RTL support.<\/li>\n
- Added option \"Numeration Suffix\".<\/li>\n
- Changed text domain to \"luckywp-table-of-contents\".<\/li>\n
- Improved Beaver Builder plugin support.<\/li>\n<\/ul>\n\n
1.5.7 \u2014 2019-07-10<\/h4>\n\n\n- Improvement smooth scroll implementation for support lazy loading images in content.<\/li>\n
- Fix: in some cases, incorrectly worked smooth scroll to headings.<\/li>\n<\/ul>\n\n
1.5.6 \u2014 2019-07-06<\/h4>\n\n\n- Fix: in some cases, incorrectly worked option \"Minimal Count of Headers\".<\/li>\n<\/ul>\n\n
1.5.5 \u2014 2019-07-06<\/h4>\n\n\n- Modified code for compatibility with Toolset Access plugin.<\/li>\n<\/ul>\n\n
1.5.4 \u2014 2019-06-29<\/h4>\n\n\n- Added support Beaver Builder plugin.<\/li>\n
- Fix: in some cases, headings processing did not work correctly.<\/li>\n<\/ul>\n\n
1.5.3 \u2014 2019-06-27<\/h4>\n\n\n- Fix: when auto insert TOC do not overrided settings \"Wrap table of contents with <!--noindex--> tag\" and \"Skip headings\".<\/li>\n
- Fix: in some cases, auto insert after first block did not work.<\/li>\n<\/ul>\n\n
1.5.2 \u2014 2019-06-17<\/h4>\n\n\n- Added hook filter
lwptoc_heading_id<\/code>.<\/li>\n- Implemented classic behavior on click \"Back\" in browser.<\/li>\n<\/ul>\n\n
1.5.1 \u2014 2019-06-05<\/h4>\n\n\n- Bug fix<\/li>\n<\/ul>\n\n
1.5 \u2014 2019-06-04<\/h4>\n\n\n- Enhancements for search engines (Google and other).<\/li>\n<\/ul>\n\n
1.4.1 \u2014 2019-06-01<\/h4>\n\n\n- Bug fix<\/li>\n<\/ul>\n\n
1.4 \u2014 2019-06-01<\/h4>\n\n\n- Added widget \"Table of Contents\".<\/li>\n
- Added support output table of contents via
do_shortcode('[lwptoc]')<\/code>.<\/li>\n- Enhancements for more compatible with themes.<\/li>\n<\/ul>\n\n
1.3.1 \u2014 2019-05-09<\/h4>\n\n\n- Bug fix<\/li>\n<\/ul>\n\n
1.3.0 \u2014 2019-05-08<\/h4>\n\n\n- Skip headings by level or text.<\/li>\n<\/ul>\n\n
1.2.2 \u2014 2019-04-24<\/h4>\n\n\n- Bug fix<\/li>\n<\/ul>\n\n
1.2.1 \u2014 2019-04-24<\/h4>\n\n\n- Enhancements for more compatible with themes.<\/li>\n<\/ul>\n\n
1.2.0 \u2014 2019-04-23<\/h4>\n\n\n- Added float options: \"Center\" and \"Right without flow\".<\/li>\n
- Added setting \"Hash Format\".<\/li>\n
- In anchors instead \"name\" attribute used \"id\".<\/li>\n
- Minor enhancements in CSS for more compatible with themes.<\/li>\n<\/ul>\n\n
1.1.1 \u2014 2019-04-15<\/h4>\n\n\n- Tag <noindex> replaced to <!--noindex-->.<\/li>\n<\/ul>\n\n
1.1.0 \u2014 2019-04-14<\/h4>\n\n\n- Added option \"Wrap table of contents with <noindex> tag\".<\/li>\n
- Added hook filters
lwptoc_before<\/code>, lwptoc_after<\/code>, lwptoc_shortcode_tag<\/code>.<\/li>\n- Fix: into Gutenberg editor in block \"Classic editor\" don't loaded CSS for shortcode.<\/li>\n<\/ul>\n\n
1.0.4 \u2014 2019-11-18<\/h4>\n\n\n- Bug fix<\/li>\n<\/ul>\n\n
1.0.3 \u2014 2019-11-17<\/h4>\n\n\n- Minor appearance changes<\/li>\n
- Bug fix<\/li>\n<\/ul>\n\n
1.0.2 \u2014 2019-11-16<\/h4>\n\n\n