Tags

/**
 * Initiates object properties and sets default values.
 *
 * @since 1.5.0
 */

/**
 * Reparse the query vars.
 *
 * @since 1.5.0
 */

/**
 * Fills in the query variables, which do not exist within the parameter.
 *
 * @since 2.1.0
 * @since 4.4.0 Removed the `comments_popup` public query variable.
 *
 * @param array $array Defined query variables.
 * @return array Complete query variables with undefined ones filled in empty.
 */

/**
 * Parse a query string and set query type booleans.
 *
 * @since 1.5.0
 * @since 4.2.0 Introduced the ability to order by specific clauses of a `$meta_query`, by passing the clause's
 *              array key to `$orderby`.
 * @since 4.4.0 Introduced `$post_name__in` and `$title` parameters. `$s` was updated to support excluded
 *              search terms, by prepending a hyphen.
 * @since 4.5.0 Removed the `$comments_popup` parameter.
 *              Introduced the `$comment_status` and `$ping_status` parameters.
 *              Introduced `RAND(x)` syntax for `$orderby`, which allows an integer seed value to random sorts.
 * @since 4.6.0 Added 'post_name__in' support for `$orderby`. Introduced the `$lazy_load_term_meta` argument.
 * @since 4.9.0 Introduced the `$comment_count` parameter.
 *
 * @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 array|int    $comment_count           Filter results by comment count. Provide an integer to match
 *                                                 comment count exactly. Provide an array with integer 'value'
 *                                                 and 'compare' operator ('=', '!=', '>', '>=', '<', '<=' ) to
 *                                                 compare against comment_count in a specific way.
 *     @type string       $comment_status          Comment status.
 *     @type int          $comments_per_page       The number of comments to return per page.
 *                                                 Default 'comments_per_page' option.
 *     @type array        $date_query              An associative array of WP_Date_Query arguments.
 *                                                 See WP_Date_Query::__construct().
 *     @type int          $day                     Day of the month. Default empty. Accepts numbers 1-31.
 *     @type bool         $exact                   Whether to search by exact keyword. Default false.
 *     @type string|array $fields                  Which fields to return. Single field or all fields (string),
 *                                                 or array of fields. 'id=>parent' uses 'id' and 'post_parent'.
 *                                                 Default all fields. Accepts 'ids', 'id=>parent'.
 *     @type int          $hour                    Hour of the day. Default empty. Accepts numbers 0-23.
 *     @type int|bool     $ignore_sticky_posts     Whether to ignore sticky posts or not. Setting this to false
 *                                                 excludes stickies from 'post__in'. Accepts 1|true, 0|false.
 *                                                 Default 0|false.
 *     @type int          $m                       Combination YearMonth. Accepts any four-digit year and month
 *                                                 numbers 1-12. Default empty.
 *     @type string       $meta_compare            Comparison operator to test the 'meta_value'.
 *     @type string       $meta_key                Custom field key.
 *     @type array        $meta_query              An associative array of WP_Meta_Query arguments. See WP_Meta_Query.
 *     @type string       $meta_value              Custom field value.
 *     @type int          $meta_value_num          Custom field value number.
 *     @type int          $menu_order              The menu order of the posts.
 *     @type int          $monthnum                The two-digit month. Default empty. Accepts numbers 1-12.
 *     @type string       $name                    Post slug.
 *     @type bool         $nopaging                Show all posts (true) or paginate (false). Default false.
 *     @type bool         $no_found_rows           Whether to skip counting the total rows found. Enabling can improve
 *                                                 performance. Default false.
 *     @type int          $offset                  The number of posts to offset before retrieval.
 *     @type string       $order                   Designates ascending or descending order of posts. Default 'DESC'.
 *                                                 Accepts 'ASC', 'DESC'.
 *     @type string|array $orderby                 Sort retrieved posts by parameter. One or more options may be
 *                                                 passed. To use 'meta_value', or 'meta_value_num',
 *                                                 'meta_key=keyname' must be also be defined. To sort by a
 *                                                 specific `$meta_query` clause, use that clause's array key.
 *                                                 Accepts 'none', 'name', 'author', 'date', 'title',
 *                                                 'modified', 'menu_order', 'parent', 'ID', 'rand',
 *                                                 'relevance', 'RAND(x)' (where 'x' is an integer seed value),
 *                                                 'comment_count', 'meta_value', 'meta_value_num', 'post__in',
 *                                                 'post_name__in', 'post_parent__in', and the array keys
 *                                                 of `$meta_query`. Default is 'date', except when a search
 *                                                 is being performed, when the default is 'relevance'.
 *
 *     @type int          $p                       Post ID.
 *     @type int          $page                    Show the number of posts that would show up on page X of a
 *                                                 static front page.
 *     @type int          $paged                   The number of the current page.
 *     @type int          $page_id                 Page ID.
 *     @type string       $pagename                Page slug.
 *     @type string       $perm                    Show posts if user has the appropriate capability.
 *     @type string       $ping_status             Ping status.
 *     @type array        $post__in                An array of post IDs to retrieve, sticky posts will be included
 *     @type string       $post_mime_type          The mime type of the post. Used for 'attachment' post_type.
 *     @type array        $post__not_in            An array of post IDs not to retrieve. Note: a string of comma-
 *                                                 separated IDs will NOT work.
 *     @type int          $post_parent             Page ID to retrieve child pages for. Use 0 to only retrieve
 *                                                 top-level pages.
 *     @type array        $post_parent__in         An array containing parent page IDs to query child pages from.
 *     @type array        $post_parent__not_in     An array containing parent page IDs not to query child pages from.
 *     @type string|array $post_type               A post type slug (string) or array of post type slugs.
 *                                                 Default 'any' if using 'tax_query'.
 *     @type string|array $post_status             A post status (string) or array of post statuses.
 *     @type int          $posts_per_page          The number of posts to query for. Use -1 to request all posts.
 *     @type int          $posts_per_archive_page  The number of posts to query for by archive page. Overrides
 *                                                 'posts_per_page' when is_archive(), or is_search() are true.
 *     @type array        $post_name__in           An array of post slugs that results must match.
 *     @type string       $s                       Search keyword(s). Prepending a term with a hyphen will
 *                                                 exclude posts matching that term. Eg, 'pillow -sofa' will
 *                                                 return posts containing 'pillow' but not 'sofa'. The
 *                                                 character used for exclusion can be modified using the
 *                                                 the 'wp_query_search_exclusion_prefix' filter.
 *     @type int          $second                  Second of the minute. Default empty. Accepts numbers 0-60.
 *     @type bool         $sentence                Whether to search by phrase. Default false.
 *     @type bool         $suppress_filters        Whether to suppress filters. Default false.
 *     @type string       $tag                     Tag slug. Comma-separated (either), Plus-separated (all).
 *     @type array        $tag__and                An array of tag ids (AND in).
 *     @type array        $tag__in                 An array of tag ids (OR in).
 *     @type array        $tag__not_in             An array of tag ids (NOT in).
 *     @type int          $tag_id                  Tag id or comma-separated list of IDs.
 *     @type array        $tag_slug__and           An array of tag slugs (AND in).
 *     @type array        $tag_slug__in            An array of tag slugs (OR in). unless 'ignore_sticky_posts' is
 *                                                 true. Note: a string of comma-separated IDs will NOT work.
 *     @type array        $tax_query               An associative array of WP_Tax_Query arguments.
 *                                                 See WP_Tax_Query->queries.
 *     @type string       $title                   Post title.
 *     @type bool         $update_post_meta_cache  Whether to update the post meta cache. Default true.
 *     @type bool         $update_post_term_cache  Whether to update the post term cache. Default true.
 *     @type bool         $lazy_load_term_meta     Whether to lazy-load term meta. Setting to false will
 *                                                 disable cache priming for term meta, so that each
 *                                                 get_term_meta() call will hit the database.
 *                                                 Defaults to the value of `$update_post_term_cache`.
 *     @type int          $w                       The week number of the year. Default empty. Accepts numbers 0-53.
 *     @type int          $year                    The four-digit year. Default empty. Accepts any four-digit year.
 * }
 */

/**
 * Parses various taxonomy related query vars.
 *
 * For BC, this method is not marked as protected. See [28987].
 *
 * @since 3.1.0
 *
 * @param array $q The query variables. Passed by reference.
 */

/**
 * Sets the 404 property and saves whether query is feed.
 *
 * @since 2.0.0
 */

/**
 * Retrieve query variable.
 *
 * @since 1.5.0
 * @since 3.9.0 The `$default` argument was introduced.
 *
 *
 * @param string $query_var Query variable key.
 * @param mixed  $default   Optional. Value to return if the query variable is not set. Default empty.
 * @return mixed Contents of the query variable.
 */

/**
 * Set query variable.
 *
 * @since 1.5.0
 *
 * @param string $query_var Query variable key.
 * @param mixed  $value     Query variable value.
 */

/**
 * Retrieve the posts based on query variables.
 *
 * There are a few filters and actions that can be used to modify the post
 * database query.
 *
 * @since 1.5.0
 *
 * @return array List of posts.
 */

/**
 * Set up the next post and iterate current post index.
 *
 * @since 1.5.0
 *
 * @return WP_Post Next post.
 */

/**
 * Sets up the current post.
 *
 * Retrieves the next post, sets up the post, sets the 'in the loop'
 * property to true.
 *
 * @since 1.5.0
 *
 * @global WP_Post $post
 */

/**
 * Determines whether there are more posts available in the loop.
 *
 * Calls the {@see 'loop_end'} action when the loop is complete.
 *
 * @since 1.5.0
 *
 * @return bool True if posts are available, false if end of loop.
 */

/**
 * Rewind the posts and reset post index.
 *
 * @since 1.5.0
 */

/**
 * Iterate current comment index and return WP_Comment object.
 *
 * @since 2.2.0
 *
 * @return WP_Comment Comment object.
 */

/**
 * Sets up the current comment.
 *
 * @since 2.2.0
 * @global WP_Comment $comment Current comment.
 */

/**
 * Whether there are more comments available.
 *
 * Automatically rewinds comments when finished.
 *
 * @since 2.2.0
 *
 * @return bool True, if more comments. False, if no more posts.
 */

/**
 * Rewind the comments, resets the comment index and comment to first.
 *
 * @since 2.2.0
 */

/**
 * Sets up the WordPress query by parsing query string.
 *
 * @since 1.5.0
 *
 * @param string|array $query URL query string or array of query arguments.
 * @return array List of posts.
 */

/**
 * Retrieve queried object.
 *
 * If queried object is not set, then the queried object will be set from
 * the category, tag, taxonomy, posts page, single post, page, or author
 * query variable. After it is set up, it will be returned.
 *
 * @since 1.5.0
 *
 * @return object
 */

/**
 * Retrieve ID of the current queried object.
 *
 * @since 1.5.0
 *
 * @return int
 */

/**
 * Constructor.
 *
 * Sets up the WordPress query, if parameter is not empty.
 *
 * @since 1.5.0
 *
 * @param string|array $query URL query string or array of vars.
 */

/**
 * Make private properties readable for backward compatibility.
 *
 * @since 4.0.0
 *
 * @param string $name Property to get.
 * @return mixed Property.
 */

/**
 * Make private properties checkable for backward compatibility.
 *
 * @since 4.0.0
 *
 * @param string $name Property to check if set.
 * @return bool Whether the property is set.
 */

/**
 * Make private/protected methods readable for backward compatibility.
 *
 * @since 4.0.0
 *
 * @param callable $name      Method to call.
 * @param array    $arguments Arguments to pass when calling.
 * @return mixed|false Return value of the callback, false otherwise.
 */

/**
 * Is the query for an existing archive page?
 *
   * Month, Year, Category, Author, Post Type archive...
 *
   * @since 3.1.0
 *
   * @return bool
 */

/**
 * Is the query for an existing post type archive page?
 *
 * @since 3.1.0
 *
 * @param mixed $post_types Optional. Post type or array of posts types to check against.
 * @return bool
 */

/**
 * Is the query for an existing attachment page?
 *
 * @since 3.1.0
 *
 * @param mixed $attachment Attachment ID, title, slug, or array of such.
 * @return bool
 */

/**
 * 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.
 *
 * @since 3.1.0
 *
 * @param mixed $author Optional. User ID, nickname, nicename, or array of User IDs, nicknames, and nicenames
 * @return bool
 */

/**
 * 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.
 *
 * @since 3.1.0
 *
 * @param mixed $category Optional. Category ID, name, slug, or array of Category IDs, names, and slugs.
 * @return bool
 */

/**
 * 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.
 *
 * @since 3.1.0
 *
 * @param mixed $tag Optional. Tag ID, name, slug, or array of Tag IDs, names, and slugs.
 * @return bool
 */

/**
 * Is the query for an existing custom taxonomy archive page?
 *
 * If the $taxonomy parameter is specified, this function will additionally
 * check if the query is for that specific $taxonomy.
 *
 * 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.
 *
 * @since 3.1.0
 *
 * @global array $wp_taxonomies
 *
 * @param mixed $taxonomy Optional. Taxonomy slug or slugs.
 * @param mixed $term     Optional. Term ID, name, slug or array of Term IDs, names, and slugs.
 * @return bool True for custom taxonomy archive pages, false for built-in taxonomies (category and tag archives).
 */

/**
 * Whether the current URL is within the comments popup window.
 *
 * @since 3.1.0
 * @deprecated 4.5.0
 *
 * @return bool
 */

/**
 * Is the query for an existing date archive?
 *
 * @since 3.1.0
 *
 * @return bool
 */

/**
 * Is the query for an existing day archive?
 *
 * @since 3.1.0
 *
 * @return bool
 */

/**
 * Is the query for a feed?
 *
 * @since 3.1.0
 *
 * @param string|array $feeds Optional feed types to check.
 * @return bool
 */

/**
 * Is the query for a comments feed?
 *
 * @since 3.1.0
 *
 * @return bool
 */

/**
 * 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 WP_Query::is_home()
 *
 * @since 3.1.0
 *
 * @return bool True, if front of site.
 */

/**
 * 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 WP_Query::is_front_page()
 *
 * @since 3.1.0
 *
 * @return bool True if blog view homepage.
 */

/**
 * Is the query for an existing month archive?
 *
 * @since 3.1.0
 *
 * @return bool
 */

/**
 * 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 WP_Query::is_single()
 * @see WP_Query::is_singular()
 *
 * @since 3.1.0
 *
 * @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.
 */

/**
 * Is the query for paged result and not for the first page?
 *
 * @since 3.1.0
 *
 * @return bool
 */

/**
 * Is the query for a post or page preview?
 *
 * @since 3.1.0
 *
 * @return bool
 */

/**
 * Is the query for the robots file?
 *
 * @since 3.1.0
 *
 * @return bool
 */

/**
 * Is the query for a search?
 *
 * @since 3.1.0
 *
 * @return bool
 */

/**
 * Is the query for an existing single post?
 *
 * Works for any post type excluding pages.
 *
 * If the $post parameter is specified, this function will additionally
 * check if the query is for one of the Posts specified.
 *
 * @see WP_Query::is_page()
 * @see WP_Query::is_singular()
 *
 * @since 3.1.0
 *
 * @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.
 */

/**
 * Is the query for an existing single post of any post type (post, attachment, page,
 * custom post types)?
 *
 * If the $post_types parameter is specified, this function will additionally
 * check if the query is for one of the Posts Types specified.
 *
 * @see WP_Query::is_page()
 * @see WP_Query::is_single()
 *
 * @since 3.1.0
 *
 * @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.
 */

/**
 * Is the query for a specific time?
 *
 * @since 3.1.0
 *
 * @return bool
 */

/**
 * Is the query for a trackback endpoint call?
 *
 * @since 3.1.0
 *
 * @return bool
 */

/**
 * Is the query for an existing year archive?
 *
 * @since 3.1.0
 *
 * @return bool
 */

/**
 * Is the query a 404 (returns no results)?
 *
 * @since 3.1.0
 *
 * @return bool
 */

/**
 * Is the query for an embedded post?
 *
 * @since 4.4.0
 *
 * @return bool
 */

/**
 * Is the query the main query?
 *
 * @since 3.3.0
 *
 * @global WP_Query $wp_query Global WP_Query instance.
 *
 * @return bool
 */

/**
 * 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.
 */

/**
 * After looping through a nested query, this function
 * restores the $post global to the current post in this query.
 *
 * @since 3.7.0
 *
 * @global WP_Post $post
 */

/**
 * Lazyload term meta for posts in the loop.
 *
 * @since 4.4.0
 * @deprecated 4.5.0 See wp_queue_posts_for_term_meta_lazyload().
 *
 * @param mixed $check
 * @param int   $term_id
 * @return mixed
 */

/**
 * Lazyload comment meta for comments in the loop.
 *
 * @since 4.4.0
 * @deprecated 4.5.0 See wp_queue_comments_for_comment_meta_lazyload().
 *
 * @param mixed $check
 * @param int   $comment_id
 * @return mixed
 */

/**
 * Add name to list of public query variables.
 *
 * @since 2.1.0
 *
 * @param string $qv Query variable name.
 */

/**
 * Removes a query variable from a list of public query variables.
 *
 * @since 4.5.0
 *
 * @param string $name Query variable name.
 */

/**
 * Set the value of a query variable.
 *
 * @since 2.3.0
 *
 * @param string $key Query variable name.
 * @param mixed $value Query variable value.
 */

/**
 * Parse request to find correct WordPress query.
 *
 * Sets up the query variables based on the request. There are also many
 * filters and actions that can be used to further manipulate the result.
 *
 * @since 2.0.0
 *
 * @global WP_Rewrite $wp_rewrite
 *
 * @param array|string $extra_query_vars Set the extra query variables.
 */

/**
 * Sends additional HTTP headers for caching, content type, etc.
 *
 * Sets the Content-Type header. Sets the 'error' status (if passed) and optionally exits.
 * If showing a feed, it will also send Last-Modified, ETag, and 304 status if needed.
 *
 * @since 2.0.0
 * @since 4.4.0 `X-Pingback` header is added conditionally after posts have been queried in handle_404().
 */

/**
 * Sets the query string property based off of the query variable property.
 *
 * The {@see 'query_string'} filter is deprecated, but still works. Plugins should
 * use the {@see 'request'} filter instead.
 *
 * @since 2.0.0
 */

/**
 * Set up the WordPress Globals.
 *
 * The query_vars property will be extracted to the GLOBALS. So care should
 * be taken when naming global variables that might interfere with the
 * WordPress environment.
 *
 * @since 2.0.0
 *
 * @global WP_Query     $wp_query
 * @global string       $query_string Query string for the loop.
 * @global array        $posts The found posts.
 * @global WP_Post|null $post The current post, if available.
 * @global string       $request The SQL statement for the request.
 * @global int          $more Only set, if single page or post.
 * @global int          $single If single page or post. Only set, if single page or post.
 * @global WP_User      $authordata Only set, if author archive.
 */

/**
 * Set up the current user.
 *
 * @since 2.0.0
 */

/**
 * Set up the Loop based on the query variables.
 *
 * @since 2.0.0
 *
 * @global WP_Query $wp_the_query
 */

/**
 * Set the Headers for 404, if nothing is found for requested URL.
 *
 * Issue a 404 if a request doesn't match any posts and doesn't match
 * any object (e.g. an existing-but-empty category, tag, author) and a 404 was not already
 * issued, and if the request was not a search or the homepage.
 *
 * Otherwise, issue a 200.
 *
 * This sets headers after posts have been queried. handle_404() really means "handle status."
 * By inspecting the result of querying posts, seemingly successful requests can be switched to
 * a 404 so that canonical redirection logic can kick in.
 *
 * @since 2.0.0
 *
 * @global WP_Query $wp_query
 */

/**
 * Sets up all of the variables required by the WordPress environment.
 *
 * The action {@see 'wp'} has one parameter that references the WP object. It
 * allows for accessing the properties and methods to further manipulate the
 * object.
 *
 * @since 2.0.0
 *
 * @param string|array $query_args Passed to parse_request().
 */