X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/af50974463450c98503e763a7836a50e260461a9..0459461f9ea42e0b090759ff6fe5f48360bef750:/wp-includes/query.php
diff --git a/wp-includes/query.php b/wp-includes/query.php
index cfb1e772..b4aae270 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,29 +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.
+ *
+ * @global WP_Query $wp_query Global WP_Query instance.
*
* @param string $var The variable key to retrieve.
- * @param mixed $default Value to return if the query variable is not set. Default ''.
- * @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( $var, $default = '' ) {
global $wp_query;
-
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;
@@ -44,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;
@@ -61,18 +64,16 @@ 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 );
}
/**
@@ -82,7 +83,8 @@ function set_query_var($var, $value) {
* once. This must not be used within the WordPress Loop.
*
* @since 1.5.0
- * @uses $wp_query
+ *
+ * @global WP_Query $wp_query Global WP_Query instance.
*
* @param string $query
* @return array List of posts
@@ -100,7 +102,9 @@ function query_posts($query) {
* 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'];
@@ -112,7 +116,8 @@ 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;
@@ -131,9 +136,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
*/
@@ -151,11 +156,11 @@ 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 = '' ) {
@@ -172,9 +177,9 @@ 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
@@ -196,9 +201,9 @@ function is_attachment( $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
@@ -220,9 +225,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
@@ -244,9 +249,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
@@ -272,12 +277,12 @@ 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 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.
+ * @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
*/
function is_tax( $taxonomy = '', $term = '' ) {
@@ -294,9 +299,9 @@ function 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
+ *
+ * @global WP_Query $wp_query Global WP_Query instance.
*
* @return bool
*/
@@ -314,9 +319,9 @@ function 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
*/
@@ -334,9 +339,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
*/
@@ -354,9 +359,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
@@ -375,9 +380,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
*/
@@ -404,9 +409,10 @@ function is_comment_feed() {
*
* Otherwise the same as @see is_home()
*
- * @see WP_Query::is_front_page()
* @since 2.5.0
*
+ * @global WP_Query $wp_query Global WP_Query instance.
+ *
* @return bool True, if front of site.
*/
function is_front_page() {
@@ -432,9 +438,9 @@ function is_front_page() {
*
* @see is_front_page()
*
- * @see WP_Query::is_home()
* @since 1.5.0
- * @uses $wp_query
+ *
+ * @global WP_Query $wp_query Global WP_Query instance.
*
* @return bool True if blog view homepage.
*/
@@ -452,9 +458,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
*/
@@ -478,12 +484,12 @@ 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;
@@ -499,9 +505,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
*/
@@ -519,9 +525,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
*/
@@ -539,9 +545,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
*/
@@ -559,9 +565,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
*/
@@ -587,12 +593,12 @@ 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;
@@ -614,12 +620,12 @@ 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;
@@ -635,9 +641,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
*/
@@ -655,9 +661,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
*/
@@ -675,9 +681,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
*/
@@ -695,9 +701,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
*/
@@ -712,17 +718,45 @@ function is_404() {
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' );
+ 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' ) );
+ $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' );
}
@@ -737,15 +771,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();
}
@@ -753,41 +786,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();
}
@@ -798,9 +827,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
*/
@@ -812,9 +841,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
*/
@@ -830,7 +859,7 @@ 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
*/
@@ -1191,6 +1220,15 @@ class WP_Query {
*/
public $is_404 = false;
+ /**
+ * Set if query is embed.
+ *
+ * @since 4.4.0
+ * @access public
+ * @var bool
+ */
+ public $is_embed = false;
+
/**
* Set if query is within comments popup window.
*
@@ -1271,6 +1309,7 @@ class WP_Query {
*
* @since 3.1.0
* @access private
+ * @var bool|string
*/
private $query_vars_hash = false;
@@ -1292,6 +1331,24 @@ class WP_Query {
*/
public $thumbnails_cached = false;
+ /**
+ * Whether the term meta cache for matched posts has been primed.
+ *
+ * @since 4.4.0
+ * @access protected
+ * @var bool
+ */
+ public $updated_term_meta_cache = false;
+
+ /**
+ * Whether the comment meta cache for matched posts has been primed.
+ *
+ * @since 4.4.0
+ * @access protected
+ * @var bool
+ */
+ public $updated_comment_meta_cache = false;
+
/**
* Cached list of search stopwords.
*
@@ -1300,6 +1357,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.
*
@@ -1421,6 +1482,7 @@ class WP_Query {
, 'preview'
, 's'
, 'sentence'
+ , 'title'
, 'fields'
, 'menu_order'
);
@@ -1430,7 +1492,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' );
@@ -1445,6 +1507,10 @@ 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.
* @access public
*
* @param string|array $query {
@@ -1472,7 +1538,7 @@ class WP_Query {
* 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 bool $ignore_sticky_posts Whether to ignore sticky posts or not. Setting this to false
+ * @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
@@ -1492,11 +1558,14 @@ class WP_Query {
* @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 $orderby Sort retrieved posts by parameter. One or more options can be
+ * @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. Default 'date'.
- * Accepts 'none', 'name', 'author', 'date', 'title', 'modified',
- * 'menu_order', 'parent', 'ID', 'rand', 'comment_count'.
+ * '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',
+ * 'comment_count', 'meta_value', 'meta_value_num', 'post__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.
@@ -1518,9 +1587,11 @@ class WP_Query {
* @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 string $s Search keyword.
+ * @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 array $search_terms Array of search terms.
* @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).
@@ -1533,6 +1604,7 @@ class WP_Query {
* 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 int $w The week number of the year. Default empty. Accepts numbers 0-53.
@@ -1566,6 +1638,7 @@ class WP_Query {
$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']);
@@ -1654,9 +1727,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;
@@ -1738,7 +1811,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_comments_popup || $this->is_robots ) )
$this->is_home = true;
// Correct is_* for page_on_front and page_for_posts
@@ -1760,11 +1833,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;
@@ -1804,6 +1891,8 @@ class WP_Query {
if ( '404' == $qv['error'] )
$this->set_404();
+ $this->is_embed = isset( $qv['embed'] ) && ( $this->is_singular || $this->is_404 );
+
$this->query_vars_hash = md5( serialize( $this->query_vars ) );
$this->query_vars_changed = false;
@@ -1827,7 +1916,7 @@ class WP_Query {
*
* @param array &$q The query variables
*/
- 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 {
@@ -1858,6 +1947,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 ) {
@@ -1873,6 +1966,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();
@@ -1948,6 +2046,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 ) {
@@ -1956,7 +2059,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');
@@ -2038,7 +2141,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.
*/
@@ -2072,13 +2176,24 @@ class WP_Query {
$searchand = '';
$q['search_orderby_title'] = array();
foreach ( $q['search_terms'] as $term ) {
- if ( $n ) {
+ // 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 );
+ }
+
+ 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 %s) OR ($wpdb->posts.post_content LIKE %s))", $like, $like );
+ $search .= $wpdb->prepare( "{$searchand}(($wpdb->posts.post_title $like_op %s) $andor_op ($wpdb->posts.post_content $like_op %s))", $like, $like );
$searchand = ' AND ';
}
@@ -2148,7 +2263,7 @@ 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;
@@ -2168,7 +2283,8 @@ 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.
*/
@@ -2177,11 +2293,19 @@ class WP_Query {
if ( $q['search_terms_count'] > 1 ) {
$num_terms = count( $q['search_orderby_title'] );
- $like = '%' . $wpdb->esc_like( $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 .= $wpdb->prepare( "WHEN $wpdb->posts.post_title LIKE %s THEN 1 ", $like );
+ 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)
@@ -2194,8 +2318,13 @@ class WP_Query {
}
// sentence match in 'post_content'
- $search_orderby .= $wpdb->prepare( "WHEN $wpdb->posts.post_content LIKE %s THEN 4 ", $like );
- $search_orderby .= 'ELSE 5 END)';
+ if ( $like ) {
+ $search_orderby .= $wpdb->prepare( "WHEN $wpdb->posts.post_content LIKE %s THEN 4 ", $like );
+ }
+
+ if ( $search_orderby ) {
+ $search_orderby = '(CASE ' . $search_orderby . 'ELSE 5 END)';
+ }
} else {
// single word or sentence search
$search_orderby = reset( $q['search_orderby_title'] ) . ' DESC';
@@ -2214,7 +2343,7 @@ class WP_Query {
* @global wpdb $wpdb WordPress database abstraction object.
*
* @param string $orderby Alias for the field to order by.
- * @return string|bool Table-prefixed value to used in the ORDER clause. False otherwise.
+ * @return string|false Table-prefixed value to used in the ORDER clause. False otherwise.
*/
protected function parse_orderby( $orderby ) {
global $wpdb;
@@ -2228,8 +2357,9 @@ class WP_Query {
$primary_meta_key = '';
$primary_meta_query = false;
- if ( ! empty( $this->meta_query->queries ) ) {
- $primary_meta_query = reset( $this->meta_query->queries );
+ $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'];
@@ -2238,9 +2368,10 @@ class WP_Query {
$allowed_keys[] = 'meta_value';
$allowed_keys[] = 'meta_value_num';
+ $allowed_keys = array_merge( $allowed_keys, array_keys( $meta_clauses ) );
}
- if ( ! in_array( $orderby, $allowed_keys ) ) {
+ if ( ! in_array( $orderby, $allowed_keys, true ) ) {
return false;
}
@@ -2255,29 +2386,36 @@ class WP_Query {
case 'ID':
case 'menu_order':
case 'comment_count':
- $orderby = "$wpdb->posts.{$orderby}";
+ $orderby_clause = "$wpdb->posts.{$orderby}";
break;
case 'rand':
- $orderby = 'RAND()';
+ $orderby_clause = 'RAND()';
break;
case $primary_meta_key:
case 'meta_value':
if ( ! empty( $primary_meta_query['type'] ) ) {
- $sql_type = $this->meta_query->get_cast_for_type( $primary_meta_query['type'] );
- $orderby = "CAST($wpdb->postmeta.meta_value AS {$sql_type})";
+ $orderby_clause = "CAST({$primary_meta_query['alias']}.meta_value AS {$primary_meta_query['cast']})";
} else {
- $orderby = "$wpdb->postmeta.meta_value";
+ $orderby_clause = "{$primary_meta_query['alias']}.meta_value";
}
break;
case 'meta_value_num':
- $orderby = "$wpdb->postmeta.meta_value+0";
+ $orderby_clause = "{$primary_meta_query['alias']}.meta_value+0";
break;
default:
- $orderby = "$wpdb->posts.post_" . $orderby;
+ 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']})";
+ } else {
+ // Default: order by post field.
+ $orderby_clause = "$wpdb->posts.post_" . sanitize_key( $orderby );
+ }
+
break;
}
- return $orderby;
+ return $orderby_clause;
}
/**
@@ -2320,11 +2458,13 @@ 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.
- * @param mixed $default Value to return if the query variable is not set. Default ''.
- * @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.
*/
public function get( $query_var, $default = '' ) {
if ( isset( $this->query_vars[ $query_var ] ) ) {
@@ -2341,7 +2481,7 @@ class WP_Query {
* @access public
*
* @param string $query_var Query variable key.
- * @param mixed $value Query variable value.
+ * @param mixed $value Query variable value.
*/
public function set($query_var, $value) {
$this->query_vars[$query_var] = $value;
@@ -2356,6 +2496,8 @@ class WP_Query {
* @since 1.5.0
* @access public
*
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
* @return array List of posts.
*/
public function get_posts() {
@@ -2467,7 +2609,7 @@ class WP_Query {
$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 )
@@ -2578,6 +2720,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'] . "'";
@@ -2622,9 +2769,11 @@ 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'] );
+ $where .= " AND $wpdb->posts.post_name IN ('" . implode( "' ,'", $q['post_name__in'] ) . "')";
}
-
if ( intval($q['comments_popup']) )
$q['p'] = absint($q['comments_popup']);
@@ -2808,6 +2957,12 @@ class WP_Query {
$where .= $search . $whichauthor . $whichmimetype;
+ 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';
@@ -2943,6 +3098,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'];
@@ -3025,12 +3181,6 @@ 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.
@@ -3063,11 +3213,12 @@ class WP_Query {
if ( !$page )
$page = 1;
- if ( empty($q['offset']) ) {
- $pgstrt = absint( ( $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'];
}
@@ -3138,7 +3289,9 @@ class WP_Query {
$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();
@@ -3406,10 +3559,11 @@ class WP_Query {
if ( 'ids' == $q['fields'] ) {
$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 );
- return array_map( 'intval', $this->posts );
+ return $this->posts;
}
if ( 'id=>parent' == $q['fields'] ) {
@@ -3418,9 +3572,13 @@ class WP_Query {
$this->set_found_posts( $q, $limits );
$r = array();
- foreach ( $this->posts as $post ) {
+ 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;
}
@@ -3473,6 +3631,11 @@ class WP_Query {
if ( $this->posts )
$this->posts = array_map( 'get_post', $this->posts );
+
+ if ( $q['update_post_term_cache'] ) {
+ add_filter( 'get_term_metadata', array( $this, 'lazyload_term_meta' ), 10, 2 );
+ }
+
if ( ! $q['suppress_filters'] ) {
/**
* Filter the raw post results array, prior to status checks.
@@ -3504,16 +3667,26 @@ class WP_Query {
$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();
@@ -3590,6 +3763,11 @@ class WP_Query {
}
}
+ // If comments have been fetched as part of the query, make sure comment meta lazy-loading is set up.
+ if ( ! empty( $this->comments ) ) {
+ add_filter( 'get_comment_metadata', array( $this, 'lazyload_comment_meta' ), 10, 2 );
+ }
+
if ( ! $q['suppress_filters'] ) {
/**
* Filter the array of retrieved posts after they've been fetched and
@@ -3628,6 +3806,8 @@ class WP_Query {
*
* @since 3.5.0
* @access private
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
*/
private function set_found_posts( $q, $limits ) {
global $wpdb;
@@ -3689,6 +3869,8 @@ class WP_Query {
*
* @since 1.5.0
* @access public
+ *
+ * @global WP_Post $post
*/
public function the_post() {
global $post;
@@ -3752,12 +3934,12 @@ 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.
*/
public function next_comment() {
$this->current_comment++;
@@ -3771,7 +3953,7 @@ class WP_Query {
*
* @since 2.2.0
* @access public
- * @global object $comment Current comment.
+ * @global WP_Comment $comment Current comment.
*/
public function the_comment() {
global $comment;
@@ -3853,7 +4035,7 @@ class WP_Query {
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 ) {
@@ -3872,15 +4054,17 @@ class WP_Query {
// 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' );
- $queried_taxonomies = array_keys( $tax_query_in_and );
- $matched_taxonomy = reset( $queried_taxonomies );
- $query = $tax_query_in_and[ $matched_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 ( $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 );
+ }
}
}
}
@@ -3938,8 +4122,7 @@ 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.
*/
public function __construct($query = '') {
if ( ! empty($query) ) {
@@ -3957,11 +4140,13 @@ class WP_Query {
* @return mixed Property.
*/
public function __get( $name ) {
- return $this->$name;
+ if ( in_array( $name, $this->compat_fields ) ) {
+ return $this->$name;
+ }
}
/**
- * Make private properties settable for backwards compatibility.
+ * Make private properties checkable for backwards compatibility.
*
* @since 4.0.0
* @access public
@@ -3970,19 +4155,9 @@ class WP_Query {
* @return bool Whether the property is set.
*/
public function __isset( $name ) {
- return isset( $this->$name );
- }
-
- /**
- * Make private properties settable for backwards compatibility.
- *
- * @since 4.0.0
- * @access public
- *
- * @param string $name Property to unset.
- */
- public function __unset( $name ) {
- unset( $this->$name );
+ if ( in_array( $name, $this->compat_fields ) ) {
+ return isset( $this->$name );
+ }
}
/**
@@ -3993,10 +4168,13 @@ class WP_Query {
*
* @param callable $name Method to call.
* @param array $arguments Arguments to pass when calling.
- * @return mixed|bool Return value of the callback, otherwise false.
+ * @return mixed|false Return value of the callback, false otherwise.
*/
public function __call( $name, $arguments ) {
- return call_user_func_array( array( $this, $name ), $arguments );
+ if ( in_array( $name, $this->compat_methods ) ) {
+ return call_user_func_array( array( $this, $name ), $arguments );
+ }
+ return false;
}
/**
@@ -4053,7 +4231,7 @@ class WP_Query {
$post_obj = $this->get_queried_object();
- if ( in_array( $post_obj->ID, $attachment ) ) {
+ if ( in_array( (string) $post_obj->ID, $attachment ) ) {
return true;
} elseif ( in_array( $post_obj->post_title, $attachment ) ) {
return true;
@@ -4085,7 +4263,7 @@ class WP_Query {
$author = (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;
@@ -4117,7 +4295,7 @@ class WP_Query {
$category = (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;
@@ -4149,7 +4327,7 @@ class WP_Query {
$tag = (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;
@@ -4171,8 +4349,10 @@ 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.
+ * @param mixed $term Optional. Term ID, name, slug or array of Term IDs, names, and slugs.
* @return bool
*/
public function is_tax( $taxonomy = '', $term = '' ) {
@@ -4332,8 +4512,8 @@ class WP_Query {
*
* @since 3.1.0
*
- * @param mixed $page Page ID, title, slug, path, 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.
*/
public function is_page( $page = '' ) {
if ( !$this->is_page )
@@ -4346,11 +4526,11 @@ class WP_Query {
$page = (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 ) ) {
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 ) {
@@ -4425,8 +4605,8 @@ class WP_Query {
*
* @since 3.1.0
*
- * @param mixed $post Post ID, title, slug, path, 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.
*/
public function is_single( $post = '' ) {
if ( !$this->is_single )
@@ -4439,7 +4619,7 @@ class WP_Query {
$post = (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 ) ) {
return true;
@@ -4471,8 +4651,8 @@ 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.
*/
public function is_singular( $post_types = '' ) {
if ( empty( $post_types ) || !$this->is_singular )
@@ -4527,11 +4707,24 @@ class WP_Query {
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
*/
public function is_main_query() {
@@ -4543,13 +4736,32 @@ class WP_Query {
* Set up global post data.
*
* @since 4.1.0
- *
- * @param WP_Post $post Post data.
- * @return bool True when finished.
+ * @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);
@@ -4568,7 +4780,7 @@ class WP_Query {
*/
if ( $post->ID === get_queried_object_id() && ( $this->is_page() || $this->is_single() ) ) {
$more = 1;
- } else if ( $this->is_feed() ) {
+ } elseif ( $this->is_feed() ) {
$more = 1;
} else {
$more = 0;
@@ -4576,8 +4788,6 @@ class WP_Query {
$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 );
@@ -4587,13 +4797,35 @@ class WP_Query {
$content = substr( $content, 15 );
$pages = explode('', $content);
- $numpages = count($pages);
- if ( $numpages > 1 )
- $multipage = 1;
} else {
$pages = array( $post->post_content );
}
+ /**
+ * Filter 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.
*
@@ -4612,12 +4844,134 @@ class WP_Query {
* restores the $post global to the current post in this query.
*
* @since 3.7.0
+ *
+ * @global WP_Post $post
*/
public function reset_postdata() {
if ( ! empty( $this->post ) ) {
$GLOBALS['post'] = $this->post;
- setup_postdata( $this->post );
+ $this->setup_postdata( $this->post );
+ }
+ }
+
+ /**
+ * Lazy-loads termmeta for located posts.
+ *
+ * As a rule, term queries (`get_terms()` and `wp_get_object_terms()`) prime the metadata cache for matched
+ * terms by default. However, this can cause a slight performance penalty, especially when that metadata is
+ * not actually used. In the context of a `WP_Query` instance, we're able to avoid this potential penalty.
+ * `update_object_term_cache()`, called from `update_post_caches()`, does not 'update_term_meta_cache'.
+ * Instead, the first time `get_term_meta()` is called from within a `WP_Query` loop, the current method
+ * detects the fact, and then primes the metadata cache for all terms attached to all posts in the loop,
+ * with a single database query.
+ *
+ * This method is public so that it can be used as a filter callback. As a rule, there is no need to invoke it
+ * directly, from either inside or outside the `WP_Query` object.
+ *
+ * @since 4.4.0
+ * @access public
+ *
+ * @param mixed $check The `$check` param passed from the 'get_term_metadata' hook.
+ * @param int $term_id ID of the term whose metadata is being cached.
+ * @return mixed In order not to short-circuit `get_metadata()`. Generally, this is `null`, but it could be
+ * another value if filtered by a plugin.
+ */
+ public function lazyload_term_meta( $check, $term_id ) {
+ /*
+ * We only do this once per `WP_Query` instance.
+ * Can't use `remove_filter()` because of non-unique object hashes.
+ */
+ if ( $this->updated_term_meta_cache ) {
+ return $check;
+ }
+
+ // We can only lazyload if the entire post object is present.
+ $posts = array();
+ foreach ( $this->posts as $post ) {
+ if ( $post instanceof WP_Post ) {
+ $posts[] = $post;
+ }
+ }
+
+ if ( ! empty( $posts ) ) {
+ // Fetch cached term_ids for each post. Keyed by term_id for faster lookup.
+ $term_ids = array();
+ foreach ( $posts as $post ) {
+ $taxonomies = get_object_taxonomies( $post->post_type );
+ foreach ( $taxonomies as $taxonomy ) {
+ // Term cache should already be primed by 'update_post_term_cache'.
+ $terms = get_object_term_cache( $post->ID, $taxonomy );
+ if ( false !== $terms ) {
+ foreach ( $terms as $term ) {
+ if ( ! isset( $term_ids[ $term->term_id ] ) ) {
+ $term_ids[ $term->term_id ] = 1;
+ }
+ }
+ }
+ }
+ }
+
+ /*
+ * Only update the metadata cache for terms belonging to these posts if the term_id passed
+ * to `get_term_meta()` matches one of those terms. This prevents a single call to
+ * `get_term_meta()` from priming metadata for all `WP_Query` objects.
+ */
+ if ( isset( $term_ids[ $term_id ] ) ) {
+ update_termmeta_cache( array_keys( $term_ids ) );
+ $this->updated_term_meta_cache = true;
+ }
+ }
+
+ // If no terms were found, there's no need to run this again.
+ if ( empty( $term_ids ) ) {
+ $this->updated_term_meta_cache = true;
+ }
+
+ return $check;
+ }
+
+ /**
+ * Lazy-load comment meta when inside of a `WP_Query` loop.
+ *
+ * This method is public so that it can be used as a filter callback. As a rule, there is no need to invoke it
+ * directly, from either inside or outside the `WP_Query` object.
+ *
+ * @since 4.4.0
+ *
+ * @param mixed $check The `$check` param passed from the 'get_comment_metadata' hook.
+ * @param int $comment_id ID of the comment whose metadata is being cached.
+ * @return mixed The original value of `$check`, to not affect 'get_comment_metadata'.
+ */
+ public function lazyload_comment_meta( $check, $comment_id ) {
+ /*
+ * We only do this once per `WP_Query` instance.
+ * Can't use `remove_filter()` because of non-unique object hashes.
+ */
+ if ( $this->updated_comment_meta_cache ) {
+ return $check;
+ }
+
+ // Don't use `wp_list_pluck()` to avoid by-reference manipulation.
+ $comment_ids = array();
+ if ( is_array( $this->comments ) ) {
+ foreach ( $this->comments as $comment ) {
+ $comment_ids[] = $comment->comment_ID;
+ }
+ }
+
+ /*
+ * Only update the metadata cache for comments belonging to these posts if the comment_id passed
+ * to `get_comment_meta()` matches one of those comments. This prevents a single call to
+ * `get_comment_meta()` from priming metadata for all `WP_Query` objects.
+ */
+ if ( in_array( $comment_id, $comment_ids ) ) {
+ update_meta_cache( 'comment', $comment_ids );
+ $this->updated_comment_meta_cache = true;
+ } elseif ( empty( $comment_ids ) ) {
+ $this->updated_comment_meta_cache = true;
}
+
+ return $check;
}
}
@@ -4628,28 +4982,30 @@ class WP_Query {
*
* @since 2.1.0
*
- * @uses $wp_query
- * @global wpdb $wpdb WordPress database abstraction object.
- *
- * @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
@@ -4672,10 +5028,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' );
+ }
+
+ /**
+ * Filter 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;
@@ -4686,8 +5058,11 @@ 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`.
+ *
+ * @global WP_Query $wp_query Global WP_Query instance.
*
- * @param object $post Post data.
+ * @param WP_Post|object|int $post WP_Post instance or Post ID/object.
* @return bool True when finished.
*/
function setup_postdata( $post ) {