Ticket #32077: post.php.patch

post.php

@@ -4421 +4421 @@
 }
 
 /**
- * Retrieve a list of pages.
- *
- * @global wpdb $wpdb WordPress database abstraction object.
- *
- * @since 1.5.0
- *
- * @param array|string $args {
- *     Optional. Array or string of arguments to retrieve pages.
- *
- *     @type int          $child_of     Page ID to return child and grandchild pages of.
- *                                      Default 0, or no restriction.
- *     @type string       $sort_order   How to sort retrieved pages. Accepts 'ASC', 'DESC'. Default 'ASC'.
- *     @type string       $sort_column  What columns to sort pages by, comma-separated. Accepts 'post_author',
- *                                      'post_date', 'post_title', 'post_name', 'post_modified', 'menu_order',
- *                                      'post_modified_gmt', 'post_parent', 'ID', 'rand', 'comment_count'.
- *                                      'post_' can be omitted for any values that start with it.
- *                                      Default 'post_title'.
- *     @type bool         $hierarchical Whether to return pages hierarchically. Default true.
- *     @type array        $exclude      Array of page IDs to exclude. Default empty array.
- *     @type array        $include      Array of page IDs to include. Cannot be used with `$child_of`,
- *                                      `$parent`, `$exclude`, `$meta_key`, `$meta_value`, or `$hierarchical`.
- *                                      Default empty array.
- *     @type string       $meta_key     Only include pages with this meta key. Default empty.
- *     @type string       $meta_value   Only include pages with this meta value. Requires `$meta_key`.
- *                                      Default empty.
- *     @type string       $authors      A comma-separated list of author IDs. Default empty.
- *     @type int          $parent       Page ID to return direct children of. `$hierarchical` must be false.
- *                                      Default -1, or no restriction.
- *     @type string|array $exclude_tree Comma-separated string or array of page IDs to exclude.
- *                                      Default empty array.
- *     @type int          $number       The number of pages to return. Default 0, or all pages.
- *     @type int          $offset       The number of pages to skip before returning. Requires `$number`.
- *                                      Default 0.
- *     @type string       $post_type    The post type to query. Default 'page'.
- *     @type string       $post_status  A comma-separated list of post status types to include.
- *                                      Default 'publish'.
- * }
- * @return array List of pages matching defaults or `$args`.
+ * Force input to be an array if not already
+ * @param       mixed   $input  input variable to be coerced into array (not designed as a universal conversion, just the standard WP input strings)
+ * @return      array   an array, even if invalid input given
  */
-function get_pages( $args = array() ) {
-        global $wpdb;
+function wp_coerce_to_array( $input ) {
+        if( is_array( $input ) ){ return $input; } // jump out if nothing to do
+        if ( is_string( $post_status ) ) { // we should check if the status is string, if not there is nothing we can do
+                return explode( ',', $post_status );
+        }
+        return array();
+}
 
-        $defaults = array(
+/**
+ * check if post stati are all valid
+ * @param       array   $stati  an array of post stati to verify against all post stati
+ * @return      bool    true if stati is an array and it matches elements within all post stati
+ */
+function post_stati_valid( $stati ) {
+        // Make sure we have a valid post status.
+        
+        // first lets deal with strings that can become arrays
+        $stati = wp_coerce_to_array( $stati );
+
+        if ( !array_diff( $stati, get_post_stati() ) && !empty($stati) ) {
+                return true;
+        }
+        return false;
+}
+
+/**
+ * provide default options for get_pages to try to make function more managable and process-descriptable
+ */
+function get_pages_defaults() {
+        return  array(
                 'child_of' => 0, 'sort_order' => 'ASC',
                 'sort_column' => 'post_title', 'hierarchical' => 1,
                 'exclude' => array(), 'include' => array(),
@@ -4472 +4463 @@
                 'number' => '', 'offset' => 0,
                 'post_type' => 'page', 'post_status' => 'publish',
         );
+}
 
-        $r = wp_parse_args( $args, $defaults );
+/**
+ * provides parsing of $args input for get_pages
+ * @param       string|array    &$args
+ */
+function get_pages_process_args( &$args ) {
+        $args = wp_parse_args( $args, get_pages_defaults() );
+        $args['number'] = intval($args['number']);
+        $args['offset'] = intval($args['offset']);
+        $args['child_of'] = intval($args['child_of']);
+}
 
-        $number = (int) $r['number'];
-        $offset = (int) $r['offset'];
-        $child_of = (int) $r['child_of'];
-        $hierarchical = $r['hierarchical'];
-        $exclude = $r['exclude'];
-        $meta_key = $r['meta_key'];
-        $meta_value = $r['meta_value'];
-        $parent = $r['parent'];
-        $post_status = $r['post_status'];
-
-        // Make sure the post type is hierarchical.
-        $hierarchical_post_types = get_post_types( array( 'hierarchical' => true ) );
-        if ( ! in_array( $r['post_type'], $hierarchical_post_types ) ) {
-                return false;
-        }
-
-        if ( $parent > 0 && ! $child_of ) {
-                $hierarchical = false;
-        }
-
-        // Make sure we have a valid post status.
-        if ( ! is_array( $post_status ) ) {
-                $post_status = explode( ',', $post_status );
-        }
-        if ( array_diff( $post_status, get_post_stati() ) ) {
-                return false;
-        }
-
-        // $args can be whatever, only use the args defined in defaults to compute the key.
-        $key = md5( serialize( wp_array_slice_assoc( $r, array_keys( $defaults ) ) ) );
+/**
+ * provides boxed caching for get_pages
+ * @param       array|string    $args   the arguments for get_pages, used to build the cache hash key
+ */
+function get_pages_cached( $args ) {
+        global $cache_key;
+        
+        $key = md5( serialize( wp_array_slice_assoc( $args, array_keys( get_pages_defaults() ) ) ) );
         $last_changed = wp_cache_get( 'last_changed', 'posts' );
         if ( ! $last_changed ) {
                 $last_changed = microtime();
@@ -4516 +4495 @@
                 // Convert to WP_Post instances.
                 $pages = array_map( 'get_post', $cache );
                 /** This filter is documented in wp-includes/post.php */
-                $pages = apply_filters( 'get_pages', $pages, $r );
+                $pages = apply_filters( 'get_pages', $pages, $args );
                 return $pages;
         }
+        return false;
+}
 
+/**
+ * provides updating of cache input for get_pages based upon cache_key global hash key
+ * @param       array   &$args  arguments (in parsed form), to get_pages as value
+ * @param       array   &$posts posts returned from get_pages as reference
+ */
+function get_pages_update_cache( $args, &$posts ) {
+        global $cache_key;
+        // Sanitize before caching so it'll only get done once.
+        $num_pages = count( $pages );
+        for ( $i = 0; $i < $num_pages; $i++ ) {
+                $pages[ $i ] = sanitize_post( $pages[ $i ], 'raw' );
+        }
+
+        // Update cache.
+        update_post_cache( $pages );
+
+        if ( $args[ 'child_of' ] || $args[ 'heirarchical' ] ) {
+                $pages = get_page_children( $args[ 'child_of' ], $pages );
+        }
+
+        if ( ! empty( $args[ 'exclude_tree' ] ) ) {
+                $args[ 'exclude' ] = wp_parse_id_list( $args[ 'exclude_tree' ] );
+                foreach( $args[ 'exclude' ] as $id ) {
+                        $children = get_page_children( $id, $pages );
+                        foreach ( $children as $child ) {
+                                $args[ 'exclude' ][] = $child->ID;
+                        }
+                }
+
+                $num_pages = count( $pages );
+                for ( $i = 0; $i < $num_pages; $i++ ) {
+                        if ( in_array( $pages[ $i ]->ID, $args[ 'exclude' ] ) ) {
+                                unset( $pages[ $i ] );
+                        }
+                }
+        }
+
+        $page_structure = array();
+        foreach ( $pages as $page ) {
+                $page_structure[] = $page->ID;
+        }
+        
+        wp_cache_set( $cache_key, $page_structure, 'posts' );
+        
+        // Convert to WP_Post instances
+        $pages = array_map( 'get_post', $pages );
+}
+
+/**
+ * provides / generates includes string for get_pages
+ * @param       array   &$args  arguments (in parsed form), to get_pages as reference
+ * @return      string  a string of SQL / WP_SQL compatible with querying the WP DB
+ */
+function build_get_pages_includes( &$args ) {
         $inclusions = '';
-        if ( ! empty( $r['include'] ) ) {
-                $child_of = 0; //ignore child_of, parent, exclude, meta_key, and meta_value params if using include
-                $parent = -1;
-                $exclude = '';
-                $meta_key = '';
-                $meta_value = '';
-                $hierarchical = false;
-                $incpages = wp_parse_id_list( $r['include'] );
+        if ( ! empty( $args[ 'include' ] ) ) {
+                $args[ 'child_of' ] = 0; //ignore child_of, parent, exclude, meta_key, and meta_value params if using include
+                $args[ 'parent' ] = -1;
+                $args[ 'exclude' ] = '';
+                $args[ 'meta_key' ] = '';
+                $args[ 'meta_value' ] = '';
+                $args[ 'heirarchical' ] = false;
+                $incpages = wp_parse_id_list( $args[ 'include' ] );
                 if ( ! empty( $incpages ) ) {
                         $inclusions = ' AND ID IN (' . implode( ',', $incpages ) .  ')';
                 }
         }
+        return $inclusions;
+}
 
+/**
+ * provides / generates excludes string for get_pages
+ * @param       array|string    $exclude        list of excludes as value
+ * @return      string  a string of SQL / WP_SQL compatible with querying the WP DB
+ */
+function build_get_pages_excludes( $exclude ) {
         $exclusions = '';
         if ( ! empty( $exclude ) ) {
                 $expages = wp_parse_id_list( $exclude );
@@ -4541 +4584 @@
                         $exclusions = ' AND ID NOT IN (' . implode( ',', $expages ) .  ')';
                 }
         }
+        return $exclusions;
+}
 
+/**
+ * provides / generates authors SQL / WP_SQL string for get_pages
+ * @param       array   $authors        list of authors as value
+ * @return      string  a string of SQL / WP_SQL compatible with querying the WP DB
+ */
+function build_get_pages_authors( $authors ) {
         $author_query = '';
-        if ( ! empty( $r['authors'] ) ) {
-                $post_authors = preg_split( '/[\s,]+/', $r['authors'] );
+        if ( ! empty( $authors ) ) {
+                $post_authors = preg_split( '/[\s,]+/', $authors );
 
                 if ( ! empty( $post_authors ) ) {
                         foreach ( $post_authors as $post_author ) {
@@ -4571 +4622 @@
                         }
                 }
         }
+        return $author_query;
+}
 
+/**
+ * logic for retreival of pages and building of SQL / WPSQL string based upon criteria from $args
+ * @param       array   $args   arguments (in parsed form), to get_pages as value
+ * @return      array   an array of posts or empty array if no matched found
+ */
+function build_get_pages_DB( $args ) {
+        global $wpdb;
+
+        $inclusions = build_get_pages_includes( $args );
+        $exclusions = build_get_pages_excludes( $args['exclude'] );
+        $author_query = build_get_pages_authors( $args['authors'] );
+        
         $join = '';
         $where = "$exclusions $inclusions ";
-        if ( '' !== $meta_key || '' !== $meta_value ) {
+        if ( '' !== $args['meta_key'] || '' !== $args['meta_value'] ) {
                 $join = " LEFT JOIN $wpdb->postmeta ON ( $wpdb->posts.ID = $wpdb->postmeta.post_id )";
 
                 // meta_key and meta_value might be slashed
-                $meta_key = wp_unslash($meta_key);
-                $meta_value = wp_unslash($meta_value);
-                if ( '' !== $meta_key ) {
-                        $where .= $wpdb->prepare(" AND $wpdb->postmeta.meta_key = %s", $meta_key);
+                $args['meta_key'] = wp_unslash($args['meta_key']);
+                $args['meta_value'] = wp_unslash($args['meta_value']);
+                if ( '' !== $args['meta_key'] ) {
+                        $where .= $wpdb->prepare(" AND $wpdb->postmeta.meta_key = %s", $args['meta_key']);
                 }
-                if ( '' !== $meta_value ) {
-                        $where .= $wpdb->prepare(" AND $wpdb->postmeta.meta_value = %s", $meta_value);
+                if ( '' !== $args['meta_value'] ) {
+                        $where .= $wpdb->prepare(" AND $wpdb->postmeta.meta_value = %s", $args['meta_value']);
                 }
 
         }
 
-        if ( is_array( $parent ) ) {
-                $post_parent__in = implode( ',', array_map( 'absint', (array) $parent ) );
+        if ( is_array( $args['parent'] ) ) {
+                $post_parent__in = implode( ',', array_map( 'absint', (array) $args['parent'] ) );
                 if ( ! empty( $post_parent__in ) ) {
                         $where .= " AND post_parent IN ($post_parent__in)";
                 }
-        } elseif ( $parent >= 0 ) {
-                $where .= $wpdb->prepare(' AND post_parent = %d ', $parent);
+        } elseif ( $args['parent'] >= 0 ) {
+                $where .= $wpdb->prepare(' AND post_parent = %d ', $args['parent']);
         }
 
-        if ( 1 == count( $post_status ) ) {
-                $where_post_type = $wpdb->prepare( "post_type = %s AND post_status = %s", $r['post_type'], reset( $post_status ) );
+        if ( 1 == count( $args['post_status'] ) ) {
+                $where_post_type = $wpdb->prepare( "post_type = %s AND post_status = %s", $args['post_type'], reset( $args['post_status'] ) );
         } else {
-                $post_status = implode( "', '", $post_status );
-                $where_post_type = $wpdb->prepare( "post_type = %s AND post_status IN ('$post_status')", $r['post_type'] );
+                $args['post_status'] = implode( "', '", $args['post_status'] );
+                $where_post_type = $wpdb->prepare( "post_type = %s AND post_status IN ('".$args['post_status']."')", $args['post_type'] );
         }
 
         $orderby_array = array();
@@ -4610 +4675 @@
                 'post_modified', 'modified_gmt', 'post_modified_gmt', 'menu_order', 'parent', 'post_parent',
                 'ID', 'rand', 'comment_count' );
 
-        foreach ( explode( ',', $r['sort_column'] ) as $orderby ) {
+        foreach ( explode( ',', $args['sort_column'] ) as $orderby ) {
                 $orderby = trim( $orderby );
                 if ( ! in_array( $orderby, $allowed_keys ) ) {
                         continue;
@@ -4641 +4706 @@
         }
         $sort_column = ! empty( $orderby_array ) ? implode( ',', $orderby_array ) : "$wpdb->posts.post_title";
 
-        $sort_order = strtoupper( $r['sort_order'] );
+        $sort_order = strtoupper( $args['sort_order'] );
         if ( '' !== $sort_order && ! in_array( $sort_order, array( 'ASC', 'DESC' ) ) ) {
                 $sort_order = 'ASC';
         }
@@ -4650 +4715 @@
         $query .= $author_query;
         $query .= " ORDER BY " . $sort_column . " " . $sort_order ;
 
-        if ( ! empty( $number ) ) {
-                $query .= ' LIMIT ' . $offset . ',' . $number;
+        if ( ! empty( $args['number'] ) ) {
+                $query .= ' LIMIT ' . $args['offset'] . ',' . $args['number'];
         }
 
-        $pages = $wpdb->get_results($query);
+        return $wpdb->get_results($query);
+}
 
-        if ( empty($pages) ) {
-                /** This filter is documented in wp-includes/post.php */
-                $pages = apply_filters( 'get_pages', array(), $r );
-                return $pages;
-        }
+/**
+ * Retrieve a list of pages.
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
+ * @since 1.5.0
+ *
+ * @param array|string $args {
+ *     Optional. Array or string of arguments to retrieve pages.
+ *
+ *     @type int          $child_of     Page ID to return child and grandchild pages of.
+ *                                      Default 0, or no restriction.
+ *     @type string       $sort_order   How to sort retrieved pages. Accepts 'ASC', 'DESC'. Default 'ASC'.
+ *     @type string       $sort_column  What columns to sort pages by, comma-separated. Accepts 'post_author',
+ *                                      'post_date', 'post_title', 'post_name', 'post_modified', 'menu_order',
+ *                                      'post_modified_gmt', 'post_parent', 'ID', 'rand', 'comment_count'.
+ *                                      'post_' can be omitted for any values that start with it.
+ *                                      Default 'post_title'.
+ *     @type bool         $hierarchical Whether to return pages hierarchically. Default true.
+ *     @type array        $exclude      Array of page IDs to exclude. Default empty array.
+ *     @type array        $include      Array of page IDs to include. Cannot be used with `$child_of`,
+ *                                      `$parent`, `$exclude`, `$meta_key`, `$meta_value`, or `$hierarchical`.
+ *                                      Default empty array.
+ *     @type string       $meta_key     Only include pages with this meta key. Default empty.
+ *     @type string       $meta_value   Only include pages with this meta value. Requires `$meta_key`.
+ *                                      Default empty.
+ *     @type string       $authors      A comma-separated list of author IDs. Default empty.
+ *     @type int          $parent       Page ID to return direct children of. `$hierarchical` must be false.
+ *                                      Default -1, or no restriction.
+ *     @type string|array $exclude_tree Comma-separated string or array of page IDs to exclude.
+ *                                      Default empty array.
+ *     @type int          $number       The number of pages to return. Default 0, or all pages.
+ *     @type int          $offset       The number of pages to skip before returning. Requires `$number`.
+ *                                      Default 0.
+ *     @type string       $post_type    The post type to query. Default 'page'.
+ *     @type string       $post_status  A comma-separated list of post status types to include.
+ *                                      Default 'publish'.
+ * }
+ * @return array List of pages matching defaults or `$args`.
+ */
+function get_pages( $args = array() ) {
 
-        // Sanitize before caching so it'll only get done once.
-        $num_pages = count($pages);
-        for ($i = 0; $i < $num_pages; $i++) {
-                $pages[$i] = sanitize_post($pages[$i], 'raw');
-        }
+        // moved key here to preserve caching
+        $pages = get_pages_cached( $args ); // if pages from cache
+        if( !$pages ) {
+                get_pages_process_args( $args );
 
-        // Update cache.
-        update_post_cache( $pages );
+                // Make sure the post type is hierarchical before wasting too much energy.
+                $heirarchical_post_types = get_post_types( array( 'hierarchical' => true ) );
+                if ( ! in_array( $args['post_type'], $heirarchical_post_types ) ) {
+                        return false;
+                }
 
-        if ( $child_of || $hierarchical ) {
-                $pages = get_page_children($child_of, $pages);
-        }
-
-        if ( ! empty( $r['exclude_tree'] ) ) {
-                $exclude = wp_parse_id_list( $r['exclude_tree'] );
-                foreach( $exclude as $id ) {
-                        $children = get_page_children( $id, $pages );
-                        foreach ( $children as $child ) {
-                                $exclude[] = $child->ID;
-                        }
+                if ( $args[ 'parent' ] > 0 && ! $args[ 'child_of' ] ) {
+                        $args[ 'heirarchical' ] = false;
                 }
 
-                $num_pages = count( $pages );
-                for ( $i = 0; $i < $num_pages; $i++ ) {
-                        if ( in_array( $pages[$i]->ID, $exclude ) ) {
-                                unset( $pages[$i] );
-                        }
-                }
+                if ( post_stati_valid( $args['post_status'] ) ) { return false; } // checking if post status is valid function added to DRY out this code
+                
+                $pages = build_get_pages_DB( $args );
         }
 
-        $page_structure = array();
-        foreach ( $pages as $page ) {
-                $page_structure[] = $page->ID;
+        if( !empty( $pages ) ) {
+                get_pages_update_cache( $args, $pages );
+        } else {
+                // this was a really strange check on this, here we simplify
+                $pages = array();
         }
-
-        wp_cache_set( $cache_key, $page_structure, 'posts' );
-
-        // Convert to WP_Post instances
-        $pages = array_map( 'get_post', $pages );
-
+        
         /**
          * Filter the retrieved list of pages.
          *
@@ -4708 +4797 @@
          * @since 2.1.0
          *
          * @param array $pages List of pages to retrieve.
-         * @param array $r     Array of get_pages() arguments.
+         * @param array $args     Array of get_pages() arguments.
          */
-        $pages = apply_filters( 'get_pages', $pages, $r );
+        $pages = apply_filters( 'get_pages', $pages, $args );
 
         return $pages;
 }