Changeset 3281

Timestamp:

05/31/2016 08:10:44 PM (10 years ago)

Author:

coffee2code

Message:

developer.wordpress.org: Set handbook-related flags and data once via query variables rather than assuming (or always checking for) the presence of handbook plugin template tags.

Specifically sets 'is_handbook', 'current_handbook', 'current_handbook_home_url', 'current_handbook_name'.

Props keesiemeijer.
Fixes #1671.

Location:

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

Files:

• inc/extras.php (modified) (1 diff)
• inc/handbooks.php (modified) (2 diffs)
• inc/redirects.php (modified) (1 diff)
• inc/search.php (modified) (1 diff)
• inc/user-content.php (modified) (1 diff)
• searchform.php (modified) (1 diff)

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

@@ -97 +97 @@
  */
 function wporg_filter_archive_excerpt( $excerpt ) {
-    if ( ! is_single() && ! wporg_is_handbook() ) {
+    if ( ! is_single() && ! get_query_var( 'is_handbook' ) ) {
 
         $post_id = get_the_ID();

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

@@ -35 +35 @@
      */
     public static function do_init() {
+        add_filter( 'query_vars',  array( __CLASS__, 'add_query_vars' ) );
+
+        add_action( 'pre_get_posts',  array( __CLASS__, 'pre_get_posts' ), 9 );
+
         add_action( 'after_switch_theme', array( __CLASS__, 'add_roles' ) );
 
@@ -52 +56 @@
             add_filter( 'syntaxhighlighter_htmlresult', array( __CLASS__, 'syntaxhighlighter_htmlresult' ) );
         }
+    }
+
+    /**
+     * Add public query vars for handbooks.
+     *
+     * @param array   $public_query_vars The array of whitelisted query variables.
+     * @return array Array with public query vars.
+     */
+    public static function add_query_vars( $public_query_vars ) {
+        $public_query_vars['is_handbook'] = false;
+        $public_query_vars['current_handbook'] = false;
+        $public_query_vars['current_handbook_home_url'] = false;
+        $public_query_vars['current_handbook_name'] = '';
+
+        return $public_query_vars;
+    }
+
+    /**
+     * Add handbook query vars to the current query.
+     *
+     * @param \WP_Query $query
+     */
+    public static function pre_get_posts( $query ) {
+        $is_handbook = function_exists( 'wporg_is_handbook' ) ? wporg_is_handbook() : false;
+        $query->set( 'is_handbook', $is_handbook );
+
+        $current_handbook = function_exists( 'wporg_get_current_handbook' ) ? wporg_get_current_handbook() : false;
+        $query->set( 'current_handbook', $current_handbook );
+
+        $current_handbook_home_url = function_exists( 'wporg_get_current_handbook_home_url' ) ? wporg_get_current_handbook_home_url() : false;
+        $query->set( 'current_handbook_home_url', $current_handbook_home_url );
+
+        $current_handbook_name = function_exists( 'wporg_get_current_handbook_name' ) ? wporg_get_current_handbook_name() : '';
+        $query->set( 'current_handbook_name', $current_handbook_name );
     }
 

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

@@ -33 +33 @@
      */
     public static function redirect_single_search_match() {
-        if ( is_search() && ! wporg_is_handbook() && 1 == $GLOBALS['wp_query']->found_posts ) {
+        if ( is_search() && ! get_query_var( 'is_handbook' ) && 1 == $GLOBALS['wp_query']->found_posts ) {
             wp_redirect( get_permalink( get_post() ) );
             exit();

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

@@ -60 +60 @@
         // Separates searches for handbook pages from non-handbook pages depending on
         // whether the search was performed within context of a handbook page or not.
-        if ( wporg_is_handbook() ) {
+        if ( get_query_var( 'is_handbook' ) ) {
             // Search only in current handbook post type.
             // Just to make sure. post type should already be set.

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

@@ -63 +63 @@
     public static function scripts_and_styles() {
         if ( is_singular() ) {
-            if ( '0' != get_comments_number() || \DevHub\post_type_has_source_code() || wporg_is_handbook_post_type() ) {
+            if ( '0' != get_comments_number() || \DevHub\post_type_has_source_code() || get_query_var( 'is_handbook' ) ) {
                 wp_enqueue_script( 'wporg-developer-function-reference', get_template_directory_uri() . '/js/function-reference.js', array( 'jquery', 'syntaxhighlighter-core', 'syntaxhighlighter-brush-php' ), '20150319', true );
                 wp_enqueue_style( 'syntaxhighlighter-core' );

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

@@ -35 +35 @@
 
     <?php
-        $is_handbook = wporg_is_handbook();
-        $search_url  = $is_handbook ? wporg_get_current_handbook_home_url() : home_url( '/' );
+        $is_handbook = get_query_var( 'is_handbook' );
+        $search_url  = get_query_var( 'current_handbook_home_url' );
+        $search_url  = $search_url ? $search_url : home_url( '/' );
         $form_class  = $is_handbook ? ' searchform-handbook' : '';
     ?>