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

Timestamp:

07/06/2016 06:24:34 PM (8 years ago)

Author:

drewapicture

Message:

developer.wordpress.org: Allow WPorg_Handbook_TOC to accept optional display arguments for overriding values such as the header text for the Table of Contents container.

See #1802.

File:

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

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

@@ -10 +10 @@
     protected $styles = '<style> .toc-jump { text-align: right; font-size: 12px; } .page .toc-heading { margin-top: -50px; padding-top: 50px !important; }</style>';
 
-    function __construct( $post_types ) {
+    /**
+     * Arguments.
+     *
+     * @access protected
+     * @var array
+     */
+    protected $args = array();
+
+    /**
+     * Constructor.
+     *
+     * @access public
+     *
+     * @param array $post_types Post types.
+     * @param array $args {
+     *     Optional. Table of Contents arguments. Defualt emtpy array.
+     *
+     *     @type string $header_text Header text for the table. HTML-escaped on output.
+     * }
+     */
+    public function __construct( $post_types, $args = array() ) {
         $this->post_types = (array) $post_types;
         add_action( 'template_redirect', array( $this, 'load_filters' ) );
+
+        $this->args = (object) wp_parse_args( $args, array(
+            'header_text' => __( 'Topics', 'wporg' ),
+        ) );
     }
 
@@ -30 +54 @@
     }
 
-    function add_toc( $content ) {
+    /**
+     * Converts given content to dynamically add the ToC.
+     *
+     * @access public
+     *
+     * @param string $content Content.
+     * @return string Modified content.
+     */
+    public function add_toc( $content ) {
         $toc = '';
 
@@ -42 +74 @@
             $toc .= $this->styles;
             $toc .= '<div class="table-of-contents">';
-            $toc .= "<$contents_header>" . __( 'Topics', 'wporg' ) . "</$contents_header><ul class=\"items\">";
+            $toc .= "<$contents_header>" . esc_html( $this->args->header_text ) . "</$contents_header><ul class=\"items\">";
             $last_item = false;
             foreach ( $items as $item ) {