/wp-includes/query.php
PHP | 4465 lines | 2198 code | 516 blank | 1751 comment | 590 complexity | 57871cbb97832ae71aee613bb7e7460b MD5 | raw file
Possible License(s): GPL-2.0, AGPL-1.0, LGPL-2.1
Large files files are truncated, but you can click here to view the full file
- <?php
- /**
- * WordPress Query API
- *
- * 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.
- *
- * @package WordPress
- * @subpackage Query
- */
- /**
- * Retrieve variable in the WP_Query class.
- *
- * @see WP_Query::get()
- * @since 1.5.0
- * @uses $wp_query
- *
- * @param string $var The variable key to retrieve.
- * @param mixed $default Value to return if the query variable is not set. Default ''.
- * @return mixed
- */
- function get_query_var( $var, $default = '' ) {
- global $wp_query;
- return $wp_query->get( $var, $default );
- }
- /**
- * Retrieve the currently-queried object. Wrapper for $wp_query->get_queried_object()
- *
- * @uses WP_Query::get_queried_object
- *
- * @since 3.1.0
- * @access public
- *
- * @return object
- */
- function get_queried_object() {
- global $wp_query;
- return $wp_query->get_queried_object();
- }
- /**
- * Retrieve ID of the current queried object. Wrapper for $wp_query->get_queried_object_id()
- *
- * @uses WP_Query::get_queried_object_id()
- *
- * @since 3.1.0
- * @access public
- *
- * @return int
- */
- function get_queried_object_id() {
- global $wp_query;
- return $wp_query->get_queried_object_id();
- }
- /**
- * Set query variable.
- *
- * @see WP_Query::set()
- * @since 2.2.0
- * @uses $wp_query
- *
- * @param string $var Query variable key.
- * @param mixed $value
- * @return null
- */
- function set_query_var($var, $value) {
- global $wp_query;
- return $wp_query->set($var, $value);
- }
- /**
- * Set up The Loop with query parameters.
- *
- * This will override the current WordPress Loop and shouldn't be used more than
- * once. This must not be used within the WordPress Loop.
- *
- * @since 1.5.0
- * @uses $wp_query
- *
- * @param string $query
- * @return array List of posts
- */
- function query_posts($query) {
- $GLOBALS['wp_query'] = new WP_Query();
- return $GLOBALS['wp_query']->query($query);
- }
- /**
- * Destroy the previous query and set up a new query.
- *
- * This should be used after {@link query_posts()} and before another {@link
- * query_posts()}. This will remove obscure bugs that occur when the previous
- * wp_query object is not destroyed properly before another is set up.
- *
- * @since 2.3.0
- * @uses $wp_query
- */
- function wp_reset_query() {
- $GLOBALS['wp_query'] = $GLOBALS['wp_the_query'];
- wp_reset_postdata();
- }
- /**
- * After looping through a separate query, this function restores
- * the $post global to the current post in the main query.
- *
- * @since 3.0.0
- * @uses $wp_query
- */
- function wp_reset_postdata() {
- global $wp_query;
- if ( isset( $wp_query ) ) {
- $wp_query->reset_postdata();
- }
- }
- /*
- * Query type checks.
- */
- /**
- * Is the query for an existing archive page?
- *
- * Month, Year, Category, Author, Post Type archive...
- *
- * @see WP_Query::is_archive()
- * @since 1.5.0
- * @uses $wp_query
- *
- * @return bool
- */
- function is_archive() {
- global $wp_query;
- if ( ! isset( $wp_query ) ) {
- _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1' );
- return false;
- }
- return $wp_query->is_archive();
- }
- /**
- * Is the query for an existing post type archive page?
- *
- * @see WP_Query::is_post_type_archive()
- * @since 3.1.0
- * @uses $wp_query
- *
- * @param mixed $post_types Optional. Post type or array of posts types to check against.
- * @return bool
- */
- function is_post_type_archive( $post_types = '' ) {
- global $wp_query;
- if ( ! isset( $wp_query ) ) {
- _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1' );
- return false;
- }
- return $wp_query->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
- *
- * @param mixed $attachment Attachment ID, title, slug, or array of such.
- * @return bool
- */
- function is_attachment( $attachment = '' ) {
- global $wp_query;
- if ( ! isset( $wp_query ) ) {
- _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1' );
- return false;
- }
- return $wp_query->is_attachment( $attachment );
- }
- /**
- * Is the query for an existing author archive page?
- *
- * 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
- *
- * @param mixed $author Optional. User ID, nickname, nicename, or array of User IDs, nicknames, and nicenames
- * @return bool
- */
- function is_author( $author = '' ) {
- global $wp_query;
- if ( ! isset( $wp_query ) ) {
- _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1' );
- return false;
- }
- return $wp_query->is_author( $author );
- }
- /**
- * Is the query for an existing category archive page?
- *
- * 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
- *
- * @param mixed $category Optional. Category ID, name, slug, or array of Category IDs, names, and slugs.
- * @return bool
- */
- function is_category( $category = '' ) {
- global $wp_query;
- if ( ! isset( $wp_query ) ) {
- _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1' );
- return false;
- }
- return $wp_query->is_category( $category );
- }
- /**
- * Is the query for an existing tag archive page?
- *
- * 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
- *
- * @param mixed $tag Optional. Tag ID, name, slug, or array of Tag IDs, names, and slugs.
- * @return bool
- */
- function is_tag( $tag = '' ) {
- global $wp_query;
- if ( ! isset( $wp_query ) ) {
- _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1' );
- return false;
- }
- return $wp_query->is_tag( $tag );
- }
- /**
- * Is the query for an existing taxonomy archive page?
- *
- * If the $taxonomy parameter is specified, this function will additionally
- * check if the query is for that specific $taxonomy.
- *
- * If the $term parameter is specified in addition to the $taxonomy parameter,
- * this function will additionally check if the query is for one of the terms
- * specified.
- *
- * @see WP_Query::is_tax()
- * @since 2.5.0
- * @uses $wp_query
- *
- * @param mixed $taxonomy Optional. Taxonomy slug or slugs.
- * @param mixed $term Optional. Term ID, name, slug or array of Term IDs, names, and slugs.
- * @return bool
- */
- function is_tax( $taxonomy = '', $term = '' ) {
- global $wp_query;
- if ( ! isset( $wp_query ) ) {
- _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1' );
- return false;
- }
- return $wp_query->is_tax( $taxonomy, $term );
- }
- /**
- * Whether the current URL is within the comments popup window.
- *
- * @see WP_Query::is_comments_popup()
- * @since 1.5.0
- * @uses $wp_query
- *
- * @return bool
- */
- function is_comments_popup() {
- global $wp_query;
- if ( ! isset( $wp_query ) ) {
- _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1' );
- return false;
- }
- return $wp_query->is_comments_popup();
- }
- /**
- * Is the query for an existing date archive?
- *
- * @see WP_Query::is_date()
- * @since 1.5.0
- * @uses $wp_query
- *
- * @return bool
- */
- function is_date() {
- global $wp_query;
- if ( ! isset( $wp_query ) ) {
- _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1' );
- return false;
- }
- return $wp_query->is_date();
- }
- /**
- * Is the query for an existing day archive?
- *
- * @see WP_Query::is_day()
- * @since 1.5.0
- * @uses $wp_query
- *
- * @return bool
- */
- function is_day() {
- global $wp_query;
- if ( ! isset( $wp_query ) ) {
- _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1' );
- return false;
- }
- return $wp_query->is_day();
- }
- /**
- * Is the query for a feed?
- *
- * @see WP_Query::is_feed()
- * @since 1.5.0
- * @uses $wp_query
- *
- * @param string|array $feeds Optional feed types to check.
- * @return bool
- */
- function is_feed( $feeds = '' ) {
- global $wp_query;
- if ( ! isset( $wp_query ) ) {
- _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1' );
- return false;
- }
- return $wp_query->is_feed( $feeds );
- }
- /**
- * Is the query for a comments feed?
- *
- * @see WP_Query::is_comments_feed()
- * @since 3.0.0
- * @uses $wp_query
- *
- * @return bool
- */
- function is_comment_feed() {
- global $wp_query;
- if ( ! isset( $wp_query ) ) {
- _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1' );
- return false;
- }
- return $wp_query->is_comment_feed();
- }
- /**
- * Is the query for the front page of the site?
- *
- * This is for what is displayed at your site's main URL.
- *
- * Depends on the site's "Front page displays" Reading Settings 'show_on_front' and 'page_on_front'.
- *
- * If you set a static page for the front page of your site, this function will return
- * true when viewing that page.
- *
- * Otherwise the same as @see is_home()
- *
- * @see WP_Query::is_front_page()
- * @since 2.5.0
- * @uses is_home()
- * @uses get_option()
- *
- * @return bool True, if front of site.
- */
- function is_front_page() {
- global $wp_query;
- if ( ! isset( $wp_query ) ) {
- _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1' );
- return false;
- }
- return $wp_query->is_front_page();
- }
- /**
- * Is the query for the blog homepage?
- *
- * This is the page which shows the time based blog content of your site.
- *
- * Depends on the site's "Front page displays" Reading Settings 'show_on_front' and 'page_for_posts'.
- *
- * If you set a static page for the front page of your site, this function will return
- * true only on the page you set as the "Posts page".
- *
- * @see is_front_page()
- *
- * @see WP_Query::is_home()
- * @since 1.5.0
- * @uses $wp_query
- *
- * @return bool True if blog view homepage.
- */
- function is_home() {
- global $wp_query;
- if ( ! isset( $wp_query ) ) {
- _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1' );
- return false;
- }
- return $wp_query->is_home();
- }
- /**
- * Is the query for an existing month archive?
- *
- * @see WP_Query::is_month()
- * @since 1.5.0
- * @uses $wp_query
- *
- * @return bool
- */
- function is_month() {
- global $wp_query;
- if ( ! isset( $wp_query ) ) {
- _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1' );
- return false;
- }
- return $wp_query->is_month();
- }
- /**
- * Is the query for an existing single page?
- *
- * If the $page parameter is specified, this function will additionally
- * check if the query is for one of the pages specified.
- *
- * @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
- */
- function is_page( $page = '' ) {
- global $wp_query;
- if ( ! isset( $wp_query ) ) {
- _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1' );
- return false;
- }
- return $wp_query->is_page( $page );
- }
- /**
- * Is the query for paged result and not for the first page?
- *
- * @see WP_Query::is_paged()
- * @since 1.5.0
- * @uses $wp_query
- *
- * @return bool
- */
- function is_paged() {
- global $wp_query;
- if ( ! isset( $wp_query ) ) {
- _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1' );
- return false;
- }
- return $wp_query->is_paged();
- }
- /**
- * Is the query for a post or page preview?
- *
- * @see WP_Query::is_preview()
- * @since 2.0.0
- * @uses $wp_query
- *
- * @return bool
- */
- function is_preview() {
- global $wp_query;
- if ( ! isset( $wp_query ) ) {
- _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1' );
- return false;
- }
- return $wp_query->is_preview();
- }
- /**
- * Is the query for the robots file?
- *
- * @see WP_Query::is_robots()
- * @since 2.1.0
- * @uses $wp_query
- *
- * @return bool
- */
- function is_robots() {
- global $wp_query;
- if ( ! isset( $wp_query ) ) {
- _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1' );
- return false;
- }
- return $wp_query->is_robots();
- }
- /**
- * Is the query for a search?
- *
- * @see WP_Query::is_search()
- * @since 1.5.0
- * @uses $wp_query
- *
- * @return bool
- */
- function is_search() {
- global $wp_query;
- if ( ! isset( $wp_query ) ) {
- _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1' );
- return false;
- }
- return $wp_query->is_search();
- }
- /**
- * Is the query for an existing single post?
- *
- * Works for any post type, except attachments and pages
- *
- * If the $post parameter is specified, this function will additionally
- * check if the query is for one of the Posts specified.
- *
- * @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
- */
- function is_single( $post = '' ) {
- global $wp_query;
- if ( ! isset( $wp_query ) ) {
- _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1' );
- return false;
- }
- return $wp_query->is_single( $post );
- }
- /**
- * Is the query for an existing single post of any post type (post, attachment, page, ... )?
- *
- * If the $post_types parameter is specified, this function will additionally
- * check if the query is for one of the Posts Types specified.
- *
- * @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
- */
- function is_singular( $post_types = '' ) {
- global $wp_query;
- if ( ! isset( $wp_query ) ) {
- _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1' );
- return false;
- }
- return $wp_query->is_singular( $post_types );
- }
- /**
- * Is the query for a specific time?
- *
- * @see WP_Query::is_time()
- * @since 1.5.0
- * @uses $wp_query
- *
- * @return bool
- */
- function is_time() {
- global $wp_query;
- if ( ! isset( $wp_query ) ) {
- _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1' );
- return false;
- }
- return $wp_query->is_time();
- }
- /**
- * Is the query for a trackback endpoint call?
- *
- * @see WP_Query::is_trackback()
- * @since 1.5.0
- * @uses $wp_query
- *
- * @return bool
- */
- function is_trackback() {
- global $wp_query;
- if ( ! isset( $wp_query ) ) {
- _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1' );
- return false;
- }
- return $wp_query->is_trackback();
- }
- /**
- * Is the query for an existing year archive?
- *
- * @see WP_Query::is_year()
- * @since 1.5.0
- * @uses $wp_query
- *
- * @return bool
- */
- function is_year() {
- global $wp_query;
- if ( ! isset( $wp_query ) ) {
- _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1' );
- return false;
- }
- return $wp_query->is_year();
- }
- /**
- * Is the query a 404 (returns no results)?
- *
- * @see WP_Query::is_404()
- * @since 1.5.0
- * @uses $wp_query
- *
- * @return bool
- */
- function is_404() {
- global $wp_query;
- if ( ! isset( $wp_query ) ) {
- _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1' );
- return false;
- }
- return $wp_query->is_404();
- }
- /**
- * Is the query the main query?
- *
- * @since 3.3.0
- *
- * @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' ) );
- _doing_it_wrong( __FUNCTION__, $message, '3.7' );
- }
- global $wp_query;
- return $wp_query->is_main_query();
- }
- /*
- * The Loop. Post loop control.
- */
- /**
- * Whether current WordPress query has results to loop over.
- *
- * @see WP_Query::have_posts()
- * @since 1.5.0
- * @uses $wp_query
- *
- * @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
- *
- * @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
- */
- function rewind_posts() {
- global $wp_query;
- return $wp_query->rewind_posts();
- }
- /**
- * Iterate the post index in the loop.
- *
- * @see WP_Query::the_post()
- * @since 1.5.0
- * @uses $wp_query
- */
- function the_post() {
- global $wp_query;
- $wp_query->the_post();
- }
- /*
- * Comments loop.
- */
- /**
- * Whether there are comments to loop over.
- *
- * @see WP_Query::have_comments()
- * @since 2.2.0
- * @uses $wp_query
- *
- * @return bool
- */
- function have_comments() {
- global $wp_query;
- return $wp_query->have_comments();
- }
- /**
- * Iterate comment index in the comment loop.
- *
- * @see WP_Query::the_comment()
- * @since 2.2.0
- * @uses $wp_query
- *
- * @return object
- */
- function the_comment() {
- global $wp_query;
- return $wp_query->the_comment();
- }
- /*
- * WP_Query
- */
- /**
- * The WordPress Query class.
- *
- * @link http://codex.wordpress.org/Function_Reference/WP_Query Codex page.
- *
- * @since 1.5.0
- */
- class WP_Query {
- /**
- * Query vars set by the user
- *
- * @since 1.5.0
- * @access public
- * @var array
- */
- public $query;
- /**
- * Query vars, after parsing
- *
- * @since 1.5.0
- * @access public
- * @var array
- */
- public $query_vars = array();
- /**
- * Taxonomy query, as passed to get_tax_sql()
- *
- * @since 3.1.0
- * @access public
- * @var object WP_Tax_Query
- */
- public $tax_query;
- /**
- * Metadata query container
- *
- * @since 3.2.0
- * @access public
- * @var object WP_Meta_Query
- */
- public $meta_query = false;
- /**
- * Date query container
- *
- * @since 3.7.0
- * @access public
- * @var object WP_Date_Query
- */
- public $date_query = false;
- /**
- * Holds the data for a single object that is queried.
- *
- * Holds the contents of a post, page, category, attachment.
- *
- * @since 1.5.0
- * @access public
- * @var object|array
- */
- public $queried_object;
- /**
- * The ID of the queried object.
- *
- * @since 1.5.0
- * @access public
- * @var int
- */
- public $queried_object_id;
- /**
- * Get post database query.
- *
- * @since 2.0.1
- * @access public
- * @var string
- */
- public $request;
- /**
- * List of posts.
- *
- * @since 1.5.0
- * @access public
- * @var array
- */
- public $posts;
- /**
- * The amount of posts for the current query.
- *
- * @since 1.5.0
- * @access public
- * @var int
- */
- public $post_count = 0;
- /**
- * Index of the current item in the loop.
- *
- * @since 1.5.0
- * @access public
- * @var int
- */
- public $current_post = -1;
- /**
- * Whether the loop has started and the caller is in the loop.
- *
- * @since 2.0.0
- * @access public
- * @var bool
- */
- public $in_the_loop = false;
- /**
- * The current post.
- *
- * @since 1.5.0
- * @access public
- * @var WP_Post
- */
- public $post;
- /**
- * The list of comments for current post.
- *
- * @since 2.2.0
- * @access public
- * @var array
- */
- public $comments;
- /**
- * The amount of comments for the posts.
- *
- * @since 2.2.0
- * @access public
- * @var int
- */
- public $comment_count = 0;
- /**
- * The index of the comment in the comment loop.
- *
- * @since 2.2.0
- * @access public
- * @var int
- */
- public $current_comment = -1;
- /**
- * Current comment ID.
- *
- * @since 2.2.0
- * @access public
- * @var int
- */
- public $comment;
- /**
- * The amount of found posts for the current query.
- *
- * If limit clause was not used, equals $post_count.
- *
- * @since 2.1.0
- * @access public
- * @var int
- */
- public $found_posts = 0;
- /**
- * The amount of pages.
- *
- * @since 2.1.0
- * @access public
- * @var int
- */
- public $max_num_pages = 0;
- /**
- * The amount of comment pages.
- *
- * @since 2.7.0
- * @access public
- * @var int
- */
- public $max_num_comment_pages = 0;
- /**
- * Set if query is single post.
- *
- * @since 1.5.0
- * @access public
- * @var bool
- */
- public $is_single = false;
- /**
- * Set if query is preview of blog.
- *
- * @since 2.0.0
- * @access public
- * @var bool
- */
- public $is_preview = false;
- /**
- * Set if query returns a page.
- *
- * @since 1.5.0
- * @access public
- * @var bool
- */
- public $is_page = false;
- /**
- * Set if query is an archive list.
- *
- * @since 1.5.0
- * @access public
- * @var bool
- */
- public $is_archive = false;
- /**
- * Set if query is part of a date.
- *
- * @since 1.5.0
- * @access public
- * @var bool
- */
- public $is_date = false;
- /**
- * Set if query contains a year.
- *
- * @since 1.5.0
- * @access public
- * @var bool
- */
- public $is_year = false;
- /**
- * Set if query contains a month.
- *
- * @since 1.5.0
- * @access public
- * @var bool
- */
- public $is_month = false;
- /**
- * Set if query contains a day.
- *
- * @since 1.5.0
- * @access public
- * @var bool
- */
- public $is_day = false;
- /**
- * Set if query contains time.
- *
- * @since 1.5.0
- * @access public
- * @var bool
- */
- public $is_time = false;
- /**
- * Set if query contains an author.
- *
- * @since 1.5.0
- * @access public
- * @var bool
- */
- public $is_author = false;
- /**
- * Set if query contains category.
- *
- * @since 1.5.0
- * @access public
- * @var bool
- */
- public $is_category = false;
- /**
- * Set if query contains tag.
- *
- * @since 2.3.0
- * @access public
- * @var bool
- */
- public $is_tag = false;
- /**
- * Set if query contains taxonomy.
- *
- * @since 2.5.0
- * @access public
- * @var bool
- */
- public $is_tax = false;
- /**
- * Set if query was part of a search result.
- *
- * @since 1.5.0
- * @access public
- * @var bool
- */
- public $is_search = false;
- /**
- * Set if query is feed display.
- *
- * @since 1.5.0
- * @access public
- * @var bool
- */
- public $is_feed = false;
- /**
- * Set if query is comment feed display.
- *
- * @since 2.2.0
- * @access public
- * @var bool
- */
- public $is_comment_feed = false;
- /**
- * Set if query is trackback.
- *
- * @since 1.5.0
- * @access public
- * @var bool
- */
- public $is_trackback = false;
- /**
- * Set if query is blog homepage.
- *
- * @since 1.5.0
- * @access public
- * @var bool
- */
- public $is_home = false;
- /**
- * Set if query couldn't found anything.
- *
- * @since 1.5.0
- * @access public
- * @var bool
- */
- public $is_404 = false;
- /**
- * Set if query is within comments popup window.
- *
- * @since 1.5.0
- * @access public
- * @var bool
- */
- public $is_comments_popup = false;
- /**
- * Set if query is paged
- *
- * @since 1.5.0
- * @access public
- * @var bool
- */
- public $is_paged = false;
- /**
- * Set if query is part of administration page.
- *
- * @since 1.5.0
- * @access public
- * @var bool
- */
- public $is_admin = false;
- /**
- * Set if query is an attachment.
- *
- * @since 2.0.0
- * @access public
- * @var bool
- */
- public $is_attachment = false;
- /**
- * Set if is single, is a page, or is an attachment.
- *
- * @since 2.1.0
- * @access public
- * @var bool
- */
- public $is_singular = false;
- /**
- * Set if query is for robots.
- *
- * @since 2.1.0
- * @access public
- * @var bool
- */
- public $is_robots = false;
- /**
- * Set if query contains posts.
- *
- * Basically, the homepage if the option isn't set for the static homepage.
- *
- * @since 2.1.0
- * @access public
- * @var bool
- */
- public $is_posts_page = false;
- /**
- * Set if query is for a post type archive.
- *
- * @since 3.1.0
- * @access public
- * @var bool
- */
- public $is_post_type_archive = false;
- /**
- * Stores the ->query_vars state like md5(serialize( $this->query_vars ) ) so we know
- * whether we have to re-parse because something has changed
- *
- * @since 3.1.0
- * @access private
- */
- private $query_vars_hash = false;
- /**
- * Whether query vars have changed since the initial parse_query() call. Used to catch modifications to query vars made
- * via pre_get_posts hooks.
- *
- * @since 3.1.1
- * @access private
- */
- private $query_vars_changed = true;
- /**
- * Set if post thumbnails are cached
- *
- * @since 3.2.0
- * @access public
- * @var bool
- */
- public $thumbnails_cached = false;
- /**
- * Cached list of search stopwords.
- *
- * @since 3.7.0
- * @var array
- */
- private $stopwords;
- /**
- * Resets query flags to false.
- *
- * The query flags are what page info WordPress was able to figure out.
- *
- * @since 2.0.0
- * @access private
- */
- private function init_query_flags() {
- $this->is_single = false;
- $this->is_preview = false;
- $this->is_page = false;
- $this->is_archive = false;
- $this->is_date = false;
- $this->is_year = false;
- $this->is_month = false;
- $this->is_day = false;
- $this->is_time = false;
- $this->is_author = false;
- $this->is_category = false;
- $this->is_tag = false;
- $this->is_tax = false;
- $this->is_search = false;
- $this->is_feed = false;
- $this->is_comment_feed = false;
- $this->is_trackback = false;
- $this->is_home = false;
- $this->is_404 = false;
- $this->is_comments_popup = false;
- $this->is_paged = false;
- $this->is_admin = false;
- $this->is_attachment = false;
- $this->is_singular = false;
- $this->is_robots = false;
- $this->is_posts_page = false;
- $this->is_post_type_archive = false;
- }
- /**
- * Initiates object properties and sets default values.
- *
- * @since 1.5.0
- * @access public
- */
- public function init() {
- unset($this->posts);
- unset($this->query);
- $this->query_vars = array();
- unset($this->queried_object);
- unset($this->queried_object_id);
- $this->post_count = 0;
- $this->current_post = -1;
- $this->in_the_loop = false;
- unset( $this->request );
- unset( $this->post );
- unset( $this->comments );
- unset( $this->comment );
- $this->comment_count = 0;
- $this->current_comment = -1;
- $this->found_posts = 0;
- $this->max_num_pages = 0;
- $this->max_num_comment_pages = 0;
- $this->init_query_flags();
- }
- /**
- * Reparse the query vars.
- *
- * @since 1.5.0
- * @access public
- */
- public function parse_query_vars() {
- $this->parse_query();
- }
- /**
- * Fills in the query variables, which do not exist within the parameter.
- *
- * @since 2.1.0
- * @access public
- *
- * @param array $array Defined query variables.
- * @return array Complete query variables with undefined ones filled in empty.
- */
- public function fill_query_vars($array) {
- $keys = array(
- 'error'
- , 'm'
- , 'p'
- , 'post_parent'
- , 'subpost'
- , 'subpost_id'
- , 'attachment'
- , 'attachment_id'
- , 'name'
- , 'static'
- , 'pagename'
- , 'page_id'
- , 'second'
- , 'minute'
- , 'hour'
- , 'day'
- , 'monthnum'
- , 'year'
- , 'w'
- , 'category_name'
- , 'tag'
- , 'cat'
- , 'tag_id'
- , 'author'
- , 'author_name'
- , 'feed'
- , 'tb'
- , 'paged'
- , 'comments_popup'
- , 'meta_key'
- , 'meta_value'
- , 'preview'
- , 's'
- , 'sentence'
- , 'fields'
- , 'menu_order'
- );
- foreach ( $keys as $key ) {
- if ( !isset($array[$key]) )
- $array[$key] = '';
- }
- $array_keys = array( 'category__in', 'category__not_in', 'category__and', 'post__in', 'post__not_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' );
- foreach ( $array_keys as $key ) {
- if ( !isset($array[$key]) )
- $array[$key] = array();
- }
- return $array;
- }
- /**
- * Parse a query string and set query type booleans.
- *
- * @since 1.5.0
- * @access public
- *
- * @param string|array $query Optional query.
- */
- public function parse_query( $query = '' ) {
- if ( ! empty( $query ) ) {
- $this->init();
- $this->query = $this->query_vars = wp_parse_args( $query );
- } elseif ( ! isset( $this->query ) ) {
- $this->query = $this->query_vars;
- }
- $this->query_vars = $this->fill_query_vars($this->query_vars);
- $qv = &$this->query_vars;
- $this->query_vars_changed = true;
- if ( ! empty($qv['robots']) )
- $this->is_robots = true;
- $qv['p'] = absint($qv['p']);
- $qv['page_id'] = absint($qv['page_id']);
- $qv['year'] = absint($qv['year']);
- $qv['monthnum'] = absint($qv['monthnum']);
- $qv['day'] = absint($qv['day']);
- $qv['w'] = absint($qv['w']);
- $qv['m'] = preg_replace( '|[^0-9]|', '', $qv['m'] );
- $qv['paged'] = absint($qv['paged']);
- $qv['cat'] = preg_replace( '|[^0-9,-]|', '', $qv['cat'] ); // comma separated list of positive or negative integers
- $qv['author'] = preg_replace( '|[^0-9,-]|', '', $qv['author'] ); // comma separated list of positive or negative integers
- $qv['pagename'] = trim( $qv['pagename'] );
- $qv['name'] = trim( $qv['name'] );
- 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 )
- $qv['s'] = '';
- // Compat. Map subpost to attachment.
- if ( '' != $qv['subpost'] )
- $qv['attachment'] = $qv['subpost'];
- if ( '' != $qv['subpost_id'] )
- $qv['attachment_id'] = $qv['subpost_id'];
- $qv['attachment_id'] = absint($qv['attachment_id']);
- if ( ('' != $qv['attachment']) || !empty($qv['attachment_id']) ) {
- $this->is_single = true;
- $this->is_attachment = true;
- } elseif ( '' != $qv['name'] ) {
- $this->is_single = true;
- } elseif ( $qv['p'] ) {
- $this->is_single = true;
- } elseif ( ('' !== $qv['hour']) && ('' !== $qv['minute']) &&('' !== $qv['second']) && ('' != $qv['year']) && ('' != $qv['monthnum']) && ('' != $qv['day']) ) {
- // If year, month, day, hour, minute, and second are set, a single
- // post is being queried.
- $this->is_single = true;
- } elseif ( '' != $qv['static'] || '' != $qv['pagename'] || !empty($qv['page_id']) ) {
- $this->is_page = true;
- $this->is_single = false;
- } else {
- // Look for archive queries. Dates, categories, authors, search, post type archives.
- if ( isset( $this->query['s'] ) ) {
- $this->is_search = true;
- }
- if ( '' !== $qv['second'] ) {
- $this->is_time = true;
- $this->is_date = true;
- }
- if ( '' !== $qv['minute'] ) {
- $this->is_time = true;
- $this->is_date = true;
- }
- if ( '' !== $qv['hour'] ) {
- $this->is_time = true;
- $this->is_date = true;
- }
- if ( $qv['day'] ) {
- if ( ! $this->is_date ) {
- $date = sprintf( '%04d-%02d-%02d', $qv['year'], $qv['monthnum'], $qv['day'] );
- if ( $qv['monthnum'] && $qv['year'] && ! wp_checkdate( $qv['monthnum'], $qv['day'], $qv['year'], $date ) ) {
- $qv['error'] = '404';
- } else {
- $this->is_day = true;
- $this->is_date = true;
- }
- }
- }
- if ( $qv['monthnum'] ) {
- if ( ! $this->is_date ) {
- if ( 12 < $qv['monthnum'] ) {
- $qv['error'] = '404';
- } else {
- $this->is_month = true;
- $this->is_date = true;
- }
- }
- }
- if ( $qv['year'] ) {
- if ( ! $this->is_date ) {
- $this->is_year = true;
- $this->is_date = true;
- }
- }
- if ( $qv['m'] ) {
- $this->is_date = true;
- if ( strlen($qv['m']) > 9 ) {
- $this->is_time = true;
- } else if ( strlen($qv['m']) > 7 ) {
- $this->is_day = true;
- } else if ( strlen($qv['m']) > 5 ) {
- $this->is_month = true;
- } else {
- $this->is_year = true;
- }
- }
- if ( '' != $qv['w'] ) {
- $this->is_date = true;
- }
- $this->query_vars_hash = false;
- $this->parse_tax_query( $qv );
- foreach ( $this->tax_query->queries as $tax_query ) {
- if ( 'NOT IN' != $tax_query['operator'] ) {
- switch ( $tax_query['taxonomy'] ) {
- case 'category':
- $this->is_category = true;
- break;
- case 'post_tag':
- $this->is_tag = true;
- break;
- default:
- $this->is_tax = true;
- }
- }
- }
- unset( $tax_query );
- if ( empty($qv['author']) || ($qv['author'] == '0') ) {
- $this->is_author = false;
- } else {
- $this->is_author = true;
- }
- if ( '' != $qv['author_name'] )
- $this->is_author = true;
- if ( !empty( $qv['post_type'] ) && ! is_array( $qv['post_type'] ) ) {
- $post_type_obj = get_post_type_object( $qv['post_type'] );
- if ( ! empty( $post_type_obj->has_archive ) )
- $this->is_post_type_archive = true;
- }
- if ( $this->is_post_type_archive || $this->is_date || $this->is_author || $this->is_category || $this->is_tag || $this->is_tax )
- $this->is_archive = true;
- }
- if ( '' != $qv['feed'] )
- $this->is_feed = true;
- if ( '' != $qv['tb'] )
- $this->is_trackback = true;
- if ( '' != $qv['paged'] && ( intval($qv['paged']) > 1 ) )
- $this->is_paged = true;
- if ( '' != $qv['comments_popup'] )
- $this->is_comments_popup = true;
- // if we're previewing inside the write screen
- if ( '' != $qv['preview'] )
- $this->is_preview = true;
- if ( is_admin() )
- $this->is_admin = true;
- if ( false !== strpos($qv['feed'], 'comments-') ) {
- $qv['feed'] = str_replace('comments-', '', $qv['feed']);
- $qv['withcomments'] = 1;
- }
- $this->is_singular = $this->is_single || $this->is_page || $this->is_attachment;
- 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 ) )
- $this->is_home = true;
- // Correct is_* for page_on_front and page_for_posts
- if ( $this->is_home && 'page' == get_option('show_on_front') && get_option('page_on_front') ) {
- $_query = wp_parse_args($this->query);
- // pagename can be set and empty depending on matched rewrite rules. Ignore an empty pagename.
- if ( isset($_query['pagename']) && '' == $_query['pagename'] )
- unset($_query['pagename']);
- if ( empty($_query) || !array_diff( array_keys($_query), array('preview', 'page', 'paged', 'cpage') ) ) {
- $this->is_page = true;
- $this->is_home = false;
- $qv['page_id'] = get_option('page_on_front');
- // Correct <!--nextpage--> for page_on_front
- if ( !empty($qv['paged']) ) {
- $qv['page'] = $qv['paged'];
- unset($qv['paged']);
- }
- }
- }
- if ( '' != $qv['pagename'] ) {
- $this->queried_object = get_page_by_path($qv['pagename']);
- if ( !empty($this->queried_object) )
- $this->queried_object_id = (int) $this->queried_object->ID;
- 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;
- $this->is_home = true;
- $this->is_posts_page = true;
- }
- }
- if ( $qv['page_id'] ) {
- if ( 'page' == get_option('show_on_front') && $qv['page_id'] == get_option('page_for_posts') ) {
- $this->is_page = false;
- $this->is_home = true;
- $this->is_posts_page = true;
- }
- }
- if ( !empty($qv['post_type']) ) {
- if ( is_array($qv['post_type']) )
- $qv['post_type'] = array_map('sanitize_key', $qv['post_type']);
- else
- $qv['post_type'] = sanitize_key($qv['post_type']);
- }
- if ( ! empty( $qv['post_status'] ) ) {
- if ( is_array( $qv['post_status'] ) )
- $qv['post_status'] = array_map('sanitize_key', $qv['post_status']);
- else
- $qv['post_status'] = preg_replace('|[^a-z0-9_,-]|', '', $qv['post_status']);
- }
- if ( $this->is_posts_page && ( ! isset($qv['withcomments']) || ! $qv['withcomments'] ) )
- $this->is_comment_feed = false;
- $this->is_singular = $this->is_single || $this->is_page || $this->is_attachment;
- // Done correcting is_* for page_on_front and page_for_posts
- if ( '404' == $qv['error'] )
- $this->set_404();
- $this->query_vars_hash = md5( serialize( $this->query_vars ) );
- $this->query_vars_changed = false;
- /**
- * 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.
- *
- * @access protected
- * @since 3.1.0
- *
- * @param array &$q The query variables
- */
- protected function parse_tax_query( &$q ) {
- if ( ! empty( $q['tax_query'] ) && is_array( $q['tax_query'] ) ) {
- $tax_query = $q['tax_query'];
- } else {
- $tax_query = array();
- }
- if ( !empty($q['taxonomy']) && !empty($q['term']) ) {
- $tax_query[] = array(
- 'taxonomy' => $q['taxonomy'],
- 'terms' => array( $q['term'] ),
- 'field' => 'slug',
- );
- }
- foreach ( get_taxonomies( array() , 'objects' ) as $taxonomy => $t ) {
- if ( 'post_tag' == $taxonomy )
- continue; // Handled further down in the $q['tag'] block
- if ( $t->query_var && !empty( $q[$t->query_var] ) ) {
- $tax_query_defaults = array(
- 'taxonomy' => $taxonomy,
- 'field' => 'slug',
- );
- if ( isset( $t->rewrite['hierarchical'] ) && $t->rewrite['hierarchical'] ) {
- $q[$t->query_var] = wp_basename( $q[$t->query_var] );
- }
- $term = $q[$t->query_var];
- if ( strpos($term, '+') !== false ) {
- $terms = preg_split( '/[+]+/', $term );
- foreach ( $terms as $term ) {
- $tax_query[] = array_merge( $tax_query_defaults, array(
- 'terms' => array( $term )
- ) );
- }
- } else {
- $tax_query[] = array_merge( $tax_query_defaults, array(
- 'terms' => preg_split( '/[,]+/', $term )
- ) );
- }
- }
- }
- // Category stuff
- if ( ! empty( $q['cat'] ) && ! $this->is_singular ) {
- $cat_in = $cat_not_in = array();
- $cat_array = preg_split( '/[,\s]+/', urldecode( $q['cat'] ) );
- $cat_array = array_map( 'intval', $cat_array );
- $q['cat'] = implode( ',', $cat_array );
- foreach ( $cat_array as $cat ) {
- if ( $cat > 0 )
- $cat_in[] = $cat;
- elseif ( $cat < 0 )
- $cat_not_in[] = abs( $cat );
- }
- if ( ! empty( $cat_in ) ) {
- $tax_query[] = array(
- 'taxonomy' => 'category',
- 'terms' => $cat_in,
- 'field' => 'term_id',
- 'include_children' => true
- );
- }
- if ( ! empty( $cat_not_in ) ) {
- $tax_query[] = array(
- 'taxonomy' => 'category',
- 'terms' => $cat_not_in,
- 'field' => 'term_id',
- 'operator' => 'NOT IN',
- 'include_children' => true
- );
- }
- unset( $cat_array, $cat_in, $cat_not_in );
- }
- if ( ! empty( $q['category__and'] ) && 1 === count( (array) $q['category__and'] ) ) {
- $q['category__and'] = (array) $q['category__and'];
- if ( ! isset( $q['category__in'] ) )
- $q['category__in'] = array();
- $q['category__in'][] = absint( reset( $q['category__and'] ) );
- unset( $q['category__and'] );
- }
- if ( ! empty( $q['category__in'] ) ) {
- $q['category__in'] = array_map( 'absint', array_unique( (array) $q['category__in'] ) );
- $tax_query[] = array(
- 'taxonomy' => 'category',
- 'terms' => $q['category__in'],
- 'field' => 'term_id',
- 'include_children' => false
- );
- } elseif ( isset( $this->query['category__in'] ) ) {
- $q['category__in'] = false;
- }
- if ( ! empty($q['category__not_in']) ) {
- $q['category__not_in'] = array_map( 'absint', array_unique( (array) $q['category__not_in'] ) );
- $tax_query[] = array(
- 'taxonomy' => 'category',
- 'terms' => $q['category__not_in'],
- 'operator' => 'NOT IN',
- 'include_children' => false
- );
- }
- if ( ! empty($q['category__and']) ) {
- $q['category__and'] = array_map( 'absint', array_unique( (array) $q['category__and'] ) );
- $tax_query[] = array(
- 'taxonomy' => 'category',
- 'terms' => $q['category__and'],
- 'field' => 'term_id',
- 'operator' => 'AND',
- 'include_children' => false
- );
- }
- // Tag stuff
- if ( '' != $q['tag'] && !$this->is_singular && $this->query_vars_changed ) {
- if ( strpos($q['tag'], ',') !== false ) {
- $tags = preg_split('/[,\r\n\t ]+/', $q['tag']);
- foreach ( (array) $tags as $tag ) {
- $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']) ) {
- $tags = preg_split('/[+\r\n\t ]+/', $q['tag']);
- foreach ( (array) $tags as $tag ) {
- $tag = sanitize_term_field('slug', $tag, 0, 'post_tag', 'db');
- $q['tag_slug__and'][] = $tag;
- }
- } else {
- $q['tag'] = sanitize_term_field('slug', $q['tag'], 0, 'post_tag', 'db');
- $q['tag_slug__in'][] = $q['tag'];
- }
- }
- if ( !empty($q['tag_id']) ) {
- $q['tag_id'] = absint( $q['tag_id'] );
- $tax_query[] = array(
- 'taxonomy' => 'post_tag',
- 'terms' => $q['tag_id']
- );
- }
- if ( !empty($q['tag__in']) ) {
- $q['tag__in'] = array_map('absint', array_unique( (array) $q['tag__in'] ) );
- $tax_query[] = array(
- 'taxonomy' => 'post_tag',
- 'terms' => $q['tag__in']
- );
- } elseif ( isset( $this->query['tag__in'] ) ) {
- $q['tag__in'] = false;
- }
- if ( !empty($q['tag__not_in']) ) {
- $q['tag__not_in'] = array_map('absint', array_unique( (array) $q['tag__not_in'] ) );
- $tax_query[] = array(
- 'taxonomy' => 'post_tag',
- 'terms' => $q['tag__not_in'],
- 'operator' => 'NOT IN'
- );
- }
- if ( !empty($q['tag__and']) ) {
- $q['tag__and'] = array_map('absint', array_unique( (array) $q['tag__and'] ) );
- $tax_query[] = array(
- 'taxonomy' => 'post_tag',
- 'terms' => $q['tag__and'],
- 'operator' => 'AND'
- );
- }
- if ( !empty($q['tag_slug__in']) ) {
- $q['tag_slug__in'] = array_map('sanitize_title_for_query', array_unique( (array) $q['tag_slug__in'] ) );
- $tax_query[] = array(
- 'taxonomy' => 'post_tag',
- 'terms' => $q['tag_slug__in'],
- 'field' => 'slug'
- );
- } elseif ( isset( $this->query['tag_slug__in'] ) ) {
- $q['tag_slug__in'] = false;
- }
- if ( !empty($q['tag_slug__and']) ) {
- $q['tag_slug__and'] = array_map('sanitize_title_for_query', array_unique( (array) $q['tag_slug__and'] ) );
- $tax_query[] = array(
- 'taxonomy' => 'post_tag',
- 'terms' => $q['tag_slug__and'],
- 'field' => 'slug',
- 'operator' => 'AND'
- );
- }
- $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 );
- }
- /**
- * Generate SQL for the WHERE clause based on passed search terms.
- *
- * @since 3.7.0
- *
- * @global wpdb $wpdb
- * @param array $q Query variables.
- * @return string WHERE clause.
- */
- protected function parse_search( &$q ) {
- global $wpdb;
- $search = '';
- // added slashes screw with quote grouping when done early, so done later
- $q['s'] = stripslashes( $q['s'] );
- if ( empty( $_GET['s'] ) && $this->is_main_query() )
- $q['s'] = urldecode( $q['s'] );
- // there are no line breaks in <input /> fields
- $q['s'] = str_replace( array( "\r", "\n" ), '', $q['s'] );
- $q['search_terms_count'] = 1;
- if ( ! empty( $q['sentence'] ) ) {
- $q['search_terms'] = array( $q['s'] );
- } else {
- if ( preg_match_all( '/".*?("|$)|((?<=[\t ",+])|^)[^\t ",+]+/', $q['s'], $matches ) ) {
- $q['search_terms_count'] = count( $matches[0] );
- $q['search_terms'] = $this->parse_search_terms( $matches[0] );
- // if the search string has only short terms or stopwords, or is 10+ terms long, match it as sentence
- if ( empty( $q['search_terms'] ) || count( $q['search_terms'] ) > 9 )
- $q['search_terms'] = array( $q['s'] );
- } else {
- $q['search_terms'] = array( $q['s'] );
- }
- }
- $n = ! empty( $q['exact'] ) ? '' : '%';
- $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%'";
- $search .= "{$searchand}(($wpdb->posts.post_title LIKE '{$n}{$term}{$n}') OR ($wpdb->posts.post_content LIKE '{$n}{$term}{$n}'))";
- $searchand = ' AND ';
- }
- if ( ! empty( $search ) ) {
- $search = " AND ({$search}) ";
- if ( ! is_user_logged_in() )
- $search .= " AND ($wpdb->posts.post_password = '') ";
- }
- return $search;
- }
- /**
- * Check if the terms are suitable for searching.
- *
- * Uses an array of stopwords (terms) that are excluded from the separate
- * term matching when searching for posts. The list of English stopwords is
- * the approximate search engines list, and is translatable.
- *
- * @since 3.7.0
- *
- * @param array Terms to check.
- * @return array Terms that are not stopwords.
- */
- protected function parse_search_terms( $terms ) {
- $strtolower = function_exists( 'mb_strtolower' ) ? 'mb_strtolower' : 'strtolower';
- $checked = array();
- $stopwords = $this->get_search_stopwords();
- foreach ( $terms as $term ) {
- // keep before/after spaces when term is for exact match
- if ( preg_match( '/^".+"$/', $term ) )
- $term = trim( $term, "\"'" );
- else
- $term = trim( $term, "\"' " );
- // Avoid single A-Z.
- if ( ! $term || ( 1 === strlen( $term ) && preg_match( '/^[a-z]$/i', $term ) ) )
- continue;
- if ( in_array( call_user_func( $strtolower, $term ), $stopwords, true ) )
- continue;
- $checked[] = $term;
- }
- return $checked;
- }
- /**
- * Retrieve stopwords used when parsing search terms.
- *
- * @since 3.7.0
- *
- * @return array Stopwords.
- */
- protected function get_search_stopwords() {
- if ( isset( $this->stopwords ) )
- return $this->stopwords;
- /* translators: This is a comma-separated list of very common words that should be excluded from a search,
- * like a, an, and the. These are usually called "stopwords". You should not simply translate these individual
- * words into your language. Instead, look for and provide commonly accepted stopwords in your language.
- */
- $words = explode( ',', _x( 'about,an,are,as,at,be,by,com,for,from,how,in,is,it,of,on,or,that,the,this,to,was,what,when,where,who,will,with,www',
- 'Comma-separated list of search stopwords in your language' ) );
- $stopwords = array();
- foreach( $words as $word ) {
- $word = trim( $word, "\r\n\t " );
- if ( $word )
- $stopwords[] = $word;
- }
- /**
- * Filter stopwords used when parsing search terms.
- *
- * @since 3.7.0
- *
- * @param array $stopwords Stopwords.
- */
- $this->stopwords = apply_filters( 'wp_search_stopwords', $stopwords );
- return $this->stopwords;
- }
- /**
- * Generate SQL for the ORDER BY condition based on passed search terms.
- *
- * @global wpdb $wpdb
- * @param array $q Query variables.
- * @return string ORDER BY clause.
- */
- protected function parse_search_order( &$q ) {
- global $wpdb;
- 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 ';
- // sentence match in 'post_title'
- $search_orderby .= "WHEN $wpdb->posts.post_title LIKE '%{$search_orderby_s}%' THEN 1 ";
- // sanity limit, sort as sentence when more than 6 terms
- // (few searches are longer than 6 terms and most titles are not)
- if ( $num_terms < 7 ) {
- // all words in title
- $search_orderby .= 'WHEN ' . implode( ' AND ', $q['search_orderby_title'] ) . ' THEN 2 ';
- // any word in title, not needed when $num_terms == 1
- if ( $num_terms > 1 )
- $search_orderby .= 'WHEN ' . implode( ' OR ', $q['search_orderby_title'] ) . ' THEN 3 ';
- }
- // sentence match in 'post_content'
- $search_orderby .= "WHEN $wpdb->posts.post_content LIKE '%{$search_orderby_s}%' THEN 4 ";
- $search_orderby .= 'ELSE 5 END)';
- } else {
- // single word or sentence search
- $search_orderby = reset( $q['search_orderby_title'] ) . ' DESC';
- }
- return $search_orderby;
- }
- /**
- * Sets the 404 property and saves whether query is feed.
- *
- * @since 2.0.0
- * @access public
- */
- public function set_404() {
- $is_feed = $this->is_feed;
- $this->init_query_flags();
- $this->is_404 = true;
- $this->is_feed = $is_feed;
- }
- /**
- * Retrieve query variable.
- *
- * @since 1.5.0
- * @access public
- *
- * @param string $query_var Query variable key.
- * @par…
Large files files are truncated, but you can click here to view the full file