Changeset 8961 for sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/handbooks.php

Timestamp:

06/19/2019 05:04:11 AM (6 years ago)

Author:

coffee2code

Message:

Developer: Create Common APIs handbook.

Handbook is currently only accessible to logged-in users.

See #4376.

File:

• sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/handbooks.php (modified) (7 diffs)

sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/handbooks.php

@@ -20 +20 @@
 
     /**
+     * Hidden handbook post types.
+     *
+     * Note: Hidden only from users who aren't logged in.
+     *
+     * @var array
+     * @access public
+     */
+    public static $hidden_handbooks = [ 'apis-handbook' ];
+
+    /**
      * Initializer
      *
@@ -25 +35 @@
      */
     public static function init() {
+        add_filter( 'handbook_label', array( __CLASS__, 'change_handbook_label' ), 10, 2 );
         add_filter( 'handbook_post_type_defaults', array( __CLASS__, 'filter_handbook_post_type_defaults' ), 10, 2 );
         add_filter( 'handbook_post_types', array( __CLASS__, 'filter_handbook_post_types' ) );
@@ -37 +48 @@
     public static function do_init() {
         add_filter( 'query_vars',  array( __CLASS__, 'add_query_vars' ) );
+
+        add_action( 'template_redirect', array( __CLASS__, 'redirect_hidden_handbooks' ), 1 );
 
         add_action( 'pre_get_posts',  array( __CLASS__, 'pre_get_posts' ), 9 );
@@ -70 +83 @@
 
     /**
+     * Redirects handbooks that should be inaccessible to visitors who aren't logged in.
+     */
+    public static function redirect_hidden_handbooks() {
+        if ( ! self::$hidden_handbooks || get_current_user_id() || ! function_exists( 'wporg_is_handbook' ) || ! wporg_is_handbook() ) {
+            return;
+        }
+
+        if ( in_array( wporg_get_current_handbook(), self::$hidden_handbooks ) ) {
+            wp_safe_redirect( home_url() );
+            exit();
+        }   
+    }
+
+    /**
      * Add handbook query vars to the current query.
      *
@@ -88 +115 @@
 
     /**
-     * Filter handbook post types to create handbooks for: plugins, themes.
+     * Filter handbook post types to create handbooks for: apis, plugins, themes.
      *
      * @access public
@@ -97 +124 @@
     public static function filter_handbook_post_types( $types ) {
         if ( ! self::$post_types ) {
-            self::$post_types = apply_filters( 'devhub_handbook_post_types', [ 'plugin', 'theme' ] );
+            self::$post_types = apply_filters( 'devhub_handbook_post_types', [ 'apis', 'plugin', 'theme' ] );
         }
 
@@ -241 +268 @@
     }
 
+    /**
+     * Overrides the default handbook label when post type name does not directly
+     * translate to post type label.
+     *
+     * @param string $label     The default label, which is merely a sanitized
+     *                          version of the handbook name.
+     * @param string $post_type The handbook post type.
+     * @return string
+     */
+    public static function change_handbook_label( $label, $post_type ) {
+        if ( 'apis-handbook' === $post_type ) {
+            $label = __( 'Common APIs Handbook', 'wporg' );
+        }
+
+        return $label;
+    }
+
 } // Devhub_Handbooks