Changeset 12392

Timestamp:

02/09/2023 09:36:57 PM (2 years ago)

Author:

ryelle

Message:

Handbooks: Add a filter to disable the Table of Contents HTML.

The redesigned sites will use the Table of Contents block, so they need a method for disabling the native handbook ToC.

Fixes ​https://github.com/WordPress/wporg-developer/issues/204.
See [12327] for the same change to HelpHub.

File:

• sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/inc/table-of-contents.php (modified) (1 diff)

sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/inc/table-of-contents.php

@@ -85 +85 @@
 
     public function load_filters() {
-        if ( is_singular( $this->post_types ) && ! is_embed() ) {
+        $page_supports_toc = is_singular( $this->post_types ) && ! is_embed();
+
+        /**
+         * Filter whether the table of contents should be injected into the page.
+         *
+         * @param bool $page_supports_toc True if the current page supports a table of contents.
+         */
+        $should_add_toc = apply_filters( 'wporg_handbook_toc_should_add_toc', $page_supports_toc );
+
+        if ( $should_add_toc ) {
             add_filter( 'the_content', array( $this, 'add_toc' ) );
         }