Context Navigation

Changeset 10768

Timestamp:

03/05/2021 12:05:23 AM (4 years ago)

Author:

coffee2code

Message:

Handbooks: Use WPorg_Handbook_Init::get_post_types() as the canonical source for obtaining all handbook post types.

Location:

Files:

-                      r10764
+                      r10768
     /**
      * Constructor
+     *
+     * @param string $type   The post type for the handbook.
      */
     public function __construct( $type ) {
+        if ( 'handbook' !== $type ) {
+            $this->post_type = $type . '-handbook';
+        } else {
+            $this->post_type = $type;
+        }
+        $this->post_type = sanitize_title( $type );
         $this->label = ucwords( str_replace( [ '-', '_' ], ' ', $this->post_type ) );

-                      r10767
+                      r10768
          * @param array $handbooks Array of handbook post types. Default 'handbook'.
          */
+        return (array) apply_filters( 'handbook_post_types', array( 'handbook' ) );
+        $post_types = (array) apply_filters( 'handbook_post_types', [ 'handbook' ] );
+        return array_map(
+            function( $pt ) {
+                $pt = sanitize_title( $pt );
+                return ( in_array( $pt, [ 'handbook', 'page' ] ) || false !== strpos( $pt, '-handbook' ) ) ? $pt : $pt . '-handbook';
+            },
+            $post_types
+        );
+    }

-                      r8899
+                      r10768
     function load_filters() {
-        $this->post_types = array_map( array( $this, 'append_suffix' ), $this->post_types );
         if ( is_singular( $this->post_types ) && ! is_embed() ) {
             add_filter( 'the_content', array( $this, 'add_toc' ) );
+        }
+    }
-    function append_suffix( $t ) {
-        if ( in_array( $t, array( 'handbook', 'page' ) ) ) {
-            return $t;
+        }
-        return $t . '-handbook';
+    }

-                      r10763
+                      r10768
  * Wrapper function for WPorg_Handbook_Init::get_post_types().
+ *
  * @return array Array with full handbook post type names {post-type}-handbook.
+ * @return array Array of handbook post types.
  */
 function wporg_get_handbook_post_types() {
 …
+    }
+    $post_types = WPorg_Handbook_Init::get_post_types();
+    foreach ( $post_types as $key => $post_type ) {
+        if ( 'handbook' !== $post_type ) {
+            $post_types[ $key ] = $post_type . '-handbook';
+        }
+    }
+    return $post_types;
+    return WPorg_Handbook_Init::get_post_types();
+}

-                      r10187
+                      r10768
 class WPorg_Handbook_Watchlist {
     private static $post_types = array( 'handbook' );
+    private static $post_types;
     public static function init() {
 …
     public static function on_init() {
+        self::$post_types = (array) apply_filters( 'handbook_post_types', self::$post_types );
+        self::$post_types = array_map( array( __CLASS__, 'append_suffix' ), self::$post_types );
+        self::$post_types = WPorg_Handbook_Init::get_post_types();
         add_action( 'p2_action_links', array(__CLASS__, 'display_action_link'), 100 );
         add_filter( 'o2_filter_post_actions', array( __CLASS__, 'add_o2_action_link' ) );
         add_filter( 'o2_filter_post_action_html', array( __CLASS__, 'get_o2_action_link' ), 10, 2 );
+    }
-    /**
-     * Appends '-handbook' to the dynamic post type, if not already 'handbook'.
+     *
-     * @param  string $t Hanbook post type name.
-     * @return string
-     */
-    private static function append_suffix( $t ) {
-        if ( in_array( $t, array( 'handbook', 'page' ) ) ) {
-            return $t;
+        }
-        return $t . '-handbook';
+    }

-                      r8942
+                      r10768
     protected static $widget_id_base = 'handbook_pages';
     protected $post_types = array( 'handbook' );
+    protected $post_types;
     /**
 …
+        }
+        $this->post_types = (array) apply_filters( 'handbook_post_types', $this->post_types );
+        $this->post_types = array_map( array( $this, 'append_suffix' ), $this->post_types );
+        $this->post_types = WPorg_Handbook_Init::get_post_types();
         $post_type = '';
 …
         // Exclude root handbook page from the table of contents.
         $page = get_page_by_path( $this->append_suffix( $post_type ), OBJECT, $post_type );
+        $page = get_page_by_path( $post_type, OBJECT, $post_type );
         if ( ! $page ) {
             $slug = substr( $post_type, 0, -9 );
 …
         return $args;
+    }
-    public function append_suffix( $t ) {
-        if ( in_array( $t, array( 'handbook', 'page' ) ) ) {
-            return $t;
+        }
-        return $t . '-handbook';
+    }

-                      r10765
+                      r10768
+    }
+    public function test_get_post_types_custom() {
+        reinit_handbooks( [ 'plugins-handbook', 'themes' ], 'post_types' );
+        // Note: The automatic appending of '-handbook' is for back-compat.
+        $this->assertEquals( ['plugins-handbook', 'themes-handbook'], WPorg_Handbook_Init::get_post_types() );
+    }
     public function test_get_post_types_filtered() {
+        add_filter( 'handbook_post_types', function ( $post_types ) {
+            $post_types[] = 'example';
+            return $post_types;
+        }, 11 );
         reinit_handbooks( [ 'plugins', 'themes' ], 'post_types' );
         // Note: The automatic appending of '-handbook' is for back-compat.
         $this->assertEquals( ['plugins-handbook', 'themes-handbook'], WPorg_Handbook_Init::get_post_types() );
+        $this->assertEquals( [ 'plugins-handbook', 'themes-handbook', 'example-handbook' ], WPorg_Handbook_Init::get_post_types() );
+    }

Note: See TracChangeset for help on using the changeset viewer.