Changeset 10769 for sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/inc/handbook.php

Timestamp:

03/05/2021 12:21:47 AM (5 years ago)

Author:

coffee2code

Message:

Handbooks, Init & Handbook: Improve multi-handbook support and configuration handling

Init:

• Introduce 'handbooks_config' as filter for defining and configuring handbooks
• Deprecate 'handbook_post_types' as filter for defining handbooks
• Store handbook objects as an associative array with post types as keys
• Discontinue explicitly memoizing handbook post types
• Introduce get_handbooks_config() to retrieve config for a particular handbook or all handbooks

Handbook:

• Change constructor to accept config array as optional arg
• Introduce get_config() as a getter to return handbook's config
• Start with 'label' and 'slug' as a config options

File:

• sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/inc/handbook.php (modified) (5 diffs)

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

@@ -14 +14 @@
      */
     public $post_type = '';
+
+    /**
+     * The handbook's settings.
+     *
+     * @var array
+     */
+    public $settings = [];
 
     /**
@@ -60 +67 @@
 
     /**
+     * Returns handbook default config.
+     *
+     * @return array
+     */
+    public static function get_default_handbook_config() {
+        /**
+         * Filters default handbook configuration array.
+         *
+         * @param string $slug The slug for the post type. Default is post type.
+         */
+        return (array) apply_filters( 'handbook_default_handbook_config', [
+            'label'         => '',
+            'slug'          => '',
+        ] );
+    }
+
+    /**
      * Returns the handbook name.
      *
@@ -95 +119 @@
      *
      * @param string $type   The post type for the handbook.
-     */
-    public function __construct( $type ) {
+     * @param array  $config The config array for the handbook.
+     */
+    public function __construct( $type, $config = [] ) {
         $this->post_type = sanitize_title( $type );
 
-        $this->label = ucwords( str_replace( [ '-', '_' ], ' ', $this->post_type ) );
-        $this->label = apply_filters( 'handbook_label', $this->label, $this->post_type );
+        $config = $this->config = wp_parse_args( $config, self::get_default_handbook_config() );
+
+        $this->label = apply_filters(
+            'handbook_label',
+            $config['label'] ?: ucwords( str_replace( [ '-', '_' ], ' ', $this->post_type ) ),
+            $this->post_type
+        );
 
         $this->setting_name = $this->post_type . '_name';
@@ -127 +157 @@
 
     /**
+     * Returns the configuration array for handbooks.
+     *
+     * @return array
+     */
+    public function get_config() {
+        return $this->config;
+    }
+
+    /**
      * Adds 'Handbook Front Page' post state indicator for handbook landing pages.
      *
@@ -235 +274 @@
      */
     public function register_post_type() {
-        if ( 'handbook' != $this->post_type ) {
-            $slug = substr( $this->post_type, 0, -9 );
+        $config = $this->get_config();
+
+        if ( ! empty( $config['slug'] ) ) {
+            $slug = $config['slug'];
+        } elseif ( 'handbook' !== $this->post_type ) {
+            $slug = str_replace( '-handbook', '', $this->post_type );
         } else {
             $slug = 'handbook';