Make WordPress Core

Changeset 55887


Ignore:
Timestamp:
06/07/2023 06:51:53 AM (9 months ago)
Author:
audrasjb
Message:

Docs: Improve various docblock in WP_Query class, as per docblock standards.

See #57840.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/class-wp-query.php

    r55855 r55887  
    541541
    542542    /**
    543      * Reparse the query vars.
     543     * Reparses the query vars.
    544544     *
    545545     * @since 1.5.0
     
    633633
    634634    /**
    635      * Parse a query string and set query type booleans.
     635     * Parses a query string and sets query type booleans.
    636636     *
    637637     * @since 1.5.0
     
    653653     *     Optional. Array or string of Query parameters.
    654654     *
    655      *     @type int             $attachment_id           Attachment post ID. Used for 'attachment' post_type.
    656      *     @type int|string      $author                  Author ID, or comma-separated list of IDs.
    657      *     @type string          $author_name             User 'user_nicename'.
    658      *     @type int[]           $author__in              An array of author IDs to query from.
    659      *     @type int[]           $author__not_in          An array of author IDs not to query from.
    660      *     @type bool            $cache_results           Whether to cache post information. Default true.
    661      *     @type int|string      $cat                     Category ID or comma-separated list of IDs (this or any children).
    662      *     @type int[]           $category__and           An array of category IDs (AND in).
    663      *     @type int[]           $category__in            An array of category IDs (OR in, no children).
    664      *     @type int[]           $category__not_in        An array of category IDs (NOT in).
    665      *     @type string          $category_name           Use category slug (not name, this or any children).
    666      *     @type array|int       $comment_count           Filter results by comment count. Provide an integer to match
    667      *                                                    comment count exactly. Provide an array with integer 'value'
    668      *                                                    and 'compare' operator ('=', '!=', '>', '>=', '<', '<=' ) to
    669      *                                                    compare against comment_count in a specific way.
    670      *     @type string          $comment_status          Comment status.
    671      *     @type int             $comments_per_page       The number of comments to return per page.
    672      *                                                    Default 'comments_per_page' option.
    673      *     @type array           $date_query              An associative array of WP_Date_Query arguments.
    674      *                                                    See WP_Date_Query::__construct().
    675      *     @type int             $day                     Day of the month. Default empty. Accepts numbers 1-31.
    676      *     @type bool            $exact                   Whether to search by exact keyword. Default false.
    677      *     @type string          $fields                  Post fields to query for. Accepts:
    678      *                                                    - '' Returns an array of complete post objects (`WP_Post[]`).
    679      *                                                    - 'ids' Returns an array of post IDs (`int[]`).
    680      *                                                    - 'id=>parent' Returns an associative array of parent post IDs,
    681      *                                                      keyed by post ID (`int[]`).
    682      *                                                    Default ''.
    683      *     @type int             $hour                    Hour of the day. Default empty. Accepts numbers 0-23.
    684      *     @type int|bool        $ignore_sticky_posts     Whether to ignore sticky posts or not. Setting this to false
    685      *                                                    excludes stickies from 'post__in'. Accepts 1|true, 0|false.
    686      *                                                    Default false.
    687      *     @type int             $m                       Combination YearMonth. Accepts any four-digit year and month
    688      *                                                    numbers 01-12. Default empty.
    689      *     @type string|string[] $meta_key                Meta key or keys to filter by.
    690      *     @type string|string[] $meta_value              Meta value or values to filter by.
    691      *     @type string          $meta_compare            MySQL operator used for comparing the meta value.
    692      *                                                    See WP_Meta_Query::__construct() for accepted values and default value.
    693      *     @type string          $meta_compare_key        MySQL operator used for comparing the meta key.
    694      *                                                    See WP_Meta_Query::__construct() for accepted values and default value.
    695      *     @type string          $meta_type               MySQL data type that the meta_value column will be CAST to for comparisons.
    696      *                                                    See WP_Meta_Query::__construct() for accepted values and default value.
    697      *     @type string          $meta_type_key           MySQL data type that the meta_key column will be CAST to for comparisons.
    698      *                                                    See WP_Meta_Query::__construct() for accepted values and default value.
    699      *     @type array           $meta_query              An associative array of WP_Meta_Query arguments.
    700      *                                                    See WP_Meta_Query::__construct() for accepted values.
    701      *     @type int             $menu_order              The menu order of the posts.
    702      *     @type int             $minute                  Minute of the hour. Default empty. Accepts numbers 0-59.
    703      *     @type int             $monthnum                The two-digit month. Default empty. Accepts numbers 1-12.
    704      *     @type string          $name                    Post slug.
    705      *     @type bool            $nopaging                Show all posts (true) or paginate (false). Default false.
    706      *     @type bool            $no_found_rows           Whether to skip counting the total rows found. Enabling can improve
    707      *                                                    performance. Default false.
    708      *     @type int             $offset                  The number of posts to offset before retrieval.
    709      *     @type string          $order                   Designates ascending or descending order of posts. Default 'DESC'.
    710      *                                                    Accepts 'ASC', 'DESC'.
    711      *     @type string|array    $orderby                 Sort retrieved posts by parameter. One or more options may be passed.
    712      *                                                    To use 'meta_value', or 'meta_value_num', 'meta_key=keyname' must be
    713      *                                                    also be defined. To sort by a specific `$meta_query` clause, use that
    714      *                                                    clause's array key. Accepts:
    715      *                                                    - 'none'
    716      *                                                    - 'name'
    717      *                                                    - 'author'
    718      *                                                    - 'date'
    719      *                                                    - 'title'
    720      *                                                    - 'modified'
    721      *                                                    - 'menu_order'
    722      *                                                    - 'parent'
    723      *                                                    - 'ID'
    724      *                                                    - 'rand'
    725      *                                                    - 'relevance'
    726      *                                                    - 'RAND(x)' (where 'x' is an integer seed value)
    727      *                                                    - 'comment_count'
    728      *                                                    - 'meta_value'
    729      *                                                    - 'meta_value_num'
    730      *                                                    - 'post__in'
    731      *                                                    - 'post_name__in'
    732      *                                                    - 'post_parent__in'
    733      *                                                    - The array keys of `$meta_query`.
    734      *                                                    Default is 'date', except when a search is being performed, when
    735      *                                                    the default is 'relevance'.
    736      *     @type int             $p                       Post ID.
    737      *     @type int             $page                    Show the number of posts that would show up on page X of a
    738      *                                                    static front page.
    739      *     @type int             $paged                   The number of the current page.
    740      *     @type int             $page_id                 Page ID.
    741      *     @type string          $pagename                Page slug.
    742      *     @type string          $perm                    Show posts if user has the appropriate capability.
    743      *     @type string          $ping_status             Ping status.
    744      *     @type int[]           $post__in                An array of post IDs to retrieve, sticky posts will be included.
    745      *     @type int[]           $post__not_in            An array of post IDs not to retrieve. Note: a string of comma-
    746      *                                                    separated IDs will NOT work.
    747      *     @type string          $post_mime_type          The mime type of the post. Used for 'attachment' post_type.
    748      *     @type string[]        $post_name__in           An array of post slugs that results must match.
    749      *     @type int             $post_parent             Page ID to retrieve child pages for. Use 0 to only retrieve
    750      *                                                    top-level pages.
    751      *     @type int[]           $post_parent__in         An array containing parent page IDs to query child pages from.
    752      *     @type int[]           $post_parent__not_in     An array containing parent page IDs not to query child pages from.
    753      *     @type string|string[] $post_type               A post type slug (string) or array of post type slugs.
    754      *                                                    Default 'any' if using 'tax_query'.
    755      *     @type string|string[] $post_status             A post status (string) or array of post statuses.
    756      *     @type int             $posts_per_page          The number of posts to query for. Use -1 to request all posts.
    757      *     @type int             $posts_per_archive_page  The number of posts to query for by archive page. Overrides
    758      *                                                    'posts_per_page' when is_archive(), or is_search() are true.
    759      *     @type string          $s                       Search keyword(s). Prepending a term with a hyphen will
    760      *                                                    exclude posts matching that term. Eg, 'pillow -sofa' will
    761      *                                                    return posts containing 'pillow' but not 'sofa'. The
    762      *                                                    character used for exclusion can be modified using the
    763      *                                                    the 'wp_query_search_exclusion_prefix' filter.
    764      *     @type string[]        $search_columns          Array of column names to be searched. Accepts 'post_title',
    765      *                                                    'post_excerpt' and 'post_content'. Default empty array.
    766      *     @type int             $second                  Second of the minute. Default empty. Accepts numbers 0-59.
    767      *     @type bool            $sentence                Whether to search by phrase. Default false.
    768      *     @type bool            $suppress_filters        Whether to suppress filters. Default false.
    769      *     @type string          $tag                     Tag slug. Comma-separated (either), Plus-separated (all).
    770      *     @type int[]           $tag__and                An array of tag IDs (AND in).
    771      *     @type int[]           $tag__in                 An array of tag IDs (OR in).
    772      *     @type int[]           $tag__not_in             An array of tag IDs (NOT in).
    773      *     @type int             $tag_id                  Tag id or comma-separated list of IDs.
    774      *     @type string[]        $tag_slug__and           An array of tag slugs (AND in).
    775      *     @type string[]        $tag_slug__in            An array of tag slugs (OR in). unless 'ignore_sticky_posts' is
    776      *                                                    true. Note: a string of comma-separated IDs will NOT work.
    777      *     @type array           $tax_query               An associative array of WP_Tax_Query arguments.
    778      *                                                    See WP_Tax_Query::__construct().
    779      *     @type string          $title                   Post title.
    780      *     @type bool            $update_post_meta_cache  Whether to update the post meta cache. Default true.
    781      *     @type bool            $update_post_term_cache  Whether to update the post term cache. Default true.
    782      *     @type bool            $update_menu_item_cache  Whether to update the menu item cache. Default false.
    783      *     @type bool            $lazy_load_term_meta     Whether to lazy-load term meta. Setting to false will
    784      *                                                    disable cache priming for term meta, so that each
    785      *                                                    get_term_meta() call will hit the database.
    786      *                                                    Defaults to the value of `$update_post_term_cache`.
    787      *     @type int             $w                       The week number of the year. Default empty. Accepts numbers 0-53.
    788      *     @type int             $year                    The four-digit year. Default empty. Accepts any four-digit year.
     655     *     @type int             $attachment_id          Attachment post ID. Used for 'attachment' post_type.
     656     *     @type int|string      $author                 Author ID, or comma-separated list of IDs.
     657     *     @type string          $author_name            User 'user_nicename'.
     658     *     @type int[]           $author__in             An array of author IDs to query from.
     659     *     @type int[]           $author__not_in         An array of author IDs not to query from.
     660     *     @type bool            $cache_results          Whether to cache post information. Default true.
     661     *     @type int|string      $cat                    Category ID or comma-separated list of IDs (this or any children).
     662     *     @type int[]           $category__and          An array of category IDs (AND in).
     663     *     @type int[]           $category__in           An array of category IDs (OR in, no children).
     664     *     @type int[]           $category__not_in       An array of category IDs (NOT in).
     665     *     @type string          $category_name          Use category slug (not name, this or any children).
     666     *     @type array|int       $comment_count          Filter results by comment count. Provide an integer to match
     667     *                                                   comment count exactly. Provide an array with integer 'value'
     668     *                                                   and 'compare' operator ('=', '!=', '>', '>=', '<', '<=' ) to
     669     *                                                   compare against comment_count in a specific way.
     670     *     @type string          $comment_status         Comment status.
     671     *     @type int             $comments_per_page      The number of comments to return per page.
     672     *                                                   Default 'comments_per_page' option.
     673     *     @type array           $date_query             An associative array of WP_Date_Query arguments.
     674     *                                                   See WP_Date_Query::__construct().
     675     *     @type int             $day                    Day of the month. Default empty. Accepts numbers 1-31.
     676     *     @type bool            $exact                  Whether to search by exact keyword. Default false.
     677     *     @type string          $fields                 Post fields to query for. Accepts:
     678     *                                                   - '' Returns an array of complete post objects (`WP_Post[]`).
     679     *                                                   - 'ids' Returns an array of post IDs (`int[]`).
     680     *                                                   - 'id=>parent' Returns an associative array of parent post IDs,
     681     *                                                     keyed by post ID (`int[]`).
     682     *                                                   Default ''.
     683     *     @type int             $hour                   Hour of the day. Default empty. Accepts numbers 0-23.
     684     *     @type int|bool        $ignore_sticky_posts    Whether to ignore sticky posts or not. Setting this to false
     685     *                                                   excludes stickies from 'post__in'. Accepts 1|true, 0|false.
     686     *                                                   Default false.
     687     *     @type int             $m                      Combination YearMonth. Accepts any four-digit year and month
     688     *                                                   numbers 01-12. Default empty.
     689     *     @type string|string[] $meta_key               Meta key or keys to filter by.
     690     *     @type string|string[] $meta_value             Meta value or values to filter by.
     691     *     @type string          $meta_compare           MySQL operator used for comparing the meta value.
     692     *                                                   See WP_Meta_Query::__construct() for accepted values and default value.
     693     *     @type string          $meta_compare_key       MySQL operator used for comparing the meta key.
     694     *                                                   See WP_Meta_Query::__construct() for accepted values and default value.
     695     *     @type string          $meta_type              MySQL data type that the meta_value column will be CAST to for comparisons.
     696     *                                                   See WP_Meta_Query::__construct() for accepted values and default value.
     697     *     @type string          $meta_type_key          MySQL data type that the meta_key column will be CAST to for comparisons.
     698     *                                                   See WP_Meta_Query::__construct() for accepted values and default value.
     699     *     @type array           $meta_query             An associative array of WP_Meta_Query arguments.
     700     *                                                   See WP_Meta_Query::__construct() for accepted values.
     701     *     @type int             $menu_order             The menu order of the posts.
     702     *     @type int             $minute                 Minute of the hour. Default empty. Accepts numbers 0-59.
     703     *     @type int             $monthnum               The two-digit month. Default empty. Accepts numbers 1-12.
     704     *     @type string          $name                   Post slug.
     705     *     @type bool            $nopaging               Show all posts (true) or paginate (false). Default false.
     706     *     @type bool            $no_found_rows          Whether to skip counting the total rows found. Enabling can improve
     707     *                                                   performance. Default false.
     708     *     @type int             $offset                 The number of posts to offset before retrieval.
     709     *     @type string          $order                  Designates ascending or descending order of posts. Default 'DESC'.
     710     *                                                   Accepts 'ASC', 'DESC'.
     711     *     @type string|array    $orderby                Sort retrieved posts by parameter. One or more options may be passed.
     712     *                                                   To use 'meta_value', or 'meta_value_num', 'meta_key=keyname' must be
     713     *                                                   also be defined. To sort by a specific `$meta_query` clause, use that
     714     *                                                   clause's array key. Accepts:
     715     *                                                   - 'none'
     716     *                                                   - 'name'
     717     *                                                   - 'author'
     718     *                                                   - 'date'
     719     *                                                   - 'title'
     720     *                                                   - 'modified'
     721     *                                                   - 'menu_order'
     722     *                                                   - 'parent'
     723     *                                                   - 'ID'
     724     *                                                   - 'rand'
     725     *                                                   - 'relevance'
     726     *                                                   - 'RAND(x)' (where 'x' is an integer seed value)
     727     *                                                   - 'comment_count'
     728     *                                                   - 'meta_value'
     729     *                                                   - 'meta_value_num'
     730     *                                                   - 'post__in'
     731     *                                                   - 'post_name__in'
     732     *                                                   - 'post_parent__in'
     733     *                                                   - The array keys of `$meta_query`.
     734     *                                                   Default is 'date', except when a search is being performed, when
     735     *                                                   the default is 'relevance'.
     736     *     @type int             $p                      Post ID.
     737     *     @type int             $page                   Show the number of posts that would show up on page X of a
     738     *                                                   static front page.
     739     *     @type int             $paged                  The number of the current page.
     740     *     @type int             $page_id                Page ID.
     741     *     @type string          $pagename               Page slug.
     742     *     @type string          $perm                   Show posts if user has the appropriate capability.
     743     *     @type string          $ping_status            Ping status.
     744     *     @type int[]           $post__in               An array of post IDs to retrieve, sticky posts will be included.
     745     *     @type int[]           $post__not_in           An array of post IDs not to retrieve. Note: a string of comma-
     746     *                                                   separated IDs will NOT work.
     747     *     @type string          $post_mime_type         The mime type of the post. Used for 'attachment' post_type.
     748     *     @type string[]        $post_name__in          An array of post slugs that results must match.
     749     *     @type int             $post_parent            Page ID to retrieve child pages for. Use 0 to only retrieve
     750     *                                                   top-level pages.
     751     *     @type int[]           $post_parent__in        An array containing parent page IDs to query child pages from.
     752     *     @type int[]           $post_parent__not_in    An array containing parent page IDs not to query child pages from.
     753     *     @type string|string[] $post_type              A post type slug (string) or array of post type slugs.
     754     *                                                   Default 'any' if using 'tax_query'.
     755     *     @type string|string[] $post_status            A post status (string) or array of post statuses.
     756     *     @type int             $posts_per_page         The number of posts to query for. Use -1 to request all posts.
     757     *     @type int             $posts_per_archive_page The number of posts to query for by archive page. Overrides
     758     *                                                   'posts_per_page' when is_archive(), or is_search() are true.
     759     *     @type string          $s                      Search keyword(s). Prepending a term with a hyphen will
     760     *                                                   exclude posts matching that term. Eg, 'pillow -sofa' will
     761     *                                                   return posts containing 'pillow' but not 'sofa'. The
     762     *                                                   character used for exclusion can be modified using the
     763     *                                                   the 'wp_query_search_exclusion_prefix' filter.
     764     *     @type string[]        $search_columns         Array of column names to be searched. Accepts 'post_title',
     765     *                                                   'post_excerpt' and 'post_content'. Default empty array.
     766     *     @type int             $second                 Second of the minute. Default empty. Accepts numbers 0-59.
     767     *     @type bool            $sentence               Whether to search by phrase. Default false.
     768     *     @type bool            $suppress_filters       Whether to suppress filters. Default false.
     769     *     @type string          $tag                    Tag slug. Comma-separated (either), Plus-separated (all).
     770     *     @type int[]           $tag__and               An array of tag IDs (AND in).
     771     *     @type int[]           $tag__in                An array of tag IDs (OR in).
     772     *     @type int[]           $tag__not_in            An array of tag IDs (NOT in).
     773     *     @type int             $tag_id                 Tag id or comma-separated list of IDs.
     774     *     @type string[]        $tag_slug__and          An array of tag slugs (AND in).
     775     *     @type string[]        $tag_slug__in           An array of tag slugs (OR in). unless 'ignore_sticky_posts' is
     776     *                                                   true. Note: a string of comma-separated IDs will NOT work.
     777     *     @type array           $tax_query              An associative array of WP_Tax_Query arguments.
     778     *                                                   See WP_Tax_Query::__construct().
     779     *     @type string          $title                  Post title.
     780     *     @type bool            $update_post_meta_cache Whether to update the post meta cache. Default true.
     781     *     @type bool            $update_post_term_cache Whether to update the post term cache. Default true.
     782     *     @type bool            $update_menu_item_cache Whether to update the menu item cache. Default false.
     783     *     @type bool            $lazy_load_term_meta    Whether to lazy-load term meta. Setting to false will
     784     *                                                   disable cache priming for term meta, so that each
     785     *                                                   get_term_meta() call will hit the database.
     786     *                                                   Defaults to the value of `$update_post_term_cache`.
     787     *     @type int             $w                      The week number of the year. Default empty. Accepts numbers 0-53.
     788     *     @type int             $year                   The four-digit year. Default empty. Accepts any four-digit year.
    789789     * }
    790790     */
     
    15041504
    15051505    /**
    1506      * Check if the terms are suitable for searching.
     1506     * Checks if the terms are suitable for searching.
    15071507     *
    15081508     * Uses an array of stopwords (terms) that are excluded from the separate
     
    15451545
    15461546    /**
    1547      * Retrieve stopwords used when parsing search terms.
     1547     * Retrieves stopwords used when parsing search terms.
    15481548     *
    15491549     * @since 3.7.0
     
    35413541
    35423542    /**
    3543      * Set up the amount of found posts and the number of pages (if limit clause was used)
     3543     * Sets up the amount of found posts and the number of pages (if limit clause was used)
    35443544     * for the current query.
    35453545     *
     
    36003600
    36013601    /**
    3602      * Set up the next post and iterate current post index.
     3602     * Sets up the next post and iterate current post index.
    36033603     *
    36043604     * @since 1.5.0
     
    36993699
    37003700    /**
    3701      * Rewind the posts and reset post index.
     3701     * Rewinds the posts and resets post index.
    37023702     *
    37033703     * @since 1.5.0
     
    37113711
    37123712    /**
    3713      * Iterate current comment index and return WP_Comment object.
     3713     * Iterates current comment index and returns WP_Comment object.
    37143714     *
    37153715     * @since 2.2.0
     
    37483748
    37493749    /**
    3750      * Whether there are more comments available.
     3750     * Determines whether there are more comments available.
    37513751     *
    37523752     * Automatically rewinds comments when finished.
     
    37673767
    37683768    /**
    3769      * Rewind the comments, resets the comment index and comment to first.
     3769     * Rewinds the comments, resets the comment index and comment to first.
    37703770     *
    37713771     * @since 2.2.0
     
    39293929
    39303930    /**
    3931      * Make private properties readable for backward compatibility.
     3931     * Makes private properties readable for backward compatibility.
    39323932     *
    39333933     * @since 4.0.0
     
    39433943
    39443944    /**
    3945      * Make private properties checkable for backward compatibility.
     3945     * Makes private properties checkable for backward compatibility.
    39463946     *
    39473947     * @since 4.0.0
     
    39573957
    39583958    /**
    3959      * Make private/protected methods readable for backward compatibility.
     3959     * Makes private/protected methods readable for backward compatibility.
    39603960     *
    39613961     * @since 4.0.0
     
    39733973
    39743974    /**
    3975      * Is the query for an existing archive page?
     3975     * Determines whether the query is for an existing archive page.
    39763976     *
    39773977     * Archive pages include category, tag, author, date, custom post type,
     
    39943994
    39953995    /**
    3996      * Is the query for an existing post type archive page?
     3996     * Determines whether the query is for an existing post type archive page.
    39973997     *
    39983998     * @since 3.1.0
     
    40214021
    40224022    /**
    4023      * Is the query for an existing attachment page?
     4023     * Determines whether the query is for an existing attachment page.
    40244024     *
    40254025     * @since 3.1.0
     
    40564056
    40574057    /**
    4058      * Is the query for an existing author archive page?
     4058     * Determines whether the query is for an existing author archive page.
    40594059     *
    40604060     * If the $author parameter is specified, this function will additionally
     
    40954095
    40964096    /**
    4097      * Is the query for an existing category archive page?
     4097     * Determines whether the query is for an existing category archive page.
    40984098     *
    40994099     * If the $category parameter is specified, this function will additionally
     
    41344134
    41354135    /**
    4136      * Is the query for an existing tag archive page?
     4136     * Determines whether the query is for an existing tag archive page.
    41374137     *
    41384138     * If the $tag parameter is specified, this function will additionally
     
    41734173
    41744174    /**
    4175      * Is the query for an existing custom taxonomy archive page?
     4175     * Determines whether the query is for an existing custom taxonomy archive page.
    41764176     *
    41774177     * If the $taxonomy parameter is specified, this function will additionally
     
    42294229
    42304230    /**
    4231      * Whether the current URL is within the comments popup window.
     4231     * Determines whether the current URL is within the comments popup window.
    42324232     *
    42334233     * @since 3.1.0
     
    42434243
    42444244    /**
    4245      * Is the query for an existing date archive?
     4245     * Determines whether the query is for an existing date archive.
    42464246     *
    42474247     * @since 3.1.0
     
    42544254
    42554255    /**
    4256      * Is the query for an existing day archive?
     4256     * Determines whether the query is for an existing day archive.
    42574257     *
    42584258     * @since 3.1.0
     
    42654265
    42664266    /**
    4267      * Is the query for a feed?
     4267     * Determines whether the query is for a feed.
    42684268     *
    42694269     * @since 3.1.0
     
    42874287
    42884288    /**
    4289      * Is the query for a comments feed?
     4289     * Determines whether the query is for a comments feed.
    42904290     *
    42914291     * @since 3.1.0
     
    42984298
    42994299    /**
    4300      * Is the query for the front page of the site?
     4300     * Determines whether the query is for the front page of the site.
    43014301     *
    43024302     * This is for what is displayed at your site's main URL.
     
    43274327
    43284328    /**
    4329      * Is the query for the blog homepage?
     4329     * Determines whether the query is for the blog homepage.
    43304330     *
    43314331     * This is the page which shows the time based blog content of your site.
     
    43474347
    43484348    /**
    4349      * Is the query for the Privacy Policy page?
     4349     * Determines whether the query is for the Privacy Policy page.
    43504350     *
    43514351     * This is the page which shows the Privacy Policy content of your site.
     
    43704370
    43714371    /**
    4372      * Is the query for an existing month archive?
     4372     * Determines whether the query is for an existing month archive.
    43734373     *
    43744374     * @since 3.1.0
     
    43814381
    43824382    /**
    4383      * Is the query for an existing single page?
     4383     * Determines whether the query is for an existing single page.
    43844384     *
    43854385     * If the $page parameter is specified, this function will additionally
     
    44344434
    44354435    /**
    4436      * Is the query for a paged result and not for the first page?
     4436     * Determines whether the query is for a paged result and not for the first page.
    44374437     *
    44384438     * @since 3.1.0
     
    44454445
    44464446    /**
    4447      * Is the query for a post or page preview?
     4447     * Determines whether the query is for a post or page preview.
    44484448     *
    44494449     * @since 3.1.0
     
    44564456
    44574457    /**
    4458      * Is the query for the robots.txt file?
     4458     * Determines whether the query is for the robots.txt file.
    44594459     *
    44604460     * @since 3.1.0
     
    44674467
    44684468    /**
    4469      * Is the query for the favicon.ico file?
     4469     * Determines whether the query is for the favicon.ico file.
    44704470     *
    44714471     * @since 5.4.0
     
    44784478
    44794479    /**
    4480      * Is the query for a search?
     4480     * Determines whether the query is for a search.
    44814481     *
    44824482     * @since 3.1.0
     
    44894489
    44904490    /**
    4491      * Is the query for an existing single post?
     4491     * Determines whether the query is for an existing single post.
    44924492     *
    44934493     * Works for any post type excluding pages.
     
    45434543
    45444544    /**
    4545      * Is the query for an existing single post of any post type (post, attachment, page,
    4546      * custom post types)?
     4545     * Determines whether the query is for an existing single post of any post type
     4546     * (post, attachment, page, custom post types).
    45474547     *
    45484548     * If the $post_types parameter is specified, this function will additionally
     
    45734573
    45744574    /**
    4575      * Is the query for a specific time?
     4575     * Determines whether the query is for a specific time.
    45764576     *
    45774577     * @since 3.1.0
     
    45844584
    45854585    /**
    4586      * Is the query for a trackback endpoint call?
     4586     * Determines whether the query is for a trackback endpoint call.
    45874587     *
    45884588     * @since 3.1.0
     
    45954595
    45964596    /**
    4597      * Is the query for an existing year archive?
     4597     * Determines whether the query is for an existing year archive.
    45984598     *
    45994599     * @since 3.1.0
     
    46064606
    46074607    /**
    4608      * Is the query a 404 (returns no results)?
     4608     * Determines whether the query is a 404 (returns no results).
    46094609     *
    46104610     * @since 3.1.0
     
    46174617
    46184618    /**
    4619      * Is the query for an embedded post?
     4619     * Determines whether the query is for an embedded post.
    46204620     *
    46214621     * @since 4.4.0
     
    46284628
    46294629    /**
    4630      * Is the query the main query?
     4630     * Determines whether the query is the main query.
    46314631     *
    46324632     * @since 3.3.0
     
    46424642
    46434643    /**
    4644      * Set up global post data.
     4644     * Sets up global post data.
    46454645     *
    46464646     * @since 4.1.0
     
    47014701
    47024702    /**
    4703      * Generate post data.
     4703     * Generates post data.
    47044704     *
    47054705     * @since 5.2.0
     
    48044804
    48054805    /**
    4806      * Generate cache key.
     4806     * Generates cache key.
    48074807     *
    48084808     * @since 6.1.0
     
    48124812     * @param array  $args Query arguments.
    48134813     * @param string $sql  SQL statement.
    4814      *
    48154814     * @return string Cache key.
    48164815     */
     
    48744873
    48754874    /**
    4876      * Lazyload term meta for posts in the loop.
     4875     * Lazyloads term meta for posts in the loop.
    48774876     *
    48784877     * @since 4.4.0
     
    48894888
    48904889    /**
    4891      * Lazyload comment meta for comments in the loop.
     4890     * Lazyloads comment meta for comments in the loop.
    48924891     *
    48934892     * @since 4.4.0
Note: See TracChangeset for help on using the changeset viewer.