* 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
/**
* 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;
}
/**
- * 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;
/**
* 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 );
}
/**
* 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
* 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'];
* 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;
*
* 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
*/
/**
* 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 = '' ) {
/**
* 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 ) ) {
return false;
}
- return $wp_query->is_attachment();
+ return $wp_query->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
* 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
* 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
* 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.
+ * @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 = '' ) {
/**
* 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
*/
/**
* 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
*/
/**
* 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
*/
/**
* 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
/**
* 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
*/
*
* 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.
*/
*
* @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.
*/
/**
* 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
*/
* @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;
/**
* 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
*/
/**
* 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
*/
/**
* 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
*/
/**
* 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
*/
* @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;
* @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;
/**
* 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
*/
/**
* 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
*/
/**
* 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
*/
/**
* 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
*/
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 <code>%1$s</code>, use the <code>%2$s</code> method, not the <code>%3$s</code> 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.' ),
+ '<code>pre_get_posts</code>',
+ '<code>WP_Query->is_main_query()</code>',
+ '<code>is_main_query()</code>',
+ __( 'https://codex.wordpress.org/Function_Reference/is_main_query' )
+ );
_doing_it_wrong( __FUNCTION__, $message, '3.7' );
}
/**
* 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();
}
* 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();
}
/**
* 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
*/
/**
* 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
*/
/**
* 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
*/
* @access public
* @var array
*/
- var $query;
+ public $query;
/**
* Query vars, after parsing
* @access public
* @var array
*/
- var $query_vars = array();
+ public $query_vars = array();
/**
* Taxonomy query, as passed to get_tax_sql()
* @access public
* @var object WP_Tax_Query
*/
- var $tax_query;
+ public $tax_query;
/**
* Metadata query container
* @access public
* @var object WP_Meta_Query
*/
- var $meta_query = false;
+ public $meta_query = false;
/**
* Date query container
* @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.
* @access public
* @var object|array
*/
- var $queried_object;
+ public $queried_object;
/**
* The ID of the queried object.
* @access public
* @var int
*/
- var $queried_object_id;
+ public $queried_object_id;
/**
* Get post database query.
* @access public
* @var string
*/
- var $request;
+ public $request;
/**
* List of posts.
* @access public
* @var array
*/
- var $posts;
+ public $posts;
/**
* The amount of posts for the current query.
* @access public
* @var int
*/
- var $post_count = 0;
+ public $post_count = 0;
/**
* Index of the current item in the loop.
* @access public
* @var int
*/
- var $current_post = -1;
+ public $current_post = -1;
/**
* Whether the loop has started and the caller is in the loop.
* @access public
* @var bool
*/
- var $in_the_loop = false;
+ public $in_the_loop = false;
/**
* The current post.
* @access public
* @var WP_Post
*/
- var $post;
+ public $post;
/**
* The list of comments for current post.
* @access public
* @var array
*/
- var $comments;
+ public $comments;
/**
* The amount of comments for the posts.
* @access public
* @var int
*/
- var $comment_count = 0;
+ public $comment_count = 0;
/**
* The index of the comment in the comment loop.
* @access public
* @var int
*/
- var $current_comment = -1;
+ public $current_comment = -1;
/**
* Current comment ID.
* @access public
* @var int
*/
- var $comment;
+ public $comment;
/**
* The amount of found posts for the current query.
* @access public
* @var int
*/
- var $found_posts = 0;
+ public $found_posts = 0;
/**
* The amount of pages.
* @access public
* @var int
*/
- var $max_num_pages = 0;
+ public $max_num_pages = 0;
/**
* The amount of comment pages.
* @access public
* @var int
*/
- var $max_num_comment_pages = 0;
+ public $max_num_comment_pages = 0;
/**
* Set if query is single post.
* @access public
* @var bool
*/
- var $is_single = false;
+ public $is_single = false;
/**
* Set if query is preview of blog.
* @access public
* @var bool
*/
- var $is_preview = false;
+ public $is_preview = false;
/**
* Set if query returns a page.
* @access public
* @var bool
*/
- var $is_page = false;
+ public $is_page = false;
/**
* Set if query is an archive list.
* @access public
* @var bool
*/
- var $is_archive = false;
+ public $is_archive = false;
/**
* Set if query is part of a date.
* @access public
* @var bool
*/
- var $is_date = false;
+ public $is_date = false;
/**
* Set if query contains a year.
* @access public
* @var bool
*/
- var $is_year = false;
+ public $is_year = false;
/**
* Set if query contains a month.
* @access public
* @var bool
*/
- var $is_month = false;
+ public $is_month = false;
/**
* Set if query contains a day.
* @access public
* @var bool
*/
- var $is_day = false;
+ public $is_day = false;
/**
* Set if query contains time.
* @access public
* @var bool
*/
- var $is_time = false;
+ public $is_time = false;
/**
* Set if query contains an author.
* @access public
* @var bool
*/
- var $is_author = false;
+ public $is_author = false;
/**
* Set if query contains category.
* @access public
* @var bool
*/
- var $is_category = false;
+ public $is_category = false;
/**
* Set if query contains tag.
* @access public
* @var bool
*/
- var $is_tag = false;
+ public $is_tag = false;
/**
* Set if query contains taxonomy.
* @access public
* @var bool
*/
- var $is_tax = false;
+ public $is_tax = false;
/**
* Set if query was part of a search result.
* @access public
* @var bool
*/
- var $is_search = false;
+ public $is_search = false;
/**
* Set if query is feed display.
* @access public
* @var bool
*/
- var $is_feed = false;
+ public $is_feed = false;
/**
* Set if query is comment feed display.
* @access public
* @var bool
*/
- var $is_comment_feed = false;
+ public $is_comment_feed = false;
/**
* Set if query is trackback.
* @access public
* @var bool
*/
- var $is_trackback = false;
+ public $is_trackback = false;
/**
* Set if query is blog homepage.
* @access public
* @var bool
*/
- var $is_home = false;
+ public $is_home = false;
/**
* Set if query couldn't found anything.
* @access public
* @var bool
*/
- var $is_404 = false;
+ 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.
* @access public
* @var bool
*/
- var $is_comments_popup = false;
+ public $is_comments_popup = false;
/**
* Set if query is paged
* @access public
* @var bool
*/
- var $is_paged = false;
+ public $is_paged = false;
/**
* Set if query is part of administration page.
* @access public
* @var bool
*/
- var $is_admin = false;
+ public $is_admin = false;
/**
* Set if query is an attachment.
* @access public
* @var bool
*/
- var $is_attachment = false;
+ public $is_attachment = false;
/**
* Set if is single, is a page, or is an attachment.
* @access public
* @var bool
*/
- var $is_singular = false;
+ public $is_singular = false;
/**
* Set if query is for robots.
* @access public
* @var bool
*/
- var $is_robots = false;
+ public $is_robots = false;
/**
* Set if query contains posts.
* @access public
* @var bool
*/
- var $is_posts_page = false;
+ public $is_posts_page = false;
/**
* Set if query is for a post type archive.
* @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
*
* @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
* @since 3.1.1
* @access private
*/
- var $query_vars_changed = true;
+ private $query_vars_changed = true;
/**
* Set if post thumbnails are cached
* @access public
* @var bool
*/
- var $thumbnails_cached = false;
+ 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.
*/
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.
*
* @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;
* @since 1.5.0
* @access public
*/
- function init() {
+ public function init() {
unset($this->posts);
unset($this->query);
$this->query_vars = array();
* @since 1.5.0
* @access public
*/
- function parse_query_vars() {
+ public function parse_query_vars() {
$this->parse_query();
}
* @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'
, 'preview'
, 's'
, 'sentence'
+ , 'title'
, 'fields'
, 'menu_order'
);
$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' );
* 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 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 int $comments_per_page The number of comments to return per page.
+ * Default 'comments_per_page' option.
+ * @type int|string $comments_popup Whether the query is within the comments popup. Default empty.
+ * @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->queries}
+ * @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',
+ * '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.
+ * @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 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 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 );
$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'] )
$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;
}
$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;
$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;
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
}
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;
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;
- 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
*/
- 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 {
$term = $q[$t->query_var];
+ if ( is_array( $term ) ) {
+ $term = implode( ',', $term );
+ }
+
if ( strpos($term, '+') !== false ) {
$terms = preg_split( '/[+]+/', $term );
foreach ( $terms as $term ) {
}
}
+ // 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();
);
}
+ // 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 ) {
$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');
$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 );
}
*
* @since 3.7.0
*
- * @global wpdb $wpdb
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
* @param array $q Query variables.
* @return string WHERE clause.
*/
$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_content $like_op %s))", $like, $like );
$searchand = ' AND ';
}
*
* @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 ) {
'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;
/**
* 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)
}
// sentence match in 'post_content'
- $search_orderby .= "WHEN $wpdb->posts.post_content LIKE '%{$search_orderby_s}%' THEN 4 ";
- $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';
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 ( ! 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']})";
+ } 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();
* 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;
}
/**
* @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;
}
*
* @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;
$join = '';
$search = '';
$groupby = '';
- $fields = '';
$post_status_join = false;
$page = 1;
$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'];
$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 )
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'] = '';
}
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'] . "'";
$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']);
}
// If a search pattern is specified, load the posts that match.
- if ( ! empty( $q['s'] ) )
+ if ( ! empty( $q['s'] ) ) {
$search = $this->parse_search( $q );
+ }
/**
* Filter the search SQL that is used in the WHERE clause of 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 ) )
}
}
- // 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 );
}
}
- 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 );
}
}
$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 ) ) {
} elseif ( $q['orderby'] == 'post_parent__in' && ! empty( $post_parent__in ) ) {
$orderby = "FIELD( {$wpdb->posts}.post_parent, $post_parent__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.
$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 ( 'any' == $post_type ) {
$in_search_post_types = get_post_types( array('exclude_from_search' => false) );
if ( empty( $in_search_post_types ) )
$user_id = get_current_user_id();
+ $q_status = array();
if ( ! empty( $q['post_status'] ) ) {
$statuswheres = array();
$q_status = $q['post_status'];
$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 ) ) {
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'";
$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 ) );
+ /**
+ * Filter 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 ) );
+
+ /**
+ * Filter 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
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";
}
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 ) );
+ /**
+ * Filter 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 ) );
+
+ /**
+ * Filter 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 ) );
+
+ /**
+ * Filter 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 ) );
+
+ /**
+ * Filter 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 ) );
+
+ /**
+ * Filter 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();
$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
- $clauses = (array) apply_filters_ref_array( 'posts_clauses', array( compact( $pieces ), &$this ) );
- foreach ( $pieces as $piece )
- $$piece = isset( $clauses[ $piece ] ) ? $clauses[ $piece ] : '';
- }
-
- // Announce current selection parameters. For use by caching plugins.
- do_action( 'posts_selection', $where . $groupby . $orderby . $limits . $join );
+ /**
+ * Filter 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 ) );
- // Filter again for the benefit of caching plugins. Regular plugins should use the hooks above.
+ /**
+ * Filter 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 ) );
+
+ /**
+ * Filter 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 ) );
+
+ /**
+ * Filter 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 ) );
+
+ /**
+ * Filter 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 ) );
+
+ /**
+ * Filter 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 ) );
+
+ /**
+ * Filter 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 ) );
+
+ /**
+ * Filter 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 ) );
+
+ $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' ] : '';
+ }
+
+ /**
+ * 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.
+ */
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
+ /**
+ * Filter 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 ) );
+
+ /**
+ * Filter 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 ) );
+
+ /**
+ * Filter 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 ) );
+
+ /**
+ * Filter 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 ) );
+
+ /**
+ * Filter 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 ) );
+
+ /**
+ * Filter 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 ) );
+
+ /**
+ * Filter 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 ) );
+
+ /**
+ * Filter 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) )
$this->request = $old_request = "SELECT $found_rows $distinct $fields FROM $wpdb->posts $join WHERE 1=1 $where $groupby $orderby $limits";
if ( !$q['suppress_filters'] ) {
+ /**
+ * Filter the completed SQL query before sending.
+ *
+ * @since 2.0.0
+ *
+ * @param array $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 ) );
}
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 );
$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 );
+
+ /**
+ * Filter 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 );
if ( $split_the_query ) {
$this->request = "SELECT $found_rows $distinct $wpdb->posts.ID FROM $wpdb->posts $join WHERE 1=1 $where $groupby $orderby $limits";
+ /**
+ * Filter 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 );
$ids = $wpdb->get_col( $this->request );
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['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.
+ *
+ * @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();
}
}
- 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 ) ) {
+ /**
+ * Filter 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
}
}
- 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 ) ) {
+ 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
+ * 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.
*
* @since 3.5.0
* @access private
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
*/
- 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,
if ( $q['no_found_rows'] || ( is_array( $this->posts ) && ! $this->posts ) )
return;
- if ( ! empty( $limits ) )
+ if ( ! empty( $limits ) ) {
+ /**
+ * Filter 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 );
+ }
+ /**
+ * Filter 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 ) )
*
* @return WP_Post Next post.
*/
- function next_post() {
+ public function next_post() {
$this->current_post++;
*
* @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 );
}
/**
*
* @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();
}
* @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];
}
/**
- * 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];
*
* @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' );
}
}
*
* @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 ) {
* @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];
* @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();
*
* @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_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 ( $query['terms'] ) {
- 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 );
+ }
}
}
}
$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 ) {
*
* @return int
*/
- function get_queried_object_id() {
+ public function get_queried_object_id() {
$this->get_queried_object();
if ( isset($this->queried_object_id) ) {
* @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 backwards 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 backwards 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 backwards 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?
*
*
* @return bool
*/
- function is_archive() {
+ public function is_archive() {
return (bool) $this->is_archive;
}
* @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;
*
* @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) $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;
}
/**
* @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;
$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;
* @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;
$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;
* @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;
$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;
*
* @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
*/
- function is_tax( $taxonomy = '', $term = '' ) {
+ public function is_tax( $taxonomy = '', $term = '' ) {
global $wp_taxonomies;
if ( !$this->is_tax )
*
* @return bool
*/
- function is_comments_popup() {
+ public function is_comments_popup() {
return (bool) $this->is_comments_popup;
}
*
* @return bool
*/
- function is_date() {
+ public function is_date() {
return (bool) $this->is_date;
}
*
* @return bool
*/
- function is_day() {
+ public function is_day() {
return (bool) $this->is_day;
}
* @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' );
*
* @return bool
*/
- function is_comment_feed() {
+ public function is_comment_feed() {
return (bool) $this->is_comment_feed;
}
* 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;
*
* @return bool True if blog view homepage.
*/
- function is_home() {
+ public function is_home() {
return (bool) $this->is_home;
}
*
* @return bool
*/
- function is_month() {
+ public function is_month() {
return (bool) $this->is_month;
}
*
* @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;
$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 ) )
+ } 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;
}
*
* @return bool
*/
- function is_paged() {
+ public function is_paged() {
return (bool) $this->is_paged;
}
*
* @return bool
*/
- function is_preview() {
+ public function is_preview() {
return (bool) $this->is_preview;
}
*
* @return bool
*/
- function is_robots() {
+ public function is_robots() {
return (bool) $this->is_robots;
}
*
* @return bool
*/
- function is_search() {
+ public function is_search() {
return (bool) $this->is_search;
}
*
* @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;
$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 ) )
+ } 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;
}
*
* @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;
*
* @return bool
*/
- function is_time() {
+ public function is_time() {
return (bool) $this->is_time;
}
*
* @return bool
*/
- function is_trackback() {
+ public function is_trackback() {
return (bool) $this->is_trackback;
}
*
* @return bool
*/
- function is_year() {
+ public function is_year() {
return (bool) $this->is_year;
}
*
* @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, '<!--nextpage-->' ) ) {
+ $content = str_replace( "\n<!--nextpage-->\n", '<!--nextpage-->', $content );
+ $content = str_replace( "\n<!--nextpage-->", '<!--nextpage-->', $content );
+ $content = str_replace( "<!--nextpage-->\n", '<!--nextpage-->', $content );
+
+ // Ignore nextpage at the beginning of the content.
+ if ( 0 === strpos( $content, '<!--nextpage-->' ) )
+ $content = substr( $content, 15 );
+
+ $pages = explode('<!--nextpage-->', $content);
+ } 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 `<!-- nextpage -->` tags.
+ *
+ * @since 4.4.0
+ *
+ * @param array $pages Array of "pages" derived from the post content.
+ * of `<!-- nextpage -->` 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 );
+ }
+ }
+
+ /**
+ * 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;
}
}
* 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
if ( ! $id )
return;
- $link = get_permalink($id);
+ $link = get_permalink( $id );
- if ( !$link )
+ 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 ) {
return;
+ }
wp_redirect( $link, 301 ); // Permanent redirect
exit;
* 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.
- * @uses do_action_ref_array() Calls 'the_post'
+ * @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, '<!--nextpage-->' ) ) {
- if ( $page > 1 )
- $more = 1;
- $content = str_replace( "\n<!--nextpage-->\n", '<!--nextpage-->', $content );
- $content = str_replace( "\n<!--nextpage-->", '<!--nextpage-->', $content );
- $content = str_replace( "<!--nextpage-->\n", '<!--nextpage-->', $content );
- // Ignore nextpage at the beginning of the content.
- if ( 0 === strpos( $content, '<!--nextpage-->' ) )
- $content = substr( $content, 15 );
- $pages = explode('<!--nextpage-->', $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;
}
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff