X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/256a3b381f63716209b3527d0a14442ae570c283..073c5ed6408e2f00dc1863b463fe205467628905:/wp-includes/query.php diff --git a/wp-includes/query.php b/wp-includes/query.php index 1ec9566c..c5c1ae65 100644 --- a/wp-includes/query.php +++ b/wp-includes/query.php @@ -5,7 +5,7 @@ * The query API attempts to get which part of WordPress the user is on. It * also provides functionality for getting URL query information. * - * @link http://codex.wordpress.org/The_Loop More information on The Loop. + * @link https://codex.wordpress.org/The_Loop More information on The Loop. * * @package WordPress * @subpackage Query @@ -14,28 +14,31 @@ /** * Retrieve variable in the WP_Query class. * - * @see WP_Query::get() * @since 1.5.0 - * @uses $wp_query + * @since 3.9.0 The `$default` argument was introduced. * - * @param string $var The variable key to retrieve. - * @return mixed + * @global WP_Query $wp_query Global WP_Query instance. + * + * @param string $var The variable key to retrieve. + * @param mixed $default Optional. Value to return if the query variable is not set. Default empty. + * @return mixed Contents of the query variable. */ -function get_query_var($var) { +function get_query_var( $var, $default = '' ) { global $wp_query; - - return $wp_query->get($var); + return $wp_query->get( $var, $default ); } /** - * Retrieve the currently-queried object. Wrapper for $wp_query->get_queried_object() + * Retrieve the currently-queried object. * - * @uses WP_Query::get_queried_object + * Wrapper for WP_Query::get_queried_object(). * * @since 3.1.0 * @access public * - * @return object + * @global WP_Query $wp_query Global WP_Query instance. + * + * @return object Queried object. */ function get_queried_object() { global $wp_query; @@ -43,14 +46,15 @@ function get_queried_object() { } /** - * Retrieve ID of the current queried object. Wrapper for $wp_query->get_queried_object_id() + * Retrieve ID of the current queried object. * - * @uses WP_Query::get_queried_object_id() + * Wrapper for WP_Query::get_queried_object_id(). * * @since 3.1.0 - * @access public * - * @return int + * @global WP_Query $wp_query Global WP_Query instance. + * + * @return int ID of the queried object. */ function get_queried_object_id() { global $wp_query; @@ -60,31 +64,35 @@ function get_queried_object_id() { /** * Set query variable. * - * @see WP_Query::set() * @since 2.2.0 - * @uses $wp_query * - * @param string $var Query variable key. - * @param mixed $value - * @return null + * @global WP_Query $wp_query Global WP_Query instance. + * + * @param string $var Query variable key. + * @param mixed $value Query variable value. */ -function set_query_var($var, $value) { +function set_query_var( $var, $value ) { global $wp_query; - - return $wp_query->set($var, $value); + $wp_query->set( $var, $value ); } /** - * Set up The Loop with query parameters. + * Sets up The Loop with query parameters. * - * This will override the current WordPress Loop and shouldn't be used more than - * once. This must not be used within the WordPress Loop. + * Note: This function will completely override the main query and isn't intended for use + * by plugins or themes. Its overly-simplistic approach to modifying the main query can be + * problematic and should be avoided wherever possible. In most cases, there are better, + * more performant options for modifying the main query such as via the {@see 'pre_get_posts'} + * action within WP_Query. + * + * This must not be used within the WordPress Loop. * * @since 1.5.0 - * @uses $wp_query * - * @param string $query - * @return array List of posts + * @global WP_Query $wp_query Global WP_Query instance. + * + * @param array|string $query Array or string of WP_Query arguments. + * @return array List of post objects. */ function query_posts($query) { $GLOBALS['wp_query'] = new WP_Query(); @@ -92,14 +100,16 @@ function query_posts($query) { } /** - * Destroy the previous query and set up a new query. + * Destroys the previous query and sets up a new query. * - * This should be used after {@link query_posts()} and before another {@link - * query_posts()}. This will remove obscure bugs that occur when the previous - * wp_query object is not destroyed properly before another is set up. + * This should be used after query_posts() and before another query_posts(). + * This will remove obscure bugs that occur when the previous WP_Query object + * is not destroyed properly before another is set up. * * @since 2.3.0 - * @uses $wp_query + * + * @global WP_Query $wp_query Global WP_Query instance. + * @global WP_Query $wp_the_query Copy of the global WP_Query instance created during wp_reset_query(). */ function wp_reset_query() { $GLOBALS['wp_query'] = $GLOBALS['wp_the_query']; @@ -111,11 +121,15 @@ function wp_reset_query() { * the $post global to the current post in the main query. * * @since 3.0.0 - * @uses $wp_query + * + * @global WP_Query $wp_query Global WP_Query instance. */ function wp_reset_postdata() { global $wp_query; - $wp_query->reset_postdata(); + + if ( isset( $wp_query ) ) { + $wp_query->reset_postdata(); + } } /* @@ -127,9 +141,9 @@ function wp_reset_postdata() { * * Month, Year, Category, Author, Post Type archive... * - * @see WP_Query::is_archive() * @since 1.5.0 - * @uses $wp_query + * + * @global WP_Query $wp_query Global WP_Query instance. * * @return bool */ @@ -137,7 +151,7 @@ function is_archive() { global $wp_query; if ( ! isset( $wp_query ) ) { - _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1' ); + _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1.0' ); return false; } @@ -147,18 +161,18 @@ function is_archive() { /** * Is the query for an existing post type archive page? * - * @see WP_Query::is_post_type_archive() * @since 3.1.0 - * @uses $wp_query * - * @param mixed $post_types Optional. Post type or array of posts types to check against. + * @global WP_Query $wp_query Global WP_Query instance. + * + * @param string|array $post_types Optional. Post type or array of posts types to check against. * @return bool */ function is_post_type_archive( $post_types = '' ) { global $wp_query; if ( ! isset( $wp_query ) ) { - _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1' ); + _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1.0' ); return false; } @@ -168,21 +182,22 @@ function is_post_type_archive( $post_types = '' ) { /** * Is the query for an existing attachment page? * - * @see WP_Query::is_attachment() * @since 2.0.0 - * @uses $wp_query * + * @global WP_Query $wp_query Global WP_Query instance. + * + * @param int|string|array|object $attachment Attachment ID, title, slug, or array of such. * @return bool */ -function is_attachment() { +function is_attachment( $attachment = '' ) { global $wp_query; if ( ! isset( $wp_query ) ) { - _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1' ); + _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1.0' ); return false; } - return $wp_query->is_attachment(); + return $wp_query->is_attachment( $attachment ); } /** @@ -191,9 +206,9 @@ function is_attachment() { * If the $author parameter is specified, this function will additionally * check if the query is for one of the authors specified. * - * @see WP_Query::is_author() * @since 1.5.0 - * @uses $wp_query + * + * @global WP_Query $wp_query Global WP_Query instance. * * @param mixed $author Optional. User ID, nickname, nicename, or array of User IDs, nicknames, and nicenames * @return bool @@ -202,7 +217,7 @@ function is_author( $author = '' ) { global $wp_query; if ( ! isset( $wp_query ) ) { - _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1' ); + _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1.0' ); return false; } @@ -215,9 +230,9 @@ function is_author( $author = '' ) { * If the $category parameter is specified, this function will additionally * check if the query is for one of the categories specified. * - * @see WP_Query::is_category() * @since 1.5.0 - * @uses $wp_query + * + * @global WP_Query $wp_query Global WP_Query instance. * * @param mixed $category Optional. Category ID, name, slug, or array of Category IDs, names, and slugs. * @return bool @@ -226,7 +241,7 @@ function is_category( $category = '' ) { global $wp_query; if ( ! isset( $wp_query ) ) { - _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1' ); + _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1.0' ); return false; } @@ -239,9 +254,9 @@ function is_category( $category = '' ) { * If the $tag parameter is specified, this function will additionally * check if the query is for one of the tags specified. * - * @see WP_Query::is_tag() * @since 2.3.0 - * @uses $wp_query + * + * @global WP_Query $wp_query Global WP_Query instance. * * @param mixed $tag Optional. Tag ID, name, slug, or array of Tag IDs, names, and slugs. * @return bool @@ -250,7 +265,7 @@ function is_tag( $tag = '' ) { global $wp_query; if ( ! isset( $wp_query ) ) { - _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1' ); + _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1.0' ); return false; } @@ -258,7 +273,7 @@ function is_tag( $tag = '' ) { } /** - * Is the query for an existing taxonomy archive page? + * Is the query for an existing custom taxonomy archive page? * * If the $taxonomy parameter is specified, this function will additionally * check if the query is for that specific $taxonomy. @@ -267,51 +282,31 @@ function is_tag( $tag = '' ) { * this function will additionally check if the query is for one of the terms * specified. * - * @see WP_Query::is_tax() * @since 2.5.0 - * @uses $wp_query * - * @param mixed $taxonomy Optional. Taxonomy slug or slugs. - * @param mixed $term Optional. Term ID, name, slug or array of Term IDs, names, and slugs. - * @return bool + * @global WP_Query $wp_query Global WP_Query instance. + * + * @param string|array $taxonomy Optional. Taxonomy slug or slugs. + * @param int|string|array $term Optional. Term ID, name, slug or array of Term IDs, names, and slugs. + * @return bool True for custom taxonomy archive pages, false for built-in taxonomies (category and tag archives). */ function is_tax( $taxonomy = '', $term = '' ) { global $wp_query; if ( ! isset( $wp_query ) ) { - _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1' ); + _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1.0' ); return false; } return $wp_query->is_tax( $taxonomy, $term ); } -/** - * Whether the current URL is within the comments popup window. - * - * @see WP_Query::is_comments_popup() - * @since 1.5.0 - * @uses $wp_query - * - * @return bool - */ -function is_comments_popup() { - global $wp_query; - - if ( ! isset( $wp_query ) ) { - _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1' ); - return false; - } - - return $wp_query->is_comments_popup(); -} - /** * Is the query for an existing date archive? * - * @see WP_Query::is_date() * @since 1.5.0 - * @uses $wp_query + * + * @global WP_Query $wp_query Global WP_Query instance. * * @return bool */ @@ -319,7 +314,7 @@ function is_date() { global $wp_query; if ( ! isset( $wp_query ) ) { - _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1' ); + _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1.0' ); return false; } @@ -329,9 +324,9 @@ function is_date() { /** * Is the query for an existing day archive? * - * @see WP_Query::is_day() * @since 1.5.0 - * @uses $wp_query + * + * @global WP_Query $wp_query Global WP_Query instance. * * @return bool */ @@ -339,7 +334,7 @@ function is_day() { global $wp_query; if ( ! isset( $wp_query ) ) { - _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1' ); + _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1.0' ); return false; } @@ -349,9 +344,9 @@ function is_day() { /** * Is the query for a feed? * - * @see WP_Query::is_feed() * @since 1.5.0 - * @uses $wp_query + * + * @global WP_Query $wp_query Global WP_Query instance. * * @param string|array $feeds Optional feed types to check. * @return bool @@ -360,7 +355,7 @@ function is_feed( $feeds = '' ) { global $wp_query; if ( ! isset( $wp_query ) ) { - _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1' ); + _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1.0' ); return false; } @@ -370,9 +365,9 @@ function is_feed( $feeds = '' ) { /** * Is the query for a comments feed? * - * @see WP_Query::is_comments_feed() * @since 3.0.0 - * @uses $wp_query + * + * @global WP_Query $wp_query Global WP_Query instance. * * @return bool */ @@ -380,7 +375,7 @@ function is_comment_feed() { global $wp_query; if ( ! isset( $wp_query ) ) { - _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1' ); + _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1.0' ); return false; } @@ -399,10 +394,9 @@ function is_comment_feed() { * * Otherwise the same as @see is_home() * - * @see WP_Query::is_front_page() * @since 2.5.0 - * @uses is_home() - * @uses get_option() + * + * @global WP_Query $wp_query Global WP_Query instance. * * @return bool True, if front of site. */ @@ -410,7 +404,7 @@ function is_front_page() { global $wp_query; if ( ! isset( $wp_query ) ) { - _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1' ); + _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1.0' ); return false; } @@ -418,28 +412,28 @@ function is_front_page() { } /** - * Is the query for the blog homepage? - * - * This is the page which shows the time based blog content of your site. + * Determines if the query is for the blog homepage. * - * Depends on the site's "Front page displays" Reading Settings 'show_on_front' and 'page_for_posts'. + * The blog homepage is the page that shows the time-based blog content of the site. * - * If you set a static page for the front page of your site, this function will return - * true only on the page you set as the "Posts page". + * is_home() is dependent on the site's "Front page displays" Reading Settings 'show_on_front' + * and 'page_for_posts'. * - * @see is_front_page() + * If a static page is set for the front page of the site, this function will return true only + * on the page you set as the "Posts page". * - * @see WP_Query::is_home() * @since 1.5.0 - * @uses $wp_query * - * @return bool True if blog view homepage. + * @see is_front_page() + * @global WP_Query $wp_query Global WP_Query instance. + * + * @return bool True if blog view homepage, otherwise false. */ function is_home() { global $wp_query; if ( ! isset( $wp_query ) ) { - _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1' ); + _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1.0' ); return false; } @@ -449,9 +443,9 @@ function is_home() { /** * Is the query for an existing month archive? * - * @see WP_Query::is_month() * @since 1.5.0 - * @uses $wp_query + * + * @global WP_Query $wp_query Global WP_Query instance. * * @return bool */ @@ -459,7 +453,7 @@ function is_month() { global $wp_query; if ( ! isset( $wp_query ) ) { - _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1' ); + _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1.0' ); return false; } @@ -475,18 +469,18 @@ function is_month() { * @see is_single() * @see is_singular() * - * @see WP_Query::is_page() * @since 1.5.0 - * @uses $wp_query * - * @param mixed $page Page ID, title, slug, or array of such. - * @return bool + * @global WP_Query $wp_query Global WP_Query instance. + * + * @param int|string|array $page Optional. Page ID, title, slug, or array of such. Default empty. + * @return bool Whether the query is for an existing single page. */ function is_page( $page = '' ) { global $wp_query; if ( ! isset( $wp_query ) ) { - _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1' ); + _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1.0' ); return false; } @@ -496,9 +490,9 @@ function is_page( $page = '' ) { /** * Is the query for paged result and not for the first page? * - * @see WP_Query::is_paged() * @since 1.5.0 - * @uses $wp_query + * + * @global WP_Query $wp_query Global WP_Query instance. * * @return bool */ @@ -506,7 +500,7 @@ function is_paged() { global $wp_query; if ( ! isset( $wp_query ) ) { - _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1' ); + _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1.0' ); return false; } @@ -516,9 +510,9 @@ function is_paged() { /** * Is the query for a post or page preview? * - * @see WP_Query::is_preview() * @since 2.0.0 - * @uses $wp_query + * + * @global WP_Query $wp_query Global WP_Query instance. * * @return bool */ @@ -526,7 +520,7 @@ function is_preview() { global $wp_query; if ( ! isset( $wp_query ) ) { - _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1' ); + _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1.0' ); return false; } @@ -536,9 +530,9 @@ function is_preview() { /** * Is the query for the robots file? * - * @see WP_Query::is_robots() * @since 2.1.0 - * @uses $wp_query + * + * @global WP_Query $wp_query Global WP_Query instance. * * @return bool */ @@ -546,7 +540,7 @@ function is_robots() { global $wp_query; if ( ! isset( $wp_query ) ) { - _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1' ); + _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1.0' ); return false; } @@ -556,9 +550,9 @@ function is_robots() { /** * Is the query for a search? * - * @see WP_Query::is_search() * @since 1.5.0 - * @uses $wp_query + * + * @global WP_Query $wp_query Global WP_Query instance. * * @return bool */ @@ -566,7 +560,7 @@ function is_search() { global $wp_query; if ( ! isset( $wp_query ) ) { - _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1' ); + _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1.0' ); return false; } @@ -584,18 +578,18 @@ function is_search() { * @see is_page() * @see is_singular() * - * @see WP_Query::is_single() * @since 1.5.0 - * @uses $wp_query * - * @param mixed $post Post ID, title, slug, or array of such. - * @return bool + * @global WP_Query $wp_query Global WP_Query instance. + * + * @param int|string|array $post Optional. Post ID, title, slug, or array of such. Default empty. + * @return bool Whether the query is for an existing single post. */ function is_single( $post = '' ) { global $wp_query; if ( ! isset( $wp_query ) ) { - _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1' ); + _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1.0' ); return false; } @@ -611,18 +605,18 @@ function is_single( $post = '' ) { * @see is_page() * @see is_single() * - * @see WP_Query::is_singular() * @since 1.5.0 - * @uses $wp_query * - * @param mixed $post_types Optional. Post Type or array of Post Types - * @return bool + * @global WP_Query $wp_query Global WP_Query instance. + * + * @param string|array $post_types Optional. Post type or array of post types. Default empty. + * @return bool Whether the query is for an existing single post of any of the given post types. */ function is_singular( $post_types = '' ) { global $wp_query; if ( ! isset( $wp_query ) ) { - _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1' ); + _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1.0' ); return false; } @@ -632,9 +626,9 @@ function is_singular( $post_types = '' ) { /** * Is the query for a specific time? * - * @see WP_Query::is_time() * @since 1.5.0 - * @uses $wp_query + * + * @global WP_Query $wp_query Global WP_Query instance. * * @return bool */ @@ -642,7 +636,7 @@ function is_time() { global $wp_query; if ( ! isset( $wp_query ) ) { - _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1' ); + _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1.0' ); return false; } @@ -652,9 +646,9 @@ function is_time() { /** * Is the query for a trackback endpoint call? * - * @see WP_Query::is_trackback() * @since 1.5.0 - * @uses $wp_query + * + * @global WP_Query $wp_query Global WP_Query instance. * * @return bool */ @@ -662,7 +656,7 @@ function is_trackback() { global $wp_query; if ( ! isset( $wp_query ) ) { - _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1' ); + _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1.0' ); return false; } @@ -672,9 +666,9 @@ function is_trackback() { /** * Is the query for an existing year archive? * - * @see WP_Query::is_year() * @since 1.5.0 - * @uses $wp_query + * + * @global WP_Query $wp_query Global WP_Query instance. * * @return bool */ @@ -682,7 +676,7 @@ function is_year() { global $wp_query; if ( ! isset( $wp_query ) ) { - _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1' ); + _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1.0' ); return false; } @@ -692,9 +686,9 @@ function is_year() { /** * Is the query a 404 (returns no results)? * - * @see WP_Query::is_404() * @since 1.5.0 - * @uses $wp_query + * + * @global WP_Query $wp_query Global WP_Query instance. * * @return bool */ @@ -702,25 +696,53 @@ function is_404() { global $wp_query; if ( ! isset( $wp_query ) ) { - _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1' ); + _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1.0' ); return false; } return $wp_query->is_404(); } +/** + * Is the query for an embedded post? + * + * @since 4.4.0 + * + * @global WP_Query $wp_query Global WP_Query instance. + * + * @return bool Whether we're in an embedded post or not. + */ +function is_embed() { + global $wp_query; + + if ( ! isset( $wp_query ) ) { + _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1.0' ); + return false; + } + + return $wp_query->is_embed(); +} + /** * Is the query the main query? * * @since 3.3.0 * + * @global WP_Query $wp_query Global WP_Query instance. + * * @return bool */ function is_main_query() { if ( 'pre_get_posts' === current_filter() ) { - $message = sprintf( __( 'In %1$s, use the %2$s method, not the %3$s function. See %4$s.' ), - 'pre_get_posts', 'WP_Query::is_main_query()', 'is_main_query()', __( 'http://codex.wordpress.org/Function_Reference/is_main_query' ) ); - _doing_it_wrong( __FUNCTION__, $message, '3.7' ); + $message = sprintf( + /* translators: 1: pre_get_posts 2: WP_Query->is_main_query() 3: is_main_query() 4: link to codex is_main_query() page. */ + __( 'In %1$s, use the %2$s method, not the %3$s function. See %4$s.' ), + 'pre_get_posts', + 'WP_Query->is_main_query()', + 'is_main_query()', + __( 'https://codex.wordpress.org/Function_Reference/is_main_query' ) + ); + _doing_it_wrong( __FUNCTION__, $message, '3.7.0' ); } global $wp_query; @@ -734,15 +756,14 @@ function is_main_query() { /** * Whether current WordPress query has results to loop over. * - * @see WP_Query::have_posts() * @since 1.5.0 - * @uses $wp_query + * + * @global WP_Query $wp_query Global WP_Query instance. * * @return bool */ function have_posts() { global $wp_query; - return $wp_query->have_posts(); } @@ -750,41 +771,37 @@ function have_posts() { * Whether the caller is in the Loop. * * @since 2.0.0 - * @uses $wp_query + * + * @global WP_Query $wp_query Global WP_Query instance. * * @return bool True if caller is within loop, false if loop hasn't started or ended. */ function in_the_loop() { global $wp_query; - return $wp_query->in_the_loop; } /** * Rewind the loop posts. * - * @see WP_Query::rewind_posts() * @since 1.5.0 - * @uses $wp_query * - * @return null + * @global WP_Query $wp_query Global WP_Query instance. */ function rewind_posts() { global $wp_query; - - return $wp_query->rewind_posts(); + $wp_query->rewind_posts(); } /** * Iterate the post index in the loop. * - * @see WP_Query::the_post() * @since 1.5.0 - * @uses $wp_query + * + * @global WP_Query $wp_query Global WP_Query instance. */ function the_post() { global $wp_query; - $wp_query->the_post(); } @@ -795,9 +812,9 @@ function the_post() { /** * Whether there are comments to loop over. * - * @see WP_Query::have_comments() * @since 2.2.0 - * @uses $wp_query + * + * @global WP_Query $wp_query Global WP_Query instance. * * @return bool */ @@ -809,9 +826,9 @@ function have_comments() { /** * Iterate comment index in the comment loop. * - * @see WP_Query::the_comment() * @since 2.2.0 - * @uses $wp_query + * + * @global WP_Query $wp_query Global WP_Query instance. * * @return object */ @@ -827,9 +844,10 @@ function the_comment() { /** * The WordPress Query class. * - * @link http://codex.wordpress.org/Function_Reference/WP_Query Codex page. + * @link https://codex.wordpress.org/Function_Reference/WP_Query Codex page. * * @since 1.5.0 + * @since 4.5.0 Removed the `$comments_popup` property. */ class WP_Query { @@ -840,7 +858,7 @@ class WP_Query { * @access public * @var array */ - var $query; + public $query; /** * Query vars, after parsing @@ -849,7 +867,7 @@ class WP_Query { * @access public * @var array */ - var $query_vars = array(); + public $query_vars = array(); /** * Taxonomy query, as passed to get_tax_sql() @@ -858,7 +876,7 @@ class WP_Query { * @access public * @var object WP_Tax_Query */ - var $tax_query; + public $tax_query; /** * Metadata query container @@ -867,7 +885,7 @@ class WP_Query { * @access public * @var object WP_Meta_Query */ - var $meta_query = false; + public $meta_query = false; /** * Date query container @@ -876,7 +894,7 @@ class WP_Query { * @access public * @var object WP_Date_Query */ - var $date_query = false; + public $date_query = false; /** * Holds the data for a single object that is queried. @@ -887,7 +905,7 @@ class WP_Query { * @access public * @var object|array */ - var $queried_object; + public $queried_object; /** * The ID of the queried object. @@ -896,7 +914,7 @@ class WP_Query { * @access public * @var int */ - var $queried_object_id; + public $queried_object_id; /** * Get post database query. @@ -905,7 +923,7 @@ class WP_Query { * @access public * @var string */ - var $request; + public $request; /** * List of posts. @@ -914,7 +932,7 @@ class WP_Query { * @access public * @var array */ - var $posts; + public $posts; /** * The amount of posts for the current query. @@ -923,7 +941,7 @@ class WP_Query { * @access public * @var int */ - var $post_count = 0; + public $post_count = 0; /** * Index of the current item in the loop. @@ -932,7 +950,7 @@ class WP_Query { * @access public * @var int */ - var $current_post = -1; + public $current_post = -1; /** * Whether the loop has started and the caller is in the loop. @@ -941,7 +959,7 @@ class WP_Query { * @access public * @var bool */ - var $in_the_loop = false; + public $in_the_loop = false; /** * The current post. @@ -950,7 +968,7 @@ class WP_Query { * @access public * @var WP_Post */ - var $post; + public $post; /** * The list of comments for current post. @@ -959,7 +977,7 @@ class WP_Query { * @access public * @var array */ - var $comments; + public $comments; /** * The amount of comments for the posts. @@ -968,7 +986,7 @@ class WP_Query { * @access public * @var int */ - var $comment_count = 0; + public $comment_count = 0; /** * The index of the comment in the comment loop. @@ -977,7 +995,7 @@ class WP_Query { * @access public * @var int */ - var $current_comment = -1; + public $current_comment = -1; /** * Current comment ID. @@ -986,7 +1004,7 @@ class WP_Query { * @access public * @var int */ - var $comment; + public $comment; /** * The amount of found posts for the current query. @@ -997,7 +1015,7 @@ class WP_Query { * @access public * @var int */ - var $found_posts = 0; + public $found_posts = 0; /** * The amount of pages. @@ -1006,7 +1024,7 @@ class WP_Query { * @access public * @var int */ - var $max_num_pages = 0; + public $max_num_pages = 0; /** * The amount of comment pages. @@ -1015,7 +1033,7 @@ class WP_Query { * @access public * @var int */ - var $max_num_comment_pages = 0; + public $max_num_comment_pages = 0; /** * Set if query is single post. @@ -1024,7 +1042,7 @@ class WP_Query { * @access public * @var bool */ - var $is_single = false; + public $is_single = false; /** * Set if query is preview of blog. @@ -1033,7 +1051,7 @@ class WP_Query { * @access public * @var bool */ - var $is_preview = false; + public $is_preview = false; /** * Set if query returns a page. @@ -1042,7 +1060,7 @@ class WP_Query { * @access public * @var bool */ - var $is_page = false; + public $is_page = false; /** * Set if query is an archive list. @@ -1051,7 +1069,7 @@ class WP_Query { * @access public * @var bool */ - var $is_archive = false; + public $is_archive = false; /** * Set if query is part of a date. @@ -1060,7 +1078,7 @@ class WP_Query { * @access public * @var bool */ - var $is_date = false; + public $is_date = false; /** * Set if query contains a year. @@ -1069,7 +1087,7 @@ class WP_Query { * @access public * @var bool */ - var $is_year = false; + public $is_year = false; /** * Set if query contains a month. @@ -1078,7 +1096,7 @@ class WP_Query { * @access public * @var bool */ - var $is_month = false; + public $is_month = false; /** * Set if query contains a day. @@ -1087,7 +1105,7 @@ class WP_Query { * @access public * @var bool */ - var $is_day = false; + public $is_day = false; /** * Set if query contains time. @@ -1096,7 +1114,7 @@ class WP_Query { * @access public * @var bool */ - var $is_time = false; + public $is_time = false; /** * Set if query contains an author. @@ -1105,7 +1123,7 @@ class WP_Query { * @access public * @var bool */ - var $is_author = false; + public $is_author = false; /** * Set if query contains category. @@ -1114,7 +1132,7 @@ class WP_Query { * @access public * @var bool */ - var $is_category = false; + public $is_category = false; /** * Set if query contains tag. @@ -1123,7 +1141,7 @@ class WP_Query { * @access public * @var bool */ - var $is_tag = false; + public $is_tag = false; /** * Set if query contains taxonomy. @@ -1132,7 +1150,7 @@ class WP_Query { * @access public * @var bool */ - var $is_tax = false; + public $is_tax = false; /** * Set if query was part of a search result. @@ -1141,7 +1159,7 @@ class WP_Query { * @access public * @var bool */ - var $is_search = false; + public $is_search = false; /** * Set if query is feed display. @@ -1150,7 +1168,7 @@ class WP_Query { * @access public * @var bool */ - var $is_feed = false; + public $is_feed = false; /** * Set if query is comment feed display. @@ -1159,7 +1177,7 @@ class WP_Query { * @access public * @var bool */ - var $is_comment_feed = false; + public $is_comment_feed = false; /** * Set if query is trackback. @@ -1168,7 +1186,7 @@ class WP_Query { * @access public * @var bool */ - var $is_trackback = false; + public $is_trackback = false; /** * Set if query is blog homepage. @@ -1177,7 +1195,7 @@ class WP_Query { * @access public * @var bool */ - var $is_home = false; + public $is_home = false; /** * Set if query couldn't found anything. @@ -1186,16 +1204,16 @@ class WP_Query { * @access public * @var bool */ - var $is_404 = false; + public $is_404 = false; /** - * Set if query is within comments popup window. + * Set if query is embed. * - * @since 1.5.0 + * @since 4.4.0 * @access public * @var bool */ - var $is_comments_popup = false; + public $is_embed = false; /** * Set if query is paged @@ -1204,7 +1222,7 @@ class WP_Query { * @access public * @var bool */ - var $is_paged = false; + public $is_paged = false; /** * Set if query is part of administration page. @@ -1213,7 +1231,7 @@ class WP_Query { * @access public * @var bool */ - var $is_admin = false; + public $is_admin = false; /** * Set if query is an attachment. @@ -1222,7 +1240,7 @@ class WP_Query { * @access public * @var bool */ - var $is_attachment = false; + public $is_attachment = false; /** * Set if is single, is a page, or is an attachment. @@ -1231,7 +1249,7 @@ class WP_Query { * @access public * @var bool */ - var $is_singular = false; + public $is_singular = false; /** * Set if query is for robots. @@ -1240,7 +1258,7 @@ class WP_Query { * @access public * @var bool */ - var $is_robots = false; + public $is_robots = false; /** * Set if query contains posts. @@ -1251,7 +1269,7 @@ class WP_Query { * @access public * @var bool */ - var $is_posts_page = false; + public $is_posts_page = false; /** * Set if query is for a post type archive. @@ -1260,7 +1278,7 @@ class WP_Query { * @access public * @var bool */ - var $is_post_type_archive = false; + public $is_post_type_archive = false; /** * Stores the ->query_vars state like md5(serialize( $this->query_vars ) ) so we know @@ -1268,8 +1286,9 @@ class WP_Query { * * @since 3.1.0 * @access private + * @var bool|string */ - var $query_vars_hash = false; + private $query_vars_hash = false; /** * Whether query vars have changed since the initial parse_query() call. Used to catch modifications to query vars made @@ -1278,7 +1297,7 @@ class WP_Query { * @since 3.1.1 * @access private */ - var $query_vars_changed = true; + private $query_vars_changed = true; /** * Set if post thumbnails are cached @@ -1287,7 +1306,7 @@ class WP_Query { * @access public * @var bool */ - var $thumbnails_cached = false; + public $thumbnails_cached = false; /** * Cached list of search stopwords. @@ -1297,6 +1316,10 @@ class WP_Query { */ private $stopwords; + private $compat_fields = array( 'query_vars_hash', 'query_vars_changed' ); + + private $compat_methods = array( 'init_query_flags', 'parse_tax_query' ); + /** * Resets query flags to false. * @@ -1305,7 +1328,7 @@ class WP_Query { * @since 2.0.0 * @access private */ - function init_query_flags() { + private function init_query_flags() { $this->is_single = false; $this->is_preview = false; $this->is_page = false; @@ -1325,7 +1348,6 @@ class WP_Query { $this->is_trackback = false; $this->is_home = false; $this->is_404 = false; - $this->is_comments_popup = false; $this->is_paged = false; $this->is_admin = false; $this->is_attachment = false; @@ -1341,7 +1363,7 @@ class WP_Query { * @since 1.5.0 * @access public */ - function init() { + public function init() { unset($this->posts); unset($this->query); $this->query_vars = array(); @@ -1369,7 +1391,7 @@ class WP_Query { * @since 1.5.0 * @access public */ - function parse_query_vars() { + public function parse_query_vars() { $this->parse_query(); } @@ -1377,12 +1399,13 @@ class WP_Query { * Fills in the query variables, which do not exist within the parameter. * * @since 2.1.0 + * @since 4.4.0 Removed the `comments_popup` public query variable. * @access public * * @param array $array Defined query variables. * @return array Complete query variables with undefined ones filled in empty. */ - function fill_query_vars($array) { + public function fill_query_vars($array) { $keys = array( 'error' , 'm' @@ -1412,14 +1435,15 @@ class WP_Query { , 'feed' , 'tb' , 'paged' - , 'comments_popup' , 'meta_key' , 'meta_value' , 'preview' , 's' , 'sentence' + , 'title' , 'fields' , 'menu_order' + , 'embed' ); foreach ( $keys as $key ) { @@ -1427,7 +1451,7 @@ class WP_Query { $array[$key] = ''; } - $array_keys = array( 'category__in', 'category__not_in', 'category__and', 'post__in', 'post__not_in', + $array_keys = array( 'category__in', 'category__not_in', 'category__and', 'post__in', 'post__not_in', 'post_name__in', 'tag__in', 'tag__not_in', 'tag__and', 'tag_slug__in', 'tag_slug__and', 'post_parent__in', 'post_parent__not_in', 'author__in', 'author__not_in' ); @@ -1442,11 +1466,121 @@ class WP_Query { * Parse a query string and set query type booleans. * * @since 1.5.0 + * @since 4.2.0 Introduced the ability to order by specific clauses of a `$meta_query`, by passing the clause's + * array key to `$orderby`. + * @since 4.4.0 Introduced `$post_name__in` and `$title` parameters. `$s` was updated to support excluded + * search terms, by prepending a hyphen. + * @since 4.5.0 Removed the `$comments_popup` parameter. + * Introduced the `$comment_status` and `$ping_status` parameters. + * Introduced `RAND(x)` syntax for `$orderby`, which allows an integer seed value to random sorts. + * @since 4.6.0 Added 'post_name__in' support for `$orderby`. Introduced the `$lazy_load_term_meta` argument. * @access public * - * @param string|array $query Optional query. + * @param string|array $query { + * Optional. Array or string of Query parameters. + * + * @type int $attachment_id Attachment post ID. Used for 'attachment' post_type. + * @type int|string $author Author ID, or comma-separated list of IDs. + * @type string $author_name User 'user_nicename'. + * @type array $author__in An array of author IDs to query from. + * @type array $author__not_in An array of author IDs not to query from. + * @type bool $cache_results Whether to cache post information. Default true. + * @type int|string $cat Category ID or comma-separated list of IDs (this or any children). + * @type array $category__and An array of category IDs (AND in). + * @type array $category__in An array of category IDs (OR in, no children). + * @type array $category__not_in An array of category IDs (NOT in). + * @type string $category_name Use category slug (not name, this or any children). + * @type string $comment_status Comment status. + * @type int $comments_per_page The number of comments to return per page. + * Default 'comments_per_page' option. + * @type array $date_query An associative array of WP_Date_Query arguments. + * See WP_Date_Query::__construct(). + * @type int $day Day of the month. Default empty. Accepts numbers 1-31. + * @type bool $exact Whether to search by exact keyword. Default false. + * @type string|array $fields Which fields to return. Single field or all fields (string), + * or array of fields. 'id=>parent' uses 'id' and 'post_parent'. + * Default all fields. Accepts 'ids', 'id=>parent'. + * @type int $hour Hour of the day. Default empty. Accepts numbers 0-23. + * @type int|bool $ignore_sticky_posts Whether to ignore sticky posts or not. Setting this to false + * excludes stickies from 'post__in'. Accepts 1|true, 0|false. + * Default 0|false. + * @type int $m Combination YearMonth. Accepts any four-digit year and month + * numbers 1-12. Default empty. + * @type string $meta_compare Comparison operator to test the 'meta_value'. + * @type string $meta_key Custom field key. + * @type array $meta_query An associative array of WP_Meta_Query arguments. See WP_Meta_Query. + * @type string $meta_value Custom field value. + * @type int $meta_value_num Custom field value number. + * @type int $menu_order The menu order of the posts. + * @type int $monthnum The two-digit month. Default empty. Accepts numbers 1-12. + * @type string $name Post slug. + * @type bool $nopaging Show all posts (true) or paginate (false). Default false. + * @type bool $no_found_rows Whether to skip counting the total rows found. Enabling can improve + * performance. Default false. + * @type int $offset The number of posts to offset before retrieval. + * @type string $order Designates ascending or descending order of posts. Default 'DESC'. + * Accepts 'ASC', 'DESC'. + * @type string|array $orderby Sort retrieved posts by parameter. One or more options may be + * passed. To use 'meta_value', or 'meta_value_num', + * 'meta_key=keyname' must be also be defined. To sort by a + * specific `$meta_query` clause, use that clause's array key. + * Default 'date'. Accepts 'none', 'name', 'author', 'date', + * 'title', 'modified', 'menu_order', 'parent', 'ID', 'rand', + * 'RAND(x)' (where 'x' is an integer seed value), + * 'comment_count', 'meta_value', 'meta_value_num', 'post__in', + * 'post_name__in', 'post_parent__in', and the array keys + * of `$meta_query`. + * @type int $p Post ID. + * @type int $page Show the number of posts that would show up on page X of a + * static front page. + * @type int $paged The number of the current page. + * @type int $page_id Page ID. + * @type string $pagename Page slug. + * @type string $perm Show posts if user has the appropriate capability. + * @type string $ping_status Ping status. + * @type array $post__in An array of post IDs to retrieve, sticky posts will be included + * @type string $post_mime_type The mime type of the post. Used for 'attachment' post_type. + * @type array $post__not_in An array of post IDs not to retrieve. Note: a string of comma- + * separated IDs will NOT work. + * @type int $post_parent Page ID to retrieve child pages for. Use 0 to only retrieve + * top-level pages. + * @type array $post_parent__in An array containing parent page IDs to query child pages from. + * @type array $post_parent__not_in An array containing parent page IDs not to query child pages from. + * @type string|array $post_type A post type slug (string) or array of post type slugs. + * Default 'any' if using 'tax_query'. + * @type string|array $post_status A post status (string) or array of post statuses. + * @type int $posts_per_page The number of posts to query for. Use -1 to request all posts. + * @type int $posts_per_archive_page The number of posts to query for by archive page. Overrides + * 'posts_per_page' when is_archive(), or is_search() are true. + * @type array $post_name__in An array of post slugs that results must match. + * @type string $s Search keyword(s). Prepending a term with a hyphen will + * exclude posts matching that term. Eg, 'pillow -sofa' will + * return posts containing 'pillow' but not 'sofa'. + * @type int $second Second of the minute. Default empty. Accepts numbers 0-60. + * @type bool $sentence Whether to search by phrase. Default false. + * @type bool $suppress_filters Whether to suppress filters. Default false. + * @type string $tag Tag slug. Comma-separated (either), Plus-separated (all). + * @type array $tag__and An array of tag ids (AND in). + * @type array $tag__in An array of tag ids (OR in). + * @type array $tag__not_in An array of tag ids (NOT in). + * @type int $tag_id Tag id or comma-separated list of IDs. + * @type array $tag_slug__and An array of tag slugs (AND in). + * @type array $tag_slug__in An array of tag slugs (OR in). unless 'ignore_sticky_posts' is + * true. Note: a string of comma-separated IDs will NOT work. + * @type array $tax_query An associative array of WP_Tax_Query arguments. + * See WP_Tax_Query->queries. + * @type string $title Post title. + * @type bool $update_post_meta_cache Whether to update the post meta cache. Default true. + * @type bool $update_post_term_cache Whether to update the post term cache. Default true. + * @type bool $lazy_load_term_meta Whether to lazy-load term meta. Setting to false will + * disable cache priming for term meta, so that each + * get_term_meta() call will hit the database. + * Defaults to the value of `$update_post_term_cache`. + * @type int $w The week number of the year. Default empty. Accepts numbers 0-53. + * @type int $year The four-digit year. Default empty. Accepts any four-digit year. + * } */ - function parse_query( $query = '' ) { + public function parse_query( $query = '' ) { if ( ! empty( $query ) ) { $this->init(); $this->query = $this->query_vars = wp_parse_args( $query ); @@ -1467,20 +1601,22 @@ class WP_Query { $qv['monthnum'] = absint($qv['monthnum']); $qv['day'] = absint($qv['day']); $qv['w'] = absint($qv['w']); - $qv['m'] = preg_replace( '|[^0-9]|', '', $qv['m'] ); + $qv['m'] = is_scalar( $qv['m'] ) ? preg_replace( '|[^0-9]|', '', $qv['m'] ) : ''; $qv['paged'] = absint($qv['paged']); $qv['cat'] = preg_replace( '|[^0-9,-]|', '', $qv['cat'] ); // comma separated list of positive or negative integers $qv['author'] = preg_replace( '|[^0-9,-]|', '', $qv['author'] ); // comma separated list of positive or negative integers $qv['pagename'] = trim( $qv['pagename'] ); $qv['name'] = trim( $qv['name'] ); + $qv['title'] = trim( $qv['title'] ); if ( '' !== $qv['hour'] ) $qv['hour'] = absint($qv['hour']); if ( '' !== $qv['minute'] ) $qv['minute'] = absint($qv['minute']); if ( '' !== $qv['second'] ) $qv['second'] = absint($qv['second']); if ( '' !== $qv['menu_order'] ) $qv['menu_order'] = absint($qv['menu_order']); // Fairly insane upper bound for search string lengths. - if ( ! empty( $qv['s'] ) && strlen( $qv['s'] ) > 1600 ) + if ( ! is_scalar( $qv['s'] ) || ( ! empty( $qv['s'] ) && strlen( $qv['s'] ) > 1600 ) ) { $qv['s'] = ''; + } // Compat. Map subpost to attachment. if ( '' != $qv['subpost'] ) @@ -1505,9 +1641,9 @@ class WP_Query { $this->is_page = true; $this->is_single = false; } else { - // Look for archive queries. Dates, categories, authors, search, post type archives. + // Look for archive queries. Dates, categories, authors, search, post type archives. - if ( !empty($qv['s']) ) { + if ( isset( $this->query['s'] ) ) { $this->is_search = true; } @@ -1560,9 +1696,9 @@ class WP_Query { $this->is_date = true; if ( strlen($qv['m']) > 9 ) { $this->is_time = true; - } else if ( strlen($qv['m']) > 7 ) { + } elseif ( strlen( $qv['m'] ) > 7 ) { $this->is_day = true; - } else if ( strlen($qv['m']) > 5 ) { + } elseif ( strlen( $qv['m'] ) > 5 ) { $this->is_month = true; } else { $this->is_year = true; @@ -1577,7 +1713,11 @@ class WP_Query { $this->parse_tax_query( $qv ); foreach ( $this->tax_query->queries as $tax_query ) { - if ( 'NOT IN' != $tax_query['operator'] ) { + if ( ! is_array( $tax_query ) ) { + continue; + } + + if ( isset( $tax_query['operator'] ) && 'NOT IN' != $tax_query['operator'] ) { switch ( $tax_query['taxonomy'] ) { case 'category': $this->is_category = true; @@ -1614,15 +1754,16 @@ class WP_Query { if ( '' != $qv['feed'] ) $this->is_feed = true; + if ( '' != $qv['embed'] ) { + $this->is_embed = true; + } + if ( '' != $qv['tb'] ) $this->is_trackback = true; if ( '' != $qv['paged'] && ( intval($qv['paged']) > 1 ) ) $this->is_paged = true; - if ( '' != $qv['comments_popup'] ) - $this->is_comments_popup = true; - // if we're previewing inside the write screen if ( '' != $qv['preview'] ) $this->is_preview = true; @@ -1640,7 +1781,7 @@ class WP_Query { if ( $this->is_feed && ( !empty($qv['withcomments']) || ( empty($qv['withoutcomments']) && $this->is_singular ) ) ) $this->is_comment_feed = true; - if ( !( $this->is_singular || $this->is_archive || $this->is_search || $this->is_feed || $this->is_trackback || $this->is_404 || $this->is_admin || $this->is_comments_popup || $this->is_robots ) ) + if ( !( $this->is_singular || $this->is_archive || $this->is_search || $this->is_feed || ( defined( 'REST_REQUEST' ) && REST_REQUEST ) || $this->is_trackback || $this->is_404 || $this->is_admin || $this->is_robots ) ) $this->is_home = true; // Correct is_* for page_on_front and page_for_posts @@ -1649,6 +1790,9 @@ class WP_Query { // pagename can be set and empty depending on matched rewrite rules. Ignore an empty pagename. if ( isset($_query['pagename']) && '' == $_query['pagename'] ) unset($_query['pagename']); + + unset( $_query['embed'] ); + if ( empty($_query) || !array_diff( array_keys($_query), array('preview', 'page', 'paged', 'cpage') ) ) { $this->is_page = true; $this->is_home = false; @@ -1662,11 +1806,25 @@ class WP_Query { } if ( '' != $qv['pagename'] ) { - $this->queried_object = get_page_by_path($qv['pagename']); - if ( !empty($this->queried_object) ) + $this->queried_object = get_page_by_path( $qv['pagename'] ); + + if ( $this->queried_object && 'attachment' == $this->queried_object->post_type ) { + if ( preg_match( "/^[^%]*%(?:postname)%/", get_option( 'permalink_structure' ) ) ) { + // See if we also have a post with the same slug + $post = get_page_by_path( $qv['pagename'], OBJECT, 'post' ); + if ( $post ) { + $this->queried_object = $post; + $this->is_page = false; + $this->is_single = true; + } + } + } + + if ( ! empty( $this->queried_object ) ) { $this->queried_object_id = (int) $this->queried_object->ID; - else - unset($this->queried_object); + } else { + unset( $this->queried_object ); + } if ( 'page' == get_option('show_on_front') && isset($this->queried_object_id) && $this->queried_object_id == get_option('page_for_posts') ) { $this->is_page = false; @@ -1706,21 +1864,32 @@ class WP_Query { if ( '404' == $qv['error'] ) $this->set_404(); + $this->is_embed = $this->is_embed && ( $this->is_singular || $this->is_404 ); + $this->query_vars_hash = md5( serialize( $this->query_vars ) ); $this->query_vars_changed = false; - do_action_ref_array('parse_query', array(&$this)); + /** + * Fires after the main query vars have been parsed. + * + * @since 1.5.0 + * + * @param WP_Query &$this The WP_Query instance (passed by reference). + */ + do_action_ref_array( 'parse_query', array( &$this ) ); } /** * Parses various taxonomy related query vars. * + * For BC, this method is not marked as protected. See [28987]. + * * @access protected * @since 3.1.0 * - * @param array &$q The query variables + * @param array $q The query variables. Passed by reference. */ - function parse_tax_query( &$q ) { + public function parse_tax_query( &$q ) { if ( ! empty( $q['tax_query'] ) && is_array( $q['tax_query'] ) ) { $tax_query = $q['tax_query']; } else { @@ -1751,6 +1920,10 @@ class WP_Query { $term = $q[$t->query_var]; + if ( is_array( $term ) ) { + $term = implode( ',', $term ); + } + if ( strpos($term, '+') !== false ) { $terms = preg_split( '/[+]+/', $term ); foreach ( $terms as $term ) { @@ -1766,6 +1939,11 @@ class WP_Query { } } + // If querystring 'cat' is an array, implode it. + if ( is_array( $q['cat'] ) ) { + $q['cat'] = implode( ',', $q['cat'] ); + } + // Category stuff if ( ! empty( $q['cat'] ) && ! $this->is_singular ) { $cat_in = $cat_not_in = array(); @@ -1841,6 +2019,11 @@ class WP_Query { ); } + // If querystring 'tag' is array, implode it. + if ( is_array( $q['tag'] ) ) { + $q['tag'] = implode( ',', $q['tag'] ); + } + // Tag stuff if ( '' != $q['tag'] && !$this->is_singular && $this->query_vars_changed ) { if ( strpos($q['tag'], ',') !== false ) { @@ -1849,7 +2032,7 @@ class WP_Query { $tag = sanitize_term_field('slug', $tag, 0, 'post_tag', 'db'); $q['tag_slug__in'][] = $tag; } - } else if ( preg_match('/[+\r\n\t ]+/', $q['tag']) || !empty($q['cat']) ) { + } elseif ( preg_match('/[+\r\n\t ]+/', $q['tag'] ) || ! empty( $q['cat'] ) ) { $tags = preg_split('/[+\r\n\t ]+/', $q['tag']); foreach ( (array) $tags as $tag ) { $tag = sanitize_term_field('slug', $tag, 0, 'post_tag', 'db'); @@ -1916,6 +2099,13 @@ class WP_Query { $this->tax_query = new WP_Tax_Query( $tax_query ); + /** + * Fires after taxonomy-related query vars have been parsed. + * + * @since 3.7.0 + * + * @param WP_Query $this The WP_Query instance. + */ do_action( 'parse_tax_query', $this ); } @@ -1924,7 +2114,8 @@ class WP_Query { * * @since 3.7.0 * - * @global wpdb $wpdb + * @global wpdb $wpdb WordPress database abstraction object. + * * @param array $q Query variables. * @return string WHERE clause. */ @@ -1958,11 +2149,24 @@ class WP_Query { $searchand = ''; $q['search_orderby_title'] = array(); foreach ( $q['search_terms'] as $term ) { - $term = like_escape( esc_sql( $term ) ); - if ( $n ) - $q['search_orderby_title'][] = "$wpdb->posts.post_title LIKE '%$term%'"; + // Terms prefixed with '-' should be excluded. + $include = '-' !== substr( $term, 0, 1 ); + if ( $include ) { + $like_op = 'LIKE'; + $andor_op = 'OR'; + } else { + $like_op = 'NOT LIKE'; + $andor_op = 'AND'; + $term = substr( $term, 1 ); + } - $search .= "{$searchand}(($wpdb->posts.post_title LIKE '{$n}{$term}{$n}') OR ($wpdb->posts.post_content LIKE '{$n}{$term}{$n}'))"; + if ( $n && $include ) { + $like = '%' . $wpdb->esc_like( $term ) . '%'; + $q['search_orderby_title'][] = $wpdb->prepare( "$wpdb->posts.post_title LIKE %s", $like ); + } + + $like = $n . $wpdb->esc_like( $term ) . $n; + $search .= $wpdb->prepare( "{$searchand}(($wpdb->posts.post_title $like_op %s) $andor_op ($wpdb->posts.post_excerpt $like_op %s) $andor_op ($wpdb->posts.post_content $like_op %s))", $like, $like, $like ); $searchand = ' AND '; } @@ -1984,7 +2188,7 @@ class WP_Query { * * @since 3.7.0 * - * @param array Terms to check. + * @param array $terms Terms to check. * @return array Terms that are not stopwords. */ protected function parse_search_terms( $terms ) { @@ -2000,8 +2204,8 @@ class WP_Query { else $term = trim( $term, "\"' " ); - // Avoid single A-Z. - if ( ! $term || ( 1 === strlen( $term ) && preg_match( '/^[a-z]$/i', $term ) ) ) + // Avoid single A-Z and single dashes. + if ( ! $term || ( 1 === strlen( $term ) && preg_match( '/^[a-z\-]$/i', $term ) ) ) continue; if ( in_array( call_user_func( $strtolower, $term ), $stopwords, true ) ) @@ -2032,14 +2236,14 @@ class WP_Query { 'Comma-separated list of search stopwords in your language' ) ); $stopwords = array(); - foreach( $words as $word ) { + foreach ( $words as $word ) { $word = trim( $word, "\r\n\t " ); if ( $word ) $stopwords[] = $word; } /** - * Filter stopwords used when parsing search terms. + * Filters stopwords used when parsing search terms. * * @since 3.7.0 * @@ -2052,22 +2256,29 @@ class WP_Query { /** * Generate SQL for the ORDER BY condition based on passed search terms. * - * @global wpdb $wpdb + * @global wpdb $wpdb WordPress database abstraction object. + * * @param array $q Query variables. * @return string ORDER BY clause. */ protected function parse_search_order( &$q ) { global $wpdb; - $search_orderby = ''; - if ( $q['search_terms_count'] > 1 ) { $num_terms = count( $q['search_orderby_title'] ); - $search_orderby_s = like_escape( esc_sql( $q['s'] ) ); - $search_orderby = '(CASE '; + // If the search terms contain negative queries, don't bother ordering by sentence matches. + $like = ''; + if ( ! preg_match( '/(?:\s|^)\-/', $q['s'] ) ) { + $like = '%' . $wpdb->esc_like( $q['s'] ) . '%'; + } + + $search_orderby = ''; + // sentence match in 'post_title' - $search_orderby .= "WHEN $wpdb->posts.post_title LIKE '%{$search_orderby_s}%' THEN 1 "; + if ( $like ) { + $search_orderby .= $wpdb->prepare( "WHEN $wpdb->posts.post_title LIKE %s THEN 1 ", $like ); + } // sanity limit, sort as sentence when more than 6 terms // (few searches are longer than 6 terms and most titles are not) @@ -2079,9 +2290,15 @@ class WP_Query { $search_orderby .= 'WHEN ' . implode( ' OR ', $q['search_orderby_title'] ) . ' THEN 3 '; } - // sentence match in 'post_content' - $search_orderby .= "WHEN $wpdb->posts.post_content LIKE '%{$search_orderby_s}%' THEN 4 "; - $search_orderby .= 'ELSE 5 END)'; + // Sentence match in 'post_content' and 'post_excerpt'. + if ( $like ) { + $search_orderby .= $wpdb->prepare( "WHEN $wpdb->posts.post_excerpt LIKE %s THEN 4 ", $like ); + $search_orderby .= $wpdb->prepare( "WHEN $wpdb->posts.post_content LIKE %s THEN 5 ", $like ); + } + + if ( $search_orderby ) { + $search_orderby = '(CASE ' . $search_orderby . 'ELSE 6 END)'; + } } else { // single word or sentence search $search_orderby = reset( $q['search_orderby_title'] ) . ' DESC'; @@ -2090,13 +2307,129 @@ class WP_Query { return $search_orderby; } + /** + * If the passed orderby value is allowed, convert the alias to a + * properly-prefixed orderby value. + * + * @since 4.0.0 + * @access protected + * + * @global wpdb $wpdb WordPress database abstraction object. + * + * @param string $orderby Alias for the field to order by. + * @return string|false Table-prefixed value to used in the ORDER clause. False otherwise. + */ + protected function parse_orderby( $orderby ) { + global $wpdb; + + // Used to filter values. + $allowed_keys = array( + 'post_name', 'post_author', 'post_date', 'post_title', 'post_modified', + 'post_parent', 'post_type', 'name', 'author', 'date', 'title', 'modified', + 'parent', 'type', 'ID', 'menu_order', 'comment_count', 'rand', + ); + + $primary_meta_key = ''; + $primary_meta_query = false; + $meta_clauses = $this->meta_query->get_clauses(); + if ( ! empty( $meta_clauses ) ) { + $primary_meta_query = reset( $meta_clauses ); + + if ( ! empty( $primary_meta_query['key'] ) ) { + $primary_meta_key = $primary_meta_query['key']; + $allowed_keys[] = $primary_meta_key; + } + + $allowed_keys[] = 'meta_value'; + $allowed_keys[] = 'meta_value_num'; + $allowed_keys = array_merge( $allowed_keys, array_keys( $meta_clauses ) ); + } + + // If RAND() contains a seed value, sanitize and add to allowed keys. + $rand_with_seed = false; + if ( preg_match( '/RAND\(([0-9]+)\)/i', $orderby, $matches ) ) { + $orderby = sprintf( 'RAND(%s)', intval( $matches[1] ) ); + $allowed_keys[] = $orderby; + $rand_with_seed = true; + } + + if ( ! in_array( $orderby, $allowed_keys, true ) ) { + return false; + } + + switch ( $orderby ) { + case 'post_name': + case 'post_author': + case 'post_date': + case 'post_title': + case 'post_modified': + case 'post_parent': + case 'post_type': + case 'ID': + case 'menu_order': + case 'comment_count': + $orderby_clause = "$wpdb->posts.{$orderby}"; + break; + case 'rand': + $orderby_clause = 'RAND()'; + break; + case $primary_meta_key: + case 'meta_value': + if ( ! empty( $primary_meta_query['type'] ) ) { + $orderby_clause = "CAST({$primary_meta_query['alias']}.meta_value AS {$primary_meta_query['cast']})"; + } else { + $orderby_clause = "{$primary_meta_query['alias']}.meta_value"; + } + break; + case 'meta_value_num': + $orderby_clause = "{$primary_meta_query['alias']}.meta_value+0"; + break; + default: + if ( array_key_exists( $orderby, $meta_clauses ) ) { + // $orderby corresponds to a meta_query clause. + $meta_clause = $meta_clauses[ $orderby ]; + $orderby_clause = "CAST({$meta_clause['alias']}.meta_value AS {$meta_clause['cast']})"; + } elseif ( $rand_with_seed ) { + $orderby_clause = $orderby; + } else { + // Default: order by post field. + $orderby_clause = "$wpdb->posts.post_" . sanitize_key( $orderby ); + } + + break; + } + + return $orderby_clause; + } + + /** + * Parse an 'order' query variable and cast it to ASC or DESC as necessary. + * + * @since 4.0.0 + * @access protected + * + * @param string $order The 'order' query variable. + * @return string The sanitized 'order' query variable. + */ + protected function parse_order( $order ) { + if ( ! is_string( $order ) || empty( $order ) ) { + return 'DESC'; + } + + if ( 'ASC' === strtoupper( $order ) ) { + return 'ASC'; + } else { + return 'DESC'; + } + } + /** * Sets the 404 property and saves whether query is feed. * * @since 2.0.0 * @access public */ - function set_404() { + public function set_404() { $is_feed = $this->is_feed; $this->init_query_flags(); @@ -2109,16 +2442,20 @@ class WP_Query { * Retrieve query variable. * * @since 1.5.0 + * @since 3.9.0 The `$default` argument was introduced. + * * @access public * * @param string $query_var Query variable key. - * @return mixed + * @param mixed $default Optional. Value to return if the query variable is not set. Default empty. + * @return mixed Contents of the query variable. */ - function get($query_var) { - if ( isset($this->query_vars[$query_var]) ) - return $this->query_vars[$query_var]; + public function get( $query_var, $default = '' ) { + if ( isset( $this->query_vars[ $query_var ] ) ) { + return $this->query_vars[ $query_var ]; + } - return ''; + return $default; } /** @@ -2128,9 +2465,9 @@ class WP_Query { * @access public * * @param string $query_var Query variable key. - * @param mixed $value Query variable value. + * @param mixed $value Query variable value. */ - function set($query_var, $value) { + public function set($query_var, $value) { $this->query_vars[$query_var] = $value; } @@ -2142,16 +2479,28 @@ class WP_Query { * * @since 1.5.0 * @access public - * @uses do_action_ref_array() Calls 'pre_get_posts' hook before retrieving posts. + * + * @global wpdb $wpdb WordPress database abstraction object. * * @return array List of posts. */ - function get_posts() { + public function get_posts() { global $wpdb; $this->parse_query(); - do_action_ref_array('pre_get_posts', array(&$this)); + /** + * Fires after the query variable object is created, but before the actual query is run. + * + * Note: If using conditional tags, use the method versions within the passed instance + * (e.g. $this->is_main_query() instead of is_main_query()). This is because the functions + * like is_main_query() test against the global $wp_query instance, not the passed one. + * + * @since 2.0.0 + * + * @param WP_Query &$this The WP_Query instance (passed by reference). + */ + do_action_ref_array( 'pre_get_posts', array( &$this ) ); // Shorthand. $q = &$this->query_vars; @@ -2180,12 +2529,11 @@ class WP_Query { $join = ''; $search = ''; $groupby = ''; - $fields = ''; $post_status_join = false; $page = 1; if ( isset( $q['caller_get_posts'] ) ) { - _deprecated_argument( 'WP_Query', '3.1', __( '"caller_get_posts" is deprecated. Use "ignore_sticky_posts" instead.' ) ); + _deprecated_argument( 'WP_Query', '3.1.0', __( '"caller_get_posts" is deprecated. Use "ignore_sticky_posts" instead.' ) ); if ( !isset( $q['ignore_sticky_posts'] ) ) $q['ignore_sticky_posts'] = $q['caller_get_posts']; } @@ -2206,6 +2554,10 @@ class WP_Query { if ( !isset($q['update_post_term_cache']) ) $q['update_post_term_cache'] = true; + if ( ! isset( $q['lazy_load_term_meta'] ) ) { + $q['lazy_load_term_meta'] = $q['update_post_term_cache']; + } + if ( !isset($q['update_post_meta_cache']) ) $q['update_post_meta_cache'] = true; @@ -2216,8 +2568,9 @@ class WP_Query { $q['post_type'] = ''; } $post_type = $q['post_type']; - if ( !isset($q['posts_per_page']) || $q['posts_per_page'] == 0 ) - $q['posts_per_page'] = get_option('posts_per_page'); + if ( empty( $q['posts_per_page'] ) ) { + $q['posts_per_page'] = get_option( 'posts_per_page' ); + } if ( isset($q['showposts']) && $q['showposts'] ) { $q['showposts'] = (int) $q['showposts']; $q['posts_per_page'] = $q['showposts']; @@ -2231,14 +2584,20 @@ class WP_Query { $q['nopaging'] = false; } } + if ( $this->is_feed ) { - $q['posts_per_page'] = get_option('posts_per_rss'); + // This overrides posts_per_page. + if ( ! empty( $q['posts_per_rss'] ) ) { + $q['posts_per_page'] = $q['posts_per_rss']; + } else { + $q['posts_per_page'] = get_option( 'posts_per_rss' ); + } $q['nopaging'] = false; } $q['posts_per_page'] = (int) $q['posts_per_page']; if ( $q['posts_per_page'] < -1 ) $q['posts_per_page'] = abs($q['posts_per_page']); - else if ( $q['posts_per_page'] == 0 ) + elseif ( $q['posts_per_page'] == 0 ) $q['posts_per_page'] = 1; if ( !isset($q['comments_per_page']) || $q['comments_per_page'] == 0 ) @@ -2334,11 +2693,11 @@ class WP_Query { if ( !$ptype_obj || !$ptype_obj->query_var || empty($q[ $ptype_obj->query_var ]) ) continue; - if ( ! $ptype_obj->hierarchical || strpos($q[ $ptype_obj->query_var ], '/') === false ) { - // Non-hierarchical post_types & parent-level-hierarchical post_types can directly use 'name' + if ( ! $ptype_obj->hierarchical ) { + // Non-hierarchical post types can directly use 'name'. $q['name'] = $q[ $ptype_obj->query_var ]; } else { - // Hierarchical post_types will operate through the + // Hierarchical post types will operate through 'pagename'. $q['pagename'] = $q[ $ptype_obj->query_var ]; $q['name'] = ''; } @@ -2349,6 +2708,11 @@ class WP_Query { unset($ptype_obj); } + if ( '' !== $q['title'] ) { + $where .= $wpdb->prepare( " AND $wpdb->posts.post_title = %s", stripslashes( $q['title'] ) ); + } + + // Parameters related to 'post_name'. if ( '' != $q['name'] ) { $q['name'] = sanitize_title_for_query( $q['name'] ); $where .= " AND $wpdb->posts.post_name = '" . $q['name'] . "'"; @@ -2393,12 +2757,12 @@ class WP_Query { $q['attachment'] = sanitize_title_for_query( wp_basename( $q['attachment'] ) ); $q['name'] = $q['attachment']; $where .= " AND $wpdb->posts.post_name = '" . $q['attachment'] . "'"; + } elseif ( is_array( $q['post_name__in'] ) && ! empty( $q['post_name__in'] ) ) { + $q['post_name__in'] = array_map( 'sanitize_title_for_query', $q['post_name__in'] ); + $post_name__in = "'" . implode( "','", $q['post_name__in'] ) . "'"; + $where .= " AND $wpdb->posts.post_name IN ($post_name__in)"; } - - if ( intval($q['comments_popup']) ) - $q['p'] = absint($q['comments_popup']); - // If an attachment is requested by number, let it supersede any post number. if ( $q['attachment_id'] ) $q['p'] = absint($q['attachment_id']); @@ -2432,18 +2796,21 @@ class WP_Query { } // If a search pattern is specified, load the posts that match. - if ( ! empty( $q['s'] ) ) + if ( strlen( $q['s'] ) ) { $search = $this->parse_search( $q ); + } - /** - * Filter the search SQL that is used in the WHERE clause of WP_Query. - * - * @since 3.0.0 - * - * @param string $search Search SQL for WHERE clause. - * @param WP_Query $this The current WP_Query object. - */ - $search = apply_filters_ref_array( 'posts_search', array( $search, &$this ) ); + if ( ! $q['suppress_filters'] ) { + /** + * Filters the search SQL that is used in the WHERE clause of WP_Query. + * + * @since 3.0.0 + * + * @param string $search Search SQL for WHERE clause. + * @param WP_Query $this The current WP_Query object. + */ + $search = apply_filters_ref_array( 'posts_search', array( $search, &$this ) ); + } // Taxonomies if ( !$this->is_singular ) { @@ -2459,7 +2826,7 @@ class WP_Query { if ( empty($post_type) ) { // Do a fully inclusive search for currently registered post types of queried taxonomies $post_type = array(); - $taxonomies = wp_list_pluck( $this->tax_query->queries, 'taxonomy' ); + $taxonomies = array_keys( $this->tax_query->queried_terms ); foreach ( get_post_types( array( 'exclude_from_search' => false ) ) as $pt ) { $object_taxonomies = $pt === 'attachment' ? get_taxonomies_for_attachments() : get_object_taxonomies( $pt ); if ( array_intersect( $taxonomies, $object_taxonomies ) ) @@ -2476,51 +2843,59 @@ class WP_Query { } } - // Back-compat - if ( !empty($this->tax_query->queries) ) { - $tax_query_in_and = wp_list_filter( $this->tax_query->queries, array( 'operator' => 'NOT IN' ), 'NOT' ); - if ( !empty( $tax_query_in_and ) ) { - if ( !isset( $q['taxonomy'] ) ) { - foreach ( $tax_query_in_and as $a_tax_query ) { - if ( !in_array( $a_tax_query['taxonomy'], array( 'category', 'post_tag' ) ) ) { - $q['taxonomy'] = $a_tax_query['taxonomy']; - if ( 'slug' == $a_tax_query['field'] ) - $q['term'] = $a_tax_query['terms'][0]; - else - $q['term_id'] = $a_tax_query['terms'][0]; + /* + * Ensure that 'taxonomy', 'term', 'term_id', 'cat', and + * 'category_name' vars are set for backward compatibility. + */ + if ( ! empty( $this->tax_query->queried_terms ) ) { - break; - } + /* + * Set 'taxonomy', 'term', and 'term_id' to the + * first taxonomy other than 'post_tag' or 'category'. + */ + if ( ! isset( $q['taxonomy'] ) ) { + foreach ( $this->tax_query->queried_terms as $queried_taxonomy => $queried_items ) { + if ( empty( $queried_items['terms'][0] ) ) { + continue; } - } - $cat_query = wp_list_filter( $tax_query_in_and, array( 'taxonomy' => 'category' ) ); - if ( ! empty( $cat_query ) ) { - $cat_query = reset( $cat_query ); + if ( ! in_array( $queried_taxonomy, array( 'category', 'post_tag' ) ) ) { + $q['taxonomy'] = $queried_taxonomy; - if ( ! empty( $cat_query['terms'][0] ) ) { - $the_cat = get_term_by( $cat_query['field'], $cat_query['terms'][0], 'category' ); - if ( $the_cat ) { - $this->set( 'cat', $the_cat->term_id ); - $this->set( 'category_name', $the_cat->slug ); + if ( 'slug' === $queried_items['field'] ) { + $q['term'] = $queried_items['terms'][0]; + } else { + $q['term_id'] = $queried_items['terms'][0]; } - unset( $the_cat ); + + // Take the first one we find. + break; } } - unset( $cat_query ); + } + + // 'cat', 'category_name', 'tag_id' + foreach ( $this->tax_query->queried_terms as $queried_taxonomy => $queried_items ) { + if ( empty( $queried_items['terms'][0] ) ) { + continue; + } - $tag_query = wp_list_filter( $tax_query_in_and, array( 'taxonomy' => 'post_tag' ) ); - if ( ! empty( $tag_query ) ) { - $tag_query = reset( $tag_query ); + if ( 'category' === $queried_taxonomy ) { + $the_cat = get_term_by( $queried_items['field'], $queried_items['terms'][0], 'category' ); + if ( $the_cat ) { + $this->set( 'cat', $the_cat->term_id ); + $this->set( 'category_name', $the_cat->slug ); + } + unset( $the_cat ); + } - if ( ! empty( $tag_query['terms'][0] ) ) { - $the_tag = get_term_by( $tag_query['field'], $tag_query['terms'][0], 'post_tag' ); - if ( $the_tag ) - $this->set( 'tag_id', $the_tag->term_id ); - unset( $the_tag ); + if ( 'post_tag' === $queried_taxonomy ) { + $the_tag = get_term_by( $queried_items['field'], $queried_items['terms'][0], 'post_tag' ); + if ( $the_tag ) { + $this->set( 'tag_id', $the_tag->term_id ); } + unset( $the_tag ); } - unset( $tag_query ); } } @@ -2573,72 +2948,74 @@ class WP_Query { $where .= $search . $whichauthor . $whichmimetype; - if ( empty($q['order']) || ((strtoupper($q['order']) != 'ASC') && (strtoupper($q['order']) != 'DESC')) ) - $q['order'] = 'DESC'; + if ( ! empty( $this->meta_query->queries ) ) { + $clauses = $this->meta_query->get_sql( 'post', $wpdb->posts, 'ID', $this ); + $join .= $clauses['join']; + $where .= $clauses['where']; + } + + $rand = ( isset( $q['orderby'] ) && 'rand' === $q['orderby'] ); + if ( ! isset( $q['order'] ) ) { + $q['order'] = $rand ? '' : 'DESC'; + } else { + $q['order'] = $rand ? '' : $this->parse_order( $q['order'] ); + } - // Order by - if ( empty($q['orderby']) ) { - $orderby = "$wpdb->posts.post_date " . $q['order']; + // Order by. + if ( empty( $q['orderby'] ) ) { + /* + * Boolean false or empty array blanks out ORDER BY, + * while leaving the value unset or otherwise empty sets the default. + */ + if ( isset( $q['orderby'] ) && ( is_array( $q['orderby'] ) || false === $q['orderby'] ) ) { + $orderby = ''; + } else { + $orderby = "$wpdb->posts.post_date " . $q['order']; + } } elseif ( 'none' == $q['orderby'] ) { $orderby = ''; } elseif ( $q['orderby'] == 'post__in' && ! empty( $post__in ) ) { $orderby = "FIELD( {$wpdb->posts}.ID, $post__in )"; } elseif ( $q['orderby'] == 'post_parent__in' && ! empty( $post_parent__in ) ) { $orderby = "FIELD( {$wpdb->posts}.post_parent, $post_parent__in )"; + } elseif ( $q['orderby'] == 'post_name__in' && ! empty( $post_name__in ) ) { + $orderby = "FIELD( {$wpdb->posts}.post_name, $post_name__in )"; } else { - // Used to filter values - $allowed_keys = array('name', 'author', 'date', 'title', 'modified', 'menu_order', 'parent', 'ID', 'rand', 'comment_count'); - if ( !empty($q['meta_key']) ) { - $allowed_keys[] = $q['meta_key']; - $allowed_keys[] = 'meta_value'; - $allowed_keys[] = 'meta_value_num'; - } - $q['orderby'] = urldecode($q['orderby']); - $q['orderby'] = addslashes_gpc($q['orderby']); - $orderby_array = array(); - foreach ( explode( ' ', $q['orderby'] ) as $i => $orderby ) { - // Only allow certain values for safety - if ( ! in_array($orderby, $allowed_keys) ) - continue; + if ( is_array( $q['orderby'] ) ) { + foreach ( $q['orderby'] as $_orderby => $order ) { + $orderby = addslashes_gpc( urldecode( $_orderby ) ); + $parsed = $this->parse_orderby( $orderby ); - switch ( $orderby ) { - case 'menu_order': - $orderby = "$wpdb->posts.menu_order"; - break; - case 'ID': - $orderby = "$wpdb->posts.ID"; - break; - case 'rand': - $orderby = 'RAND()'; - break; - case $q['meta_key']: - case 'meta_value': - if ( isset( $q['meta_type'] ) ) { - $meta_type = $this->meta_query->get_cast_for_type( $q['meta_type'] ); - $orderby = "CAST($wpdb->postmeta.meta_value AS {$meta_type})"; - } else { - $orderby = "$wpdb->postmeta.meta_value"; - } - break; - case 'meta_value_num': - $orderby = "$wpdb->postmeta.meta_value+0"; - break; - case 'comment_count': - $orderby = "$wpdb->posts.comment_count"; - break; - default: - $orderby = "$wpdb->posts.post_" . $orderby; + if ( ! $parsed ) { + continue; + } + + $orderby_array[] = $parsed . ' ' . $this->parse_order( $order ); } + $orderby = implode( ', ', $orderby_array ); - $orderby_array[] = $orderby; - } - $orderby = implode( ',', $orderby_array ); + } else { + $q['orderby'] = urldecode( $q['orderby'] ); + $q['orderby'] = addslashes_gpc( $q['orderby'] ); + + foreach ( explode( ' ', $q['orderby'] ) as $i => $orderby ) { + $parsed = $this->parse_orderby( $orderby ); + // Only allow certain values for safety. + if ( ! $parsed ) { + continue; + } - if ( empty( $orderby ) ) - $orderby = "$wpdb->posts.post_date ".$q['order']; - else - $orderby .= " {$q['order']}"; + $orderby_array[] = $parsed; + } + $orderby = implode( ' ' . $q['order'] . ', ', $orderby_array ); + + if ( empty( $orderby ) ) { + $orderby = "$wpdb->posts.post_date " . $q['order']; + } elseif ( ! empty( $q['order'] ) ) { + $orderby .= " {$q['order']}"; + } + } } // Order search results by relevance only when another "orderby" is not specified in the query. @@ -2647,15 +3024,18 @@ class WP_Query { if ( ! empty( $q['search_orderby_title'] ) && ( empty( $q['orderby'] ) && ! $this->is_feed ) || ( isset( $q['orderby'] ) && 'relevance' === $q['orderby'] ) ) $search_orderby = $this->parse_search_order( $q ); - /** - * Filter the ORDER BY used when ordering search results. - * - * @since 3.7.0 - * - * @param string $search_orderby The ORDER BY clause. - * @param WP_Query $this The current WP_Query instance. - */ - $search_orderby = apply_filters( 'posts_search_orderby', $search_orderby, $this ); + if ( ! $q['suppress_filters'] ) { + /** + * Filters the ORDER BY used when ordering search results. + * + * @since 3.7.0 + * + * @param string $search_orderby The ORDER BY clause. + * @param WP_Query $this The current WP_Query instance. + */ + $search_orderby = apply_filters( 'posts_search_orderby', $search_orderby, $this ); + } + if ( $search_orderby ) $orderby = $orderby ? $search_orderby . ', ' . $orderby : $search_orderby; } @@ -2670,6 +3050,23 @@ class WP_Query { $post_type_cap = $post_type; } + if ( isset( $q['post_password'] ) ) { + $where .= $wpdb->prepare( " AND $wpdb->posts.post_password = %s", $q['post_password'] ); + if ( empty( $q['perm'] ) ) { + $q['perm'] = 'readable'; + } + } elseif ( isset( $q['has_password'] ) ) { + $where .= sprintf( " AND $wpdb->posts.post_password %s ''", $q['has_password'] ? '!=' : '=' ); + } + + if ( ! empty( $q['comment_status'] ) ) { + $where .= $wpdb->prepare( " AND $wpdb->posts.comment_status = %s ", $q['comment_status'] ); + } + + if ( ! empty( $q['ping_status'] ) ) { + $where .= $wpdb->prepare( " AND $wpdb->posts.ping_status = %s ", $q['ping_status'] ); + } + if ( 'any' == $post_type ) { $in_search_post_types = get_post_types( array('exclude_from_search' => false) ); if ( empty( $in_search_post_types ) ) @@ -2705,6 +3102,7 @@ class WP_Query { $user_id = get_current_user_id(); + $q_status = array(); if ( ! empty( $q['post_status'] ) ) { $statuswheres = array(); $q_status = $q['post_status']; @@ -2713,9 +3111,12 @@ class WP_Query { $r_status = array(); $p_status = array(); $e_status = array(); - if ( in_array('any', $q_status) ) { - foreach ( get_post_stati( array('exclude_from_search' => true) ) as $status ) - $e_status[] = "$wpdb->posts.post_status <> '$status'"; + if ( in_array( 'any', $q_status ) ) { + foreach ( get_post_stati( array( 'exclude_from_search' => true ) ) as $status ) { + if ( ! in_array( $status, $q_status ) ) { + $e_status[] = "$wpdb->posts.post_status <> '$status'"; + } + } } else { foreach ( get_post_stati() as $status ) { if ( in_array( $status, $q_status ) ) { @@ -2752,8 +3153,10 @@ class WP_Query { foreach ( $statuswheres as $index => $statuswhere ) $statuswheres[$index] = "($statuswhere OR ($wpdb->posts.post_status = 'inherit' AND " . str_replace($wpdb->posts, 'p2', $statuswhere) . "))"; } - foreach ( $statuswheres as $statuswhere ) - $where .= " AND $statuswhere"; + $where_status = implode( ' OR ', $statuswheres ); + if ( ! empty( $where_status ) ) { + $where .= " AND ($where_status)"; + } } elseif ( !$this->is_singular ) { $where .= " AND ($wpdb->posts.post_status = 'publish'"; @@ -2782,17 +3185,30 @@ class WP_Query { $where .= ')'; } - if ( !empty( $this->meta_query->queries ) ) { - $clauses = $this->meta_query->get_sql( 'post', $wpdb->posts, 'ID', $this ); - $join .= $clauses['join']; - $where .= $clauses['where']; - } - - // Apply filters on where and join prior to paging so that any - // manipulations to them are reflected in the paging by day queries. + /* + * Apply filters on where and join prior to paging so that any + * manipulations to them are reflected in the paging by day queries. + */ if ( !$q['suppress_filters'] ) { - $where = apply_filters_ref_array('posts_where', array( $where, &$this ) ); - $join = apply_filters_ref_array('posts_join', array( $join, &$this ) ); + /** + * Filters the WHERE clause of the query. + * + * @since 1.5.0 + * + * @param string $where The WHERE clause of the query. + * @param WP_Query &$this The WP_Query instance (passed by reference). + */ + $where = apply_filters_ref_array( 'posts_where', array( $where, &$this ) ); + + /** + * Filters the JOIN clause of the query. + * + * @since 1.5.0 + * + * @param string $where The JOIN clause of the query. + * @param WP_Query &$this The WP_Query instance (passed by reference). + */ + $join = apply_filters_ref_array( 'posts_join', array( $join, &$this ) ); } // Paging @@ -2801,38 +3217,85 @@ class WP_Query { if ( !$page ) $page = 1; - if ( empty($q['offset']) ) { - $pgstrt = ($page - 1) * $q['posts_per_page'] . ', '; - } else { // we're ignoring $page and using 'offset' - $q['offset'] = absint($q['offset']); + // If 'offset' is provided, it takes precedence over 'paged'. + if ( isset( $q['offset'] ) && is_numeric( $q['offset'] ) ) { + $q['offset'] = absint( $q['offset'] ); $pgstrt = $q['offset'] . ', '; + } else { + $pgstrt = absint( ( $page - 1 ) * $q['posts_per_page'] ) . ', '; } $limits = 'LIMIT ' . $pgstrt . $q['posts_per_page']; } // Comments feeds - if ( $this->is_comment_feed && ( $this->is_archive || $this->is_search || !$this->is_singular ) ) { + if ( $this->is_comment_feed && ! $this->is_singular ) { if ( $this->is_archive || $this->is_search ) { $cjoin = "JOIN $wpdb->posts ON ($wpdb->comments.comment_post_ID = $wpdb->posts.ID) $join "; $cwhere = "WHERE comment_approved = '1' $where"; $cgroupby = "$wpdb->comments.comment_id"; } else { // Other non singular e.g. front $cjoin = "JOIN $wpdb->posts ON ( $wpdb->comments.comment_post_ID = $wpdb->posts.ID )"; - $cwhere = "WHERE post_status = 'publish' AND comment_approved = '1'"; + $cwhere = "WHERE ( post_status = 'publish' OR ( post_status = 'inherit' && post_type = 'attachment' ) ) AND comment_approved = '1'"; $cgroupby = ''; } if ( !$q['suppress_filters'] ) { - $cjoin = apply_filters_ref_array('comment_feed_join', array( $cjoin, &$this ) ); - $cwhere = apply_filters_ref_array('comment_feed_where', array( $cwhere, &$this ) ); - $cgroupby = apply_filters_ref_array('comment_feed_groupby', array( $cgroupby, &$this ) ); - $corderby = apply_filters_ref_array('comment_feed_orderby', array( 'comment_date_gmt DESC', &$this ) ); - $climits = apply_filters_ref_array('comment_feed_limits', array( 'LIMIT ' . get_option('posts_per_rss'), &$this ) ); + /** + * Filters the JOIN clause of the comments feed query before sending. + * + * @since 2.2.0 + * + * @param string $cjoin The JOIN clause of the query. + * @param WP_Query &$this The WP_Query instance (passed by reference). + */ + $cjoin = apply_filters_ref_array( 'comment_feed_join', array( $cjoin, &$this ) ); + + /** + * Filters the WHERE clause of the comments feed query before sending. + * + * @since 2.2.0 + * + * @param string $cwhere The WHERE clause of the query. + * @param WP_Query &$this The WP_Query instance (passed by reference). + */ + $cwhere = apply_filters_ref_array( 'comment_feed_where', array( $cwhere, &$this ) ); + + /** + * Filters the GROUP BY clause of the comments feed query before sending. + * + * @since 2.2.0 + * + * @param string $cgroupby The GROUP BY clause of the query. + * @param WP_Query &$this The WP_Query instance (passed by reference). + */ + $cgroupby = apply_filters_ref_array( 'comment_feed_groupby', array( $cgroupby, &$this ) ); + + /** + * Filters the ORDER BY clause of the comments feed query before sending. + * + * @since 2.8.0 + * + * @param string $corderby The ORDER BY clause of the query. + * @param WP_Query &$this The WP_Query instance (passed by reference). + */ + $corderby = apply_filters_ref_array( 'comment_feed_orderby', array( 'comment_date_gmt DESC', &$this ) ); + + /** + * Filters the LIMIT clause of the comments feed query before sending. + * + * @since 2.8.0 + * + * @param string $climits The JOIN clause of the query. + * @param WP_Query &$this The WP_Query instance (passed by reference). + */ + $climits = apply_filters_ref_array( 'comment_feed_limits', array( 'LIMIT ' . get_option('posts_per_rss'), &$this ) ); } $cgroupby = ( ! empty( $cgroupby ) ) ? 'GROUP BY ' . $cgroupby : ''; $corderby = ( ! empty( $corderby ) ) ? 'ORDER BY ' . $corderby : ''; - $this->comments = (array) $wpdb->get_results("SELECT $distinct $wpdb->comments.* FROM $wpdb->comments $cjoin $cwhere $cgroupby $corderby $climits"); + $comments = (array) $wpdb->get_results("SELECT $distinct $wpdb->comments.* FROM $wpdb->comments $cjoin $cwhere $cgroupby $corderby $climits"); + // Convert to WP_Comment + $this->comments = array_map( 'get_comment', $comments ); $this->comment_count = count($this->comments); $post_ids = array(); @@ -2850,40 +3313,229 @@ class WP_Query { $pieces = array( 'where', 'groupby', 'join', 'orderby', 'distinct', 'fields', 'limits' ); - // Apply post-paging filters on where and join. Only plugins that - // manipulate paging queries should use these hooks. + /* + * Apply post-paging filters on where and join. Only plugins that + * manipulate paging queries should use these hooks. + */ if ( !$q['suppress_filters'] ) { - $where = apply_filters_ref_array( 'posts_where_paged', array( $where, &$this ) ); - $groupby = apply_filters_ref_array( 'posts_groupby', array( $groupby, &$this ) ); - $join = apply_filters_ref_array( 'posts_join_paged', array( $join, &$this ) ); - $orderby = apply_filters_ref_array( 'posts_orderby', array( $orderby, &$this ) ); - $distinct = apply_filters_ref_array( 'posts_distinct', array( $distinct, &$this ) ); - $limits = apply_filters_ref_array( 'post_limits', array( $limits, &$this ) ); - $fields = apply_filters_ref_array( 'posts_fields', array( $fields, &$this ) ); - - // Filter all clauses at once, for convenience + /** + * Filters the WHERE clause of the query. + * + * Specifically for manipulating paging queries. + * + * @since 1.5.0 + * + * @param string $where The WHERE clause of the query. + * @param WP_Query &$this The WP_Query instance (passed by reference). + */ + $where = apply_filters_ref_array( 'posts_where_paged', array( $where, &$this ) ); + + /** + * Filters the GROUP BY clause of the query. + * + * @since 2.0.0 + * + * @param string $groupby The GROUP BY clause of the query. + * @param WP_Query &$this The WP_Query instance (passed by reference). + */ + $groupby = apply_filters_ref_array( 'posts_groupby', array( $groupby, &$this ) ); + + /** + * Filters the JOIN clause of the query. + * + * Specifically for manipulating paging queries. + * + * @since 1.5.0 + * + * @param string $join The JOIN clause of the query. + * @param WP_Query &$this The WP_Query instance (passed by reference). + */ + $join = apply_filters_ref_array( 'posts_join_paged', array( $join, &$this ) ); + + /** + * Filters the ORDER BY clause of the query. + * + * @since 1.5.1 + * + * @param string $orderby The ORDER BY clause of the query. + * @param WP_Query &$this The WP_Query instance (passed by reference). + */ + $orderby = apply_filters_ref_array( 'posts_orderby', array( $orderby, &$this ) ); + + /** + * Filters the DISTINCT clause of the query. + * + * @since 2.1.0 + * + * @param string $distinct The DISTINCT clause of the query. + * @param WP_Query &$this The WP_Query instance (passed by reference). + */ + $distinct = apply_filters_ref_array( 'posts_distinct', array( $distinct, &$this ) ); + + /** + * Filters the LIMIT clause of the query. + * + * @since 2.1.0 + * + * @param string $limits The LIMIT clause of the query. + * @param WP_Query &$this The WP_Query instance (passed by reference). + */ + $limits = apply_filters_ref_array( 'post_limits', array( $limits, &$this ) ); + + /** + * Filters the SELECT clause of the query. + * + * @since 2.1.0 + * + * @param string $fields The SELECT clause of the query. + * @param WP_Query &$this The WP_Query instance (passed by reference). + */ + $fields = apply_filters_ref_array( 'posts_fields', array( $fields, &$this ) ); + + /** + * Filters all query clauses at once, for convenience. + * + * Covers the WHERE, GROUP BY, JOIN, ORDER BY, DISTINCT, + * fields (SELECT), and LIMITS clauses. + * + * @since 3.1.0 + * + * @param array $clauses The list of clauses for the query. + * @param WP_Query &$this The WP_Query instance (passed by reference). + */ $clauses = (array) apply_filters_ref_array( 'posts_clauses', array( compact( $pieces ), &$this ) ); - foreach ( $pieces as $piece ) - $$piece = isset( $clauses[ $piece ] ) ? $clauses[ $piece ] : ''; + + $where = isset( $clauses[ 'where' ] ) ? $clauses[ 'where' ] : ''; + $groupby = isset( $clauses[ 'groupby' ] ) ? $clauses[ 'groupby' ] : ''; + $join = isset( $clauses[ 'join' ] ) ? $clauses[ 'join' ] : ''; + $orderby = isset( $clauses[ 'orderby' ] ) ? $clauses[ 'orderby' ] : ''; + $distinct = isset( $clauses[ 'distinct' ] ) ? $clauses[ 'distinct' ] : ''; + $fields = isset( $clauses[ 'fields' ] ) ? $clauses[ 'fields' ] : ''; + $limits = isset( $clauses[ 'limits' ] ) ? $clauses[ 'limits' ] : ''; } - // Announce current selection parameters. For use by caching plugins. + /** + * Fires to announce the query's current selection parameters. + * + * For use by caching plugins. + * + * @since 2.3.0 + * + * @param string $selection The assembled selection query. + */ do_action( 'posts_selection', $where . $groupby . $orderby . $limits . $join ); - // Filter again for the benefit of caching plugins. Regular plugins should use the hooks above. + /* + * Filters again for the benefit of caching plugins. + * Regular plugins should use the hooks above. + */ if ( !$q['suppress_filters'] ) { - $where = apply_filters_ref_array( 'posts_where_request', array( $where, &$this ) ); - $groupby = apply_filters_ref_array( 'posts_groupby_request', array( $groupby, &$this ) ); - $join = apply_filters_ref_array( 'posts_join_request', array( $join, &$this ) ); - $orderby = apply_filters_ref_array( 'posts_orderby_request', array( $orderby, &$this ) ); - $distinct = apply_filters_ref_array( 'posts_distinct_request', array( $distinct, &$this ) ); - $fields = apply_filters_ref_array( 'posts_fields_request', array( $fields, &$this ) ); - $limits = apply_filters_ref_array( 'post_limits_request', array( $limits, &$this ) ); - - // Filter all clauses at once, for convenience + /** + * Filters the WHERE clause of the query. + * + * For use by caching plugins. + * + * @since 2.5.0 + * + * @param string $where The WHERE clause of the query. + * @param WP_Query &$this The WP_Query instance (passed by reference). + */ + $where = apply_filters_ref_array( 'posts_where_request', array( $where, &$this ) ); + + /** + * Filters the GROUP BY clause of the query. + * + * For use by caching plugins. + * + * @since 2.5.0 + * + * @param string $groupby The GROUP BY clause of the query. + * @param WP_Query &$this The WP_Query instance (passed by reference). + */ + $groupby = apply_filters_ref_array( 'posts_groupby_request', array( $groupby, &$this ) ); + + /** + * Filters the JOIN clause of the query. + * + * For use by caching plugins. + * + * @since 2.5.0 + * + * @param string $join The JOIN clause of the query. + * @param WP_Query &$this The WP_Query instance (passed by reference). + */ + $join = apply_filters_ref_array( 'posts_join_request', array( $join, &$this ) ); + + /** + * Filters the ORDER BY clause of the query. + * + * For use by caching plugins. + * + * @since 2.5.0 + * + * @param string $orderby The ORDER BY clause of the query. + * @param WP_Query &$this The WP_Query instance (passed by reference). + */ + $orderby = apply_filters_ref_array( 'posts_orderby_request', array( $orderby, &$this ) ); + + /** + * Filters the DISTINCT clause of the query. + * + * For use by caching plugins. + * + * @since 2.5.0 + * + * @param string $distinct The DISTINCT clause of the query. + * @param WP_Query &$this The WP_Query instance (passed by reference). + */ + $distinct = apply_filters_ref_array( 'posts_distinct_request', array( $distinct, &$this ) ); + + /** + * Filters the SELECT clause of the query. + * + * For use by caching plugins. + * + * @since 2.5.0 + * + * @param string $fields The SELECT clause of the query. + * @param WP_Query &$this The WP_Query instance (passed by reference). + */ + $fields = apply_filters_ref_array( 'posts_fields_request', array( $fields, &$this ) ); + + /** + * Filters the LIMIT clause of the query. + * + * For use by caching plugins. + * + * @since 2.5.0 + * + * @param string $limits The LIMIT clause of the query. + * @param WP_Query &$this The WP_Query instance (passed by reference). + */ + $limits = apply_filters_ref_array( 'post_limits_request', array( $limits, &$this ) ); + + /** + * Filters all query clauses at once, for convenience. + * + * For use by caching plugins. + * + * Covers the WHERE, GROUP BY, JOIN, ORDER BY, DISTINCT, + * fields (SELECT), and LIMITS clauses. + * + * @since 3.1.0 + * + * @param array $pieces The pieces of the query. + * @param WP_Query &$this The WP_Query instance (passed by reference). + */ $clauses = (array) apply_filters_ref_array( 'posts_clauses_request', array( compact( $pieces ), &$this ) ); - foreach ( $pieces as $piece ) - $$piece = isset( $clauses[ $piece ] ) ? $clauses[ $piece ] : ''; + + $where = isset( $clauses[ 'where' ] ) ? $clauses[ 'where' ] : ''; + $groupby = isset( $clauses[ 'groupby' ] ) ? $clauses[ 'groupby' ] : ''; + $join = isset( $clauses[ 'join' ] ) ? $clauses[ 'join' ] : ''; + $orderby = isset( $clauses[ 'orderby' ] ) ? $clauses[ 'orderby' ] : ''; + $distinct = isset( $clauses[ 'distinct' ] ) ? $clauses[ 'distinct' ] : ''; + $fields = isset( $clauses[ 'fields' ] ) ? $clauses[ 'fields' ] : ''; + $limits = isset( $clauses[ 'limits' ] ) ? $clauses[ 'limits' ] : ''; } if ( ! empty($groupby) ) @@ -2898,11 +3550,41 @@ class WP_Query { $this->request = $old_request = "SELECT $found_rows $distinct $fields FROM $wpdb->posts $join WHERE 1=1 $where $groupby $orderby $limits"; if ( !$q['suppress_filters'] ) { + /** + * Filters the completed SQL query before sending. + * + * @since 2.0.0 + * + * @param string $request The complete SQL query. + * @param WP_Query &$this The WP_Query instance (passed by reference). + */ $this->request = apply_filters_ref_array( 'posts_request', array( $this->request, &$this ) ); } + /** + * Filters the posts array before the query takes place. + * + * Return a non-null value to bypass WordPress's default post queries. + * + * Filtering functions that require pagination information are encouraged to set + * the `found_posts` and `max_num_pages` properties of the WP_Query object, + * passed to the filter by reference. If WP_Query does not perform a database + * query, it will not have enough information to generate these values itself. + * + * @since 4.6.0 + * + * @param array|null $posts Return an array of post data to short-circuit WP's query, + * or null to allow WP to run its normal queries. + * @param WP_Query $this The WP_Query instance, passed by reference. + */ + $this->posts = apply_filters_ref_array( 'posts_pre_query', array( null, &$this ) ); + if ( 'ids' == $q['fields'] ) { - $this->posts = $wpdb->get_col( $this->request ); + if ( null === $this->posts ) { + $this->posts = $wpdb->get_col( $this->request ); + } + + $this->posts = array_map( 'intval', $this->posts ); $this->post_count = count( $this->posts ); $this->set_found_posts( $q, $limits ); @@ -2910,68 +3592,126 @@ class WP_Query { } if ( 'id=>parent' == $q['fields'] ) { - $this->posts = $wpdb->get_results( $this->request ); + if ( null === $this->posts ) { + $this->posts = $wpdb->get_results( $this->request ); + } + $this->post_count = count( $this->posts ); $this->set_found_posts( $q, $limits ); $r = array(); - foreach ( $this->posts as $post ) - $r[ $post->ID ] = $post->post_parent; + foreach ( $this->posts as $key => $post ) { + $this->posts[ $key ]->ID = (int) $post->ID; + $this->posts[ $key ]->post_parent = (int) $post->post_parent; + + $r[ (int) $post->ID ] = (int) $post->post_parent; + } return $r; } - $split_the_query = ( $old_request == $this->request && "$wpdb->posts.*" == $fields && !empty( $limits ) && $q['posts_per_page'] < 500 ); - $split_the_query = apply_filters( 'split_the_query', $split_the_query, $this ); + if ( null === $this->posts ) { + $split_the_query = ( $old_request == $this->request && "$wpdb->posts.*" == $fields && !empty( $limits ) && $q['posts_per_page'] < 500 ); - if ( $split_the_query ) { - // First get the IDs and then fill in the objects + /** + * Filters whether to split the query. + * + * Splitting the query will cause it to fetch just the IDs of the found posts + * (and then individually fetch each post by ID), rather than fetching every + * complete row at once. One massive result vs. many small results. + * + * @since 3.4.0 + * + * @param bool $split_the_query Whether or not to split the query. + * @param WP_Query $this The WP_Query instance. + */ + $split_the_query = apply_filters( 'split_the_query', $split_the_query, $this ); - $this->request = "SELECT $found_rows $distinct $wpdb->posts.ID FROM $wpdb->posts $join WHERE 1=1 $where $groupby $orderby $limits"; + if ( $split_the_query ) { + // First get the IDs and then fill in the objects - $this->request = apply_filters( 'posts_request_ids', $this->request, $this ); + $this->request = "SELECT $found_rows $distinct $wpdb->posts.ID FROM $wpdb->posts $join WHERE 1=1 $where $groupby $orderby $limits"; - $ids = $wpdb->get_col( $this->request ); + /** + * Filters the Post IDs SQL request before sending. + * + * @since 3.4.0 + * + * @param string $request The post ID request. + * @param WP_Query $this The WP_Query instance. + */ + $this->request = apply_filters( 'posts_request_ids', $this->request, $this ); - if ( $ids ) { - $this->posts = $ids; - $this->set_found_posts( $q, $limits ); - _prime_post_caches( $ids, $q['update_post_term_cache'], $q['update_post_meta_cache'] ); + $ids = $wpdb->get_col( $this->request ); + + if ( $ids ) { + $this->posts = $ids; + $this->set_found_posts( $q, $limits ); + _prime_post_caches( $ids, $q['update_post_term_cache'], $q['update_post_meta_cache'] ); + } else { + $this->posts = array(); + } } else { - $this->posts = array(); + $this->posts = $wpdb->get_results( $this->request ); + $this->set_found_posts( $q, $limits ); } - } else { - $this->posts = $wpdb->get_results( $this->request ); - $this->set_found_posts( $q, $limits ); } - // Convert to WP_Post objects - if ( $this->posts ) + // Convert to WP_Post objects. + if ( $this->posts ) { $this->posts = array_map( 'get_post', $this->posts ); + } - // Raw results filter. Prior to status checks. - if ( !$q['suppress_filters'] ) - $this->posts = apply_filters_ref_array('posts_results', array( $this->posts, &$this ) ); + if ( ! $q['suppress_filters'] ) { + /** + * Filters the raw post results array, prior to status checks. + * + * @since 2.3.0 + * + * @param array $posts The post results array. + * @param WP_Query &$this The WP_Query instance (passed by reference). + */ + $this->posts = apply_filters_ref_array( 'posts_results', array( $this->posts, &$this ) ); + } if ( !empty($this->posts) && $this->is_comment_feed && $this->is_singular ) { - $cjoin = apply_filters_ref_array('comment_feed_join', array( '', &$this ) ); - $cwhere = apply_filters_ref_array('comment_feed_where', array( "WHERE comment_post_ID = '{$this->posts[0]->ID}' AND comment_approved = '1'", &$this ) ); - $cgroupby = apply_filters_ref_array('comment_feed_groupby', array( '', &$this ) ); + /** This filter is documented in wp-includes/query.php */ + $cjoin = apply_filters_ref_array( 'comment_feed_join', array( '', &$this ) ); + + /** This filter is documented in wp-includes/query.php */ + $cwhere = apply_filters_ref_array( 'comment_feed_where', array( "WHERE comment_post_ID = '{$this->posts[0]->ID}' AND comment_approved = '1'", &$this ) ); + + /** This filter is documented in wp-includes/query.php */ + $cgroupby = apply_filters_ref_array( 'comment_feed_groupby', array( '', &$this ) ); $cgroupby = ( ! empty( $cgroupby ) ) ? 'GROUP BY ' . $cgroupby : ''; - $corderby = apply_filters_ref_array('comment_feed_orderby', array( 'comment_date_gmt DESC', &$this ) ); + + /** This filter is documented in wp-includes/query.php */ + $corderby = apply_filters_ref_array( 'comment_feed_orderby', array( 'comment_date_gmt DESC', &$this ) ); $corderby = ( ! empty( $corderby ) ) ? 'ORDER BY ' . $corderby : ''; - $climits = apply_filters_ref_array('comment_feed_limits', array( 'LIMIT ' . get_option('posts_per_rss'), &$this ) ); + + /** This filter is documented in wp-includes/query.php */ + $climits = apply_filters_ref_array( 'comment_feed_limits', array( 'LIMIT ' . get_option('posts_per_rss'), &$this ) ); + $comments_request = "SELECT $wpdb->comments.* FROM $wpdb->comments $cjoin $cwhere $cgroupby $corderby $climits"; - $this->comments = $wpdb->get_results($comments_request); + $comments = $wpdb->get_results($comments_request); + // Convert to WP_Comment + $this->comments = array_map( 'get_comment', $comments ); $this->comment_count = count($this->comments); } // Check post status to determine if post should be displayed. if ( !empty($this->posts) && ($this->is_single || $this->is_page) ) { $status = get_post_status($this->posts[0]); + if ( 'attachment' === $this->posts[0]->post_type && 0 === (int) $this->posts[0]->post_parent ) { + $this->is_page = false; + $this->is_single = true; + $this->is_attachment = true; + } $post_status_obj = get_post_status_object($status); - //$type = get_post_type($this->posts[0]); - if ( !$post_status_obj->public ) { + + // If the post_status was specifically requested, let it pass through. + if ( !$post_status_obj->public && ! in_array( $status, $q_status ) ) { + if ( ! is_user_logged_in() ) { // User must be logged in to view unpublished posts. $this->posts = array(); @@ -2994,8 +3734,17 @@ class WP_Query { } } - if ( $this->is_preview && $this->posts && current_user_can( $edit_cap, $this->posts[0]->ID ) ) + if ( $this->is_preview && $this->posts && current_user_can( $edit_cap, $this->posts[0]->ID ) ) { + /** + * Filters the single post for preview mode. + * + * @since 2.7.0 + * + * @param WP_Post $post_preview The Post object. + * @param WP_Query &$this The WP_Query instance (passed by reference). + */ $this->posts[0] = get_post( apply_filters_ref_array( 'the_preview', array( $this->posts[0], &$this ) ) ); + } } // Put sticky posts at the top of the posts array @@ -3039,8 +3788,23 @@ class WP_Query { } } - if ( !$q['suppress_filters'] ) - $this->posts = apply_filters_ref_array('the_posts', array( $this->posts, &$this ) ); + // If comments have been fetched as part of the query, make sure comment meta lazy-loading is set up. + if ( ! empty( $this->comments ) ) { + wp_queue_comments_for_comment_meta_lazyload( $this->comments ); + } + + if ( ! $q['suppress_filters'] ) { + /** + * Filters the array of retrieved posts after they've been fetched and + * internally processed. + * + * @since 1.5.0 + * + * @param array $posts The array of retrieved posts. + * @param WP_Query &$this The WP_Query instance (passed by reference). + */ + $this->posts = apply_filters_ref_array( 'the_posts', array( $this->posts, &$this ) ); + } // Ensure that any posts added/modified via one of the filters above are // of the type WP_Post and are filtered. @@ -3058,6 +3822,10 @@ class WP_Query { $this->posts = array(); } + if ( $q['lazy_load_term_meta'] ) { + wp_queue_posts_for_term_meta_lazyload( $this->posts ); + } + return $this->posts; } @@ -3067,8 +3835,13 @@ class WP_Query { * * @since 3.5.0 * @access private + * + * @global wpdb $wpdb WordPress database abstraction object. + * + * @param array $q Query variables. + * @param string $limits LIMIT clauses of the query. */ - function set_found_posts( $q, $limits ) { + private function set_found_posts( $q, $limits ) { global $wpdb; // Bail if posts is an empty array. Continue if posts is an empty string, @@ -3076,11 +3849,28 @@ class WP_Query { if ( $q['no_found_rows'] || ( is_array( $this->posts ) && ! $this->posts ) ) return; - if ( ! empty( $limits ) ) + if ( ! empty( $limits ) ) { + /** + * Filters the query to run for retrieving the found posts. + * + * @since 2.1.0 + * + * @param string $found_posts The query to run to find the found posts. + * @param WP_Query &$this The WP_Query instance (passed by reference). + */ $this->found_posts = $wpdb->get_var( apply_filters_ref_array( 'found_posts_query', array( 'SELECT FOUND_ROWS()', &$this ) ) ); - else + } else { $this->found_posts = count( $this->posts ); + } + /** + * Filters the number of found posts for the query. + * + * @since 2.1.0 + * + * @param int $found_posts The number of posts found. + * @param WP_Query &$this The WP_Query instance (passed by reference). + */ $this->found_posts = apply_filters_ref_array( 'found_posts', array( $this->found_posts, &$this ) ); if ( ! empty( $limits ) ) @@ -3095,7 +3885,7 @@ class WP_Query { * * @return WP_Post Next post. */ - function next_post() { + public function next_post() { $this->current_post++; @@ -3111,36 +3901,49 @@ class WP_Query { * * @since 1.5.0 * @access public - * @uses $post - * @uses do_action_ref_array() Calls 'loop_start' if loop has just started + * + * @global WP_Post $post */ - function the_post() { + public function the_post() { global $post; $this->in_the_loop = true; if ( $this->current_post == -1 ) // loop has just started - do_action_ref_array('loop_start', array(&$this)); + /** + * Fires once the loop is started. + * + * @since 2.0.0 + * + * @param WP_Query &$this The WP_Query instance (passed by reference). + */ + do_action_ref_array( 'loop_start', array( &$this ) ); $post = $this->next_post(); - setup_postdata($post); + $this->setup_postdata( $post ); } /** - * Whether there are more posts available in the loop. + * Determines whether there are more posts available in the loop. * - * Calls action 'loop_end', when the loop is complete. + * Calls the {@see 'loop_end'} action when the loop is complete. * * @since 1.5.0 * @access public - * @uses do_action_ref_array() Calls 'loop_end' if loop is ended * * @return bool True if posts are available, false if end of loop. */ - function have_posts() { + public function have_posts() { if ( $this->current_post + 1 < $this->post_count ) { return true; } elseif ( $this->current_post + 1 == $this->post_count && $this->post_count > 0 ) { - do_action_ref_array('loop_end', array(&$this)); + /** + * Fires once the loop has ended. + * + * @since 2.0.0 + * + * @param WP_Query &$this The WP_Query instance (passed by reference). + */ + do_action_ref_array( 'loop_end', array( &$this ) ); // Do some cleaning up after the loop $this->rewind_posts(); } @@ -3155,7 +3958,7 @@ class WP_Query { * @since 1.5.0 * @access public */ - function rewind_posts() { + public function rewind_posts() { $this->current_post = -1; if ( $this->post_count > 0 ) { $this->post = $this->posts[0]; @@ -3163,14 +3966,14 @@ class WP_Query { } /** - * Iterate current comment index and return comment object. + * Iterate current comment index and return WP_Comment object. * * @since 2.2.0 * @access public * - * @return object Comment object. + * @return WP_Comment Comment object. */ - function next_comment() { + public function next_comment() { $this->current_comment++; $this->comment = $this->comments[$this->current_comment]; @@ -3182,16 +3985,20 @@ class WP_Query { * * @since 2.2.0 * @access public - * @global object $comment Current comment. - * @uses do_action() Calls 'comment_loop_start' hook when first comment is processed. + * @global WP_Comment $comment Current comment. */ - function the_comment() { + public function the_comment() { global $comment; $comment = $this->next_comment(); if ( $this->current_comment == 0 ) { - do_action('comment_loop_start'); + /** + * Fires once the comment loop is started. + * + * @since 2.2.0 + */ + do_action( 'comment_loop_start' ); } } @@ -3205,7 +4012,7 @@ class WP_Query { * * @return bool True, if more comments. False, if no more posts. */ - function have_comments() { + public function have_comments() { if ( $this->current_comment + 1 < $this->comment_count ) { return true; } elseif ( $this->current_comment + 1 == $this->comment_count ) { @@ -3221,7 +4028,7 @@ class WP_Query { * @since 2.2.0 * @access public */ - function rewind_comments() { + public function rewind_comments() { $this->current_comment = -1; if ( $this->comment_count > 0 ) { $this->comment = $this->comments[0]; @@ -3237,7 +4044,7 @@ class WP_Query { * @param string $query URL query string. * @return array List of posts. */ - function query( $query ) { + public function query( $query ) { $this->init(); $this->query = $this->query_vars = wp_parse_args( $query ); return $this->get_posts(); @@ -3255,26 +4062,43 @@ class WP_Query { * * @return object */ - function get_queried_object() { + public function get_queried_object() { if ( isset($this->queried_object) ) return $this->queried_object; $this->queried_object = null; - $this->queried_object_id = 0; + $this->queried_object_id = null; if ( $this->is_category || $this->is_tag || $this->is_tax ) { if ( $this->is_category ) { - $term = get_term( $this->get( 'cat' ), 'category' ); + if ( $this->get( 'cat' ) ) { + $term = get_term( $this->get( 'cat' ), 'category' ); + } elseif ( $this->get( 'category_name' ) ) { + $term = get_term_by( 'slug', $this->get( 'category_name' ), 'category' ); + } } elseif ( $this->is_tag ) { - $term = get_term( $this->get( 'tag_id' ), 'post_tag' ); + if ( $this->get( 'tag_id' ) ) { + $term = get_term( $this->get( 'tag_id' ), 'post_tag' ); + } elseif ( $this->get( 'tag' ) ) { + $term = get_term_by( 'slug', $this->get( 'tag' ), 'post_tag' ); + } } else { - $tax_query_in_and = wp_list_filter( $this->tax_query->queries, array( 'operator' => 'NOT IN' ), 'NOT' ); - $query = reset( $tax_query_in_and ); + // For other tax queries, grab the first term from the first clause. + $tax_query_in_and = wp_list_filter( $this->tax_query->queried_terms, array( 'operator' => 'NOT IN' ), 'NOT' ); - if ( 'term_id' == $query['field'] ) - $term = get_term( reset( $query['terms'] ), $query['taxonomy'] ); - else - $term = get_term_by( $query['field'], reset( $query['terms'] ), $query['taxonomy'] ); + if ( ! empty( $tax_query_in_and ) ) { + $queried_taxonomies = array_keys( $tax_query_in_and ); + $matched_taxonomy = reset( $queried_taxonomies ); + $query = $tax_query_in_and[ $matched_taxonomy ]; + + if ( $query['terms'] ) { + if ( 'term_id' == $query['field'] ) { + $term = get_term( reset( $query['terms'] ), $matched_taxonomy ); + } else { + $term = get_term_by( $query['field'], reset( $query['terms'] ), $matched_taxonomy ); + } + } + } } if ( ! empty( $term ) && ! is_wp_error( $term ) ) { @@ -3293,7 +4117,7 @@ class WP_Query { $page_for_posts = get_option('page_for_posts'); $this->queried_object = get_post( $page_for_posts ); $this->queried_object_id = (int) $this->queried_object->ID; - } elseif ( $this->is_singular && !is_null($this->post) ) { + } elseif ( $this->is_singular && ! empty( $this->post ) ) { $this->queried_object = $this->post; $this->queried_object_id = (int) $this->post->ID; } elseif ( $this->is_author ) { @@ -3312,7 +4136,7 @@ class WP_Query { * * @return int */ - function get_queried_object_id() { + public function get_queried_object_id() { $this->get_queried_object(); if ( isset($this->queried_object_id) ) { @@ -3330,15 +4154,61 @@ class WP_Query { * @since 1.5.0 * @access public * - * @param string $query URL query string. - * @return WP_Query + * @param string|array $query URL query string or array of vars. */ - function __construct($query = '') { + public function __construct($query = '') { if ( ! empty($query) ) { $this->query($query); } } + /** + * Make private properties readable for backward compatibility. + * + * @since 4.0.0 + * @access public + * + * @param string $name Property to get. + * @return mixed Property. + */ + public function __get( $name ) { + if ( in_array( $name, $this->compat_fields ) ) { + return $this->$name; + } + } + + /** + * Make private properties checkable for backward compatibility. + * + * @since 4.0.0 + * @access public + * + * @param string $name Property to check if set. + * @return bool Whether the property is set. + */ + public function __isset( $name ) { + if ( in_array( $name, $this->compat_fields ) ) { + return isset( $this->$name ); + } + } + + /** + * Make private/protected methods readable for backward compatibility. + * + * @since 4.0.0 + * @access public + * + * @param callable $name Method to call. + * @param array $arguments Arguments to pass when calling. + * @return mixed|false Return value of the callback, false otherwise. + */ + public function __call( $name, $arguments ) { + if ( in_array( $name, $this->compat_methods ) ) { + return call_user_func_array( array( $this, $name ), $arguments ); + } + return false; + } + /** * Is the query for an existing archive page? * @@ -3348,7 +4218,7 @@ class WP_Query { * * @return bool */ - function is_archive() { + public function is_archive() { return (bool) $this->is_archive; } @@ -3360,7 +4230,7 @@ class WP_Query { * @param mixed $post_types Optional. Post type or array of posts types to check against. * @return bool */ - function is_post_type_archive( $post_types = '' ) { + public function is_post_type_archive( $post_types = '' ) { if ( empty( $post_types ) || ! $this->is_post_type_archive ) return (bool) $this->is_post_type_archive; @@ -3377,10 +4247,30 @@ class WP_Query { * * @since 3.1.0 * + * @param mixed $attachment Attachment ID, title, slug, or array of such. * @return bool */ - function is_attachment() { - return (bool) $this->is_attachment; + public function is_attachment( $attachment = '' ) { + if ( ! $this->is_attachment ) { + return false; + } + + if ( empty( $attachment ) ) { + return true; + } + + $attachment = array_map( 'strval', (array) $attachment ); + + $post_obj = $this->get_queried_object(); + + if ( in_array( (string) $post_obj->ID, $attachment ) ) { + return true; + } elseif ( in_array( $post_obj->post_title, $attachment ) ) { + return true; + } elseif ( in_array( $post_obj->post_name, $attachment ) ) { + return true; + } + return false; } /** @@ -3394,7 +4284,7 @@ class WP_Query { * @param mixed $author Optional. User ID, nickname, nicename, or array of User IDs, nicknames, and nicenames * @return bool */ - function is_author( $author = '' ) { + public function is_author( $author = '' ) { if ( !$this->is_author ) return false; @@ -3403,9 +4293,9 @@ class WP_Query { $author_obj = $this->get_queried_object(); - $author = (array) $author; + $author = array_map( 'strval', (array) $author ); - if ( in_array( $author_obj->ID, $author ) ) + if ( in_array( (string) $author_obj->ID, $author ) ) return true; elseif ( in_array( $author_obj->nickname, $author ) ) return true; @@ -3426,7 +4316,7 @@ class WP_Query { * @param mixed $category Optional. Category ID, name, slug, or array of Category IDs, names, and slugs. * @return bool */ - function is_category( $category = '' ) { + public function is_category( $category = '' ) { if ( !$this->is_category ) return false; @@ -3435,9 +4325,9 @@ class WP_Query { $cat_obj = $this->get_queried_object(); - $category = (array) $category; + $category = array_map( 'strval', (array) $category ); - if ( in_array( $cat_obj->term_id, $category ) ) + if ( in_array( (string) $cat_obj->term_id, $category ) ) return true; elseif ( in_array( $cat_obj->name, $category ) ) return true; @@ -3458,7 +4348,7 @@ class WP_Query { * @param mixed $tag Optional. Tag ID, name, slug, or array of Tag IDs, names, and slugs. * @return bool */ - function is_tag( $tag = '' ) { + public function is_tag( $tag = '' ) { if ( ! $this->is_tag ) return false; @@ -3467,9 +4357,9 @@ class WP_Query { $tag_obj = $this->get_queried_object(); - $tag = (array) $tag; + $tag = array_map( 'strval', (array) $tag ); - if ( in_array( $tag_obj->term_id, $tag ) ) + if ( in_array( (string) $tag_obj->term_id, $tag ) ) return true; elseif ( in_array( $tag_obj->name, $tag ) ) return true; @@ -3480,7 +4370,7 @@ class WP_Query { } /** - * Is the query for an existing taxonomy archive page? + * Is the query for an existing custom taxonomy archive page? * * If the $taxonomy parameter is specified, this function will additionally * check if the query is for that specific $taxonomy. @@ -3491,11 +4381,13 @@ class WP_Query { * * @since 3.1.0 * + * @global array $wp_taxonomies + * * @param mixed $taxonomy Optional. Taxonomy slug or slugs. - * @param mixed $term. Optional. Term ID, name, slug or array of Term IDs, names, and slugs. - * @return bool + * @param mixed $term Optional. Term ID, name, slug or array of Term IDs, names, and slugs. + * @return bool True for custom taxonomy archive pages, false for built-in taxonomies (category and tag archives). */ - function is_tax( $taxonomy = '', $term = '' ) { + public function is_tax( $taxonomy = '', $term = '' ) { global $wp_taxonomies; if ( !$this->is_tax ) @@ -3527,11 +4419,14 @@ class WP_Query { * Whether the current URL is within the comments popup window. * * @since 3.1.0 + * @deprecated 4.5.0 * * @return bool */ - function is_comments_popup() { - return (bool) $this->is_comments_popup; + public function is_comments_popup() { + _deprecated_function( __FUNCTION__, '4.5.0' ); + + return false; } /** @@ -3541,7 +4436,7 @@ class WP_Query { * * @return bool */ - function is_date() { + public function is_date() { return (bool) $this->is_date; } @@ -3552,7 +4447,7 @@ class WP_Query { * * @return bool */ - function is_day() { + public function is_day() { return (bool) $this->is_day; } @@ -3564,7 +4459,7 @@ class WP_Query { * @param string|array $feeds Optional feed types to check. * @return bool */ - function is_feed( $feeds = '' ) { + public function is_feed( $feeds = '' ) { if ( empty( $feeds ) || ! $this->is_feed ) return (bool) $this->is_feed; $qv = $this->get( 'feed' ); @@ -3580,7 +4475,7 @@ class WP_Query { * * @return bool */ - function is_comment_feed() { + public function is_comment_feed() { return (bool) $this->is_comment_feed; } @@ -3597,12 +4492,10 @@ class WP_Query { * Otherwise the same as @see WP_Query::is_home() * * @since 3.1.0 - * @uses is_home() - * @uses get_option() * * @return bool True, if front of site. */ - function is_front_page() { + public function is_front_page() { // most likely case if ( 'posts' == get_option( 'show_on_front') && $this->is_home() ) return true; @@ -3628,7 +4521,7 @@ class WP_Query { * * @return bool True if blog view homepage. */ - function is_home() { + public function is_home() { return (bool) $this->is_home; } @@ -3639,7 +4532,7 @@ class WP_Query { * * @return bool */ - function is_month() { + public function is_month() { return (bool) $this->is_month; } @@ -3654,10 +4547,10 @@ class WP_Query { * * @since 3.1.0 * - * @param mixed $page Page ID, title, slug, or array of such. - * @return bool + * @param int|string|array $page Optional. Page ID, title, slug, path, or array of such. Default empty. + * @return bool Whether the query is for an existing single page. */ - function is_page( $page = '' ) { + public function is_page( $page = '' ) { if ( !$this->is_page ) return false; @@ -3666,14 +4559,26 @@ class WP_Query { $page_obj = $this->get_queried_object(); - $page = (array) $page; + $page = array_map( 'strval', (array) $page ); - if ( in_array( $page_obj->ID, $page ) ) + if ( in_array( (string) $page_obj->ID, $page ) ) { return true; - elseif ( in_array( $page_obj->post_title, $page ) ) + } elseif ( in_array( $page_obj->post_title, $page ) ) { return true; - else if ( in_array( $page_obj->post_name, $page ) ) + } elseif ( in_array( $page_obj->post_name, $page ) ) { return true; + } else { + foreach ( $page as $pagepath ) { + if ( ! strpos( $pagepath, '/' ) ) { + continue; + } + $pagepath_obj = get_page_by_path( $pagepath ); + + if ( $pagepath_obj && ( $pagepath_obj->ID == $page_obj->ID ) ) { + return true; + } + } + } return false; } @@ -3685,7 +4590,7 @@ class WP_Query { * * @return bool */ - function is_paged() { + public function is_paged() { return (bool) $this->is_paged; } @@ -3696,7 +4601,7 @@ class WP_Query { * * @return bool */ - function is_preview() { + public function is_preview() { return (bool) $this->is_preview; } @@ -3707,7 +4612,7 @@ class WP_Query { * * @return bool */ - function is_robots() { + public function is_robots() { return (bool) $this->is_robots; } @@ -3718,7 +4623,7 @@ class WP_Query { * * @return bool */ - function is_search() { + public function is_search() { return (bool) $this->is_search; } @@ -3735,10 +4640,10 @@ class WP_Query { * * @since 3.1.0 * - * @param mixed $post Post ID, title, slug, or array of such. - * @return bool + * @param int|string|array $post Optional. Post ID, title, slug, path, or array of such. Default empty. + * @return bool Whether the query is for an existing single post. */ - function is_single( $post = '' ) { + public function is_single( $post = '' ) { if ( !$this->is_single ) return false; @@ -3747,15 +4652,26 @@ class WP_Query { $post_obj = $this->get_queried_object(); - $post = (array) $post; + $post = array_map( 'strval', (array) $post ); - if ( in_array( $post_obj->ID, $post ) ) + if ( in_array( (string) $post_obj->ID, $post ) ) { return true; - elseif ( in_array( $post_obj->post_title, $post ) ) + } elseif ( in_array( $post_obj->post_title, $post ) ) { return true; - elseif ( in_array( $post_obj->post_name, $post ) ) + } elseif ( in_array( $post_obj->post_name, $post ) ) { return true; + } else { + foreach ( $post as $postpath ) { + if ( ! strpos( $postpath, '/' ) ) { + continue; + } + $postpath_obj = get_page_by_path( $postpath, OBJECT, $post_obj->post_type ); + if ( $postpath_obj && ( $postpath_obj->ID == $post_obj->ID ) ) { + return true; + } + } + } return false; } @@ -3770,10 +4686,10 @@ class WP_Query { * * @since 3.1.0 * - * @param mixed $post_types Optional. Post Type or array of Post Types - * @return bool + * @param string|array $post_types Optional. Post type or array of post types. Default empty. + * @return bool Whether the query is for an existing single post of any of the given post types. */ - function is_singular( $post_types = '' ) { + public function is_singular( $post_types = '' ) { if ( empty( $post_types ) || !$this->is_singular ) return (bool) $this->is_singular; @@ -3789,7 +4705,7 @@ class WP_Query { * * @return bool */ - function is_time() { + public function is_time() { return (bool) $this->is_time; } @@ -3800,7 +4716,7 @@ class WP_Query { * * @return bool */ - function is_trackback() { + public function is_trackback() { return (bool) $this->is_trackback; } @@ -3811,7 +4727,7 @@ class WP_Query { * * @return bool */ - function is_year() { + public function is_year() { return (bool) $this->is_year; } @@ -3822,36 +4738,186 @@ class WP_Query { * * @return bool */ - function is_404() { + public function is_404() { return (bool) $this->is_404; } + /** + * Is the query for an embedded post? + * + * @since 4.4.0 + * + * @return bool + */ + public function is_embed() { + return (bool) $this->is_embed; + } + /** * Is the query the main query? * * @since 3.3.0 * + * @global WP_Query $wp_query Global WP_Query instance. + * * @return bool */ - function is_main_query() { + public function is_main_query() { global $wp_the_query; return $wp_the_query === $this; } + /** + * Set up global post data. + * + * @since 4.1.0 + * @since 4.4.0 Added the ability to pass a post ID to `$post`. + * + * @global int $id + * @global WP_User $authordata + * @global string|int|bool $currentday + * @global string|int|bool $currentmonth + * @global int $page + * @global array $pages + * @global int $multipage + * @global int $more + * @global int $numpages + * + * @param WP_Post|object|int $post WP_Post instance or Post ID/object. + * @return true True when finished. + */ + public function setup_postdata( $post ) { + global $id, $authordata, $currentday, $currentmonth, $page, $pages, $multipage, $more, $numpages; + + if ( ! ( $post instanceof WP_Post ) ) { + $post = get_post( $post ); + } + + if ( ! $post ) { + return; + } + + $id = (int) $post->ID; + + $authordata = get_userdata($post->post_author); + + $currentday = mysql2date('d.m.y', $post->post_date, false); + $currentmonth = mysql2date('m', $post->post_date, false); + $numpages = 1; + $multipage = 0; + $page = $this->get( 'page' ); + if ( ! $page ) + $page = 1; + + /* + * Force full post content when viewing the permalink for the $post, + * or when on an RSS feed. Otherwise respect the 'more' tag. + */ + if ( $post->ID === get_queried_object_id() && ( $this->is_page() || $this->is_single() ) ) { + $more = 1; + } elseif ( $this->is_feed() ) { + $more = 1; + } else { + $more = 0; + } + + $content = $post->post_content; + if ( false !== strpos( $content, '' ) ) { + $content = str_replace( "\n\n", '', $content ); + $content = str_replace( "\n", '', $content ); + $content = str_replace( "\n", '', $content ); + + // Ignore nextpage at the beginning of the content. + if ( 0 === strpos( $content, '' ) ) + $content = substr( $content, 15 ); + + $pages = explode('', $content); + } else { + $pages = array( $post->post_content ); + } + + /** + * Filters the "pages" derived from splitting the post content. + * + * "Pages" are determined by splitting the post content based on the presence + * of `` tags. + * + * @since 4.4.0 + * + * @param array $pages Array of "pages" derived from the post content. + * of `` tags.. + * @param WP_Post $post Current post object. + */ + $pages = apply_filters( 'content_pagination', $pages, $post ); + + $numpages = count( $pages ); + + if ( $numpages > 1 ) { + if ( $page > 1 ) { + $more = 1; + } + $multipage = 1; + } else { + $multipage = 0; + } + + /** + * Fires once the post data has been setup. + * + * @since 2.8.0 + * @since 4.1.0 Introduced `$this` parameter. + * + * @param WP_Post &$post The Post object (passed by reference). + * @param WP_Query &$this The current Query object (passed by reference). + */ + do_action_ref_array( 'the_post', array( &$post, &$this ) ); + + return true; + } /** * After looping through a nested query, this function * restores the $post global to the current post in this query. * * @since 3.7.0 * - * @return bool + * @global WP_Post $post */ - function reset_postdata() { + public function reset_postdata() { if ( ! empty( $this->post ) ) { $GLOBALS['post'] = $this->post; - setup_postdata( $this->post ); + $this->setup_postdata( $this->post ); } } + + /** + * Lazyload term meta for posts in the loop. + * + * @since 4.4.0 + * @deprecated 4.5.0 See wp_queue_posts_for_term_meta_lazyload(). + * + * @param mixed $check + * @param int $term_id + * @return mixed + */ + public function lazyload_term_meta( $check, $term_id ) { + _deprecated_function( __METHOD__, '4.5.0' ); + return $check; + } + + /** + * Lazyload comment meta for comments in the loop. + * + * @since 4.4.0 + * @deprecated 4.5.0 See wp_queue_comments_for_comment_meta_lazyload(). + * + * @param mixed $check + * @param int $comment_id + * @return mixed + */ + public function lazyload_comment_meta( $check, $comment_id ) { + _deprecated_function( __METHOD__, '4.5.0' ); + return $check; + } } /** @@ -3860,28 +4926,31 @@ class WP_Query { * Attempts to find the current slug from the past slugs. * * @since 2.1.0 - * @uses $wp_query - * @uses $wpdb * - * @return null If no link is found, null is returned. + * @global WP_Query $wp_query Global WP_Query instance. + * @global wpdb $wpdb WordPress database abstraction object. */ function wp_old_slug_redirect() { global $wp_query; - if ( is_404() && '' != $wp_query->query_vars['name'] ) : + + if ( is_404() && '' !== $wp_query->query_vars['name'] ) : global $wpdb; // Guess the current post_type based on the query vars. - if ( get_query_var('post_type') ) - $post_type = get_query_var('post_type'); - elseif ( !empty($wp_query->query_vars['pagename']) ) + if ( get_query_var( 'post_type' ) ) { + $post_type = get_query_var( 'post_type' ); + } elseif ( get_query_var( 'attachment' ) ) { + $post_type = 'attachment'; + } elseif ( ! empty( $wp_query->query_vars['pagename'] ) ) { $post_type = 'page'; - else + } else { $post_type = 'post'; + } if ( is_array( $post_type ) ) { if ( count( $post_type ) > 1 ) return; - $post_type = array_shift( $post_type ); + $post_type = reset( $post_type ); } // Do not attempt redirect for hierarchical post types @@ -3904,10 +4973,26 @@ function wp_old_slug_redirect() { if ( ! $id ) return; - $link = get_permalink($id); + $link = get_permalink( $id ); + + if ( isset( $GLOBALS['wp_query']->query_vars['paged'] ) && $GLOBALS['wp_query']->query_vars['paged'] > 1 ) { + $link = user_trailingslashit( trailingslashit( $link ) . 'page/' . $GLOBALS['wp_query']->query_vars['paged'] ); + } elseif( is_embed() ) { + $link = user_trailingslashit( trailingslashit( $link ) . 'embed' ); + } + + /** + * Filters the old slug redirect URL. + * + * @since 4.4.0 + * + * @param string $link The redirect URL. + */ + $link = apply_filters( 'old_slug_redirect_url', $link ); - if ( !$link ) + if ( ! $link ) { return; + } wp_redirect( $link, 301 ); // Permanent redirect exit; @@ -3918,46 +5003,19 @@ function wp_old_slug_redirect() { * Set up global post data. * * @since 1.5.0 + * @since 4.4.0 Added the ability to pass a post ID to `$post`. * - * @param object $post Post data. - * @uses do_action_ref_array() Calls 'the_post' + * @global WP_Query $wp_query Global WP_Query instance. + * + * @param WP_Post|object|int $post WP_Post instance or Post ID/object. * @return bool True when finished. */ function setup_postdata( $post ) { - global $id, $authordata, $currentday, $currentmonth, $page, $pages, $multipage, $more, $numpages; - - $id = (int) $post->ID; - - $authordata = get_userdata($post->post_author); + global $wp_query; - $currentday = mysql2date('d.m.y', $post->post_date, false); - $currentmonth = mysql2date('m', $post->post_date, false); - $numpages = 1; - $multipage = 0; - $page = get_query_var('page'); - if ( ! $page ) - $page = 1; - if ( is_single() || is_page() || is_feed() ) - $more = 1; - $content = $post->post_content; - if ( false !== strpos( $content, '' ) ) { - if ( $page > 1 ) - $more = 1; - $content = str_replace( "\n\n", '', $content ); - $content = str_replace( "\n", '', $content ); - $content = str_replace( "\n", '', $content ); - // Ignore nextpage at the beginning of the content. - if ( 0 === strpos( $content, '' ) ) - $content = substr( $content, 15 ); - $pages = explode('', $content); - $numpages = count($pages); - if ( $numpages > 1 ) - $multipage = 1; - } else { - $pages = array( $post->post_content ); + if ( ! empty( $wp_query ) && $wp_query instanceof WP_Query ) { + return $wp_query->setup_postdata( $post ); } - do_action_ref_array('the_post', array(&$post)); - - return true; + return false; }