WordPress.org

Make WordPress Core

Changeset 47401


Ignore:
Timestamp:
03/01/2020 05:19:58 PM (9 months ago)
Author:
SergeyBiryukov
Message:

Docs: Synchronize parameter descriptions for conditional tags with their WP_Query counterpart methods.

See #48354, #48303.

Location:
trunk/src/wp-includes
Files:
2 edited

Legend:

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

    r47397 r47401  
    36093609     * @since 3.1.0
    36103610     *
    3611      * @param string|string[] $post_types Optional. Post type or array of posts types to check against.
     3611     * @param string|string[] $post_types Optional. Post type or array of posts types
     3612     *                                    to check against. Default empty.
    36123613     * @return bool
    36133614     */
     
    36313632     * @since 3.1.0
    36323633     *
    3633      * @param int|string|int[]|string[] $attachment Optional. Attachment ID, title, slug, or array of such to check against.
     3634     * @param int|string|int[]|string[] $attachment Optional. Attachment ID, title, slug, or array of such
     3635     *                                              to check against. Default empty.
    36343636     * @return bool
    36353637     */
     
    36653667     * @since 3.1.0
    36663668     *
    3667      * @param int|string|int[]|string[] $author Optional. User ID, nickname, nicename, or array of such to check against.
     3669     * @param int|string|int[]|string[] $author Optional. User ID, nickname, nicename, or array of such
     3670     *                                          to check against. Default empty.
    36683671     * @return bool
    36693672     */
     
    37003703     * @since 3.1.0
    37013704     *
    3702      * @param int|string|int[]|string[] $category Optional. Category ID, name, slug, or array of such to check against.
     3705     * @param int|string|int[]|string[] $category Optional. Category ID, name, slug, or array of such
     3706     *                                            to check against. Default empty.
    37033707     * @return bool
    37043708     */
     
    37353739     * @since 3.1.0
    37363740     *
    3737      * @param int|string|int[]|string[] $tag Optional. Tag ID, name, slug, or array of such to check against.
     3741     * @param int|string|int[]|string[] $tag Optional. Tag ID, name, slug, or array of such
     3742     *                                       to check against. Default empty.
    37383743     * @return bool
    37393744     */
     
    37773782     *
    37783783     * @param string|string[]           $taxonomy Optional. Taxonomy slug or slugs to check against.
    3779      * @param int|string|int[]|string[] $term     Optional. Term ID, name, slug, or array of such to check against.
    3780      * @return bool True for custom taxonomy archive pages, false for built-in taxonomies (category and tag archives).
     3784     *                                            Default empty.
     3785     * @param int|string|int[]|string[] $term     Optional. Term ID, name, slug, or array of such
     3786     *                                            to check against. Default empty.
     3787     * @return bool True for custom taxonomy archive pages, false for built-in taxonomies
     3788     *              (category and tag archives).
    37813789     */
    37823790    public function is_tax( $taxonomy = '', $term = '' ) {
     
    38553863     * @since 3.1.0
    38563864     *
    3857      * @param string|array $feeds Optional feed types to check.
     3865     * @param string|string[] $feeds Optional. Feed type or array of feed types
     3866     *                                         to check against. Default empty.
    38583867     * @return bool
    38593868     */
     
    39703979     * @since 3.1.0
    39713980     *
    3972      * @param int|string|array $page Optional. Page ID, title, slug, path, or array of such. Default empty.
     3981     * @param int|string|array $page Optional. Page ID, title, slug, path, or array of such
     3982     *                               to check against. Default empty.
    39733983     * @return bool Whether the query is for an existing single page.
    39743984     */
     
    40764086     * @since 3.1.0
    40774087     *
    4078      * @param int|string|array $post Optional. Post ID, title, slug, path, or array of such. Default empty.
     4088     * @param int|string|array $post Optional. Post ID, title, slug, path, or array of such
     4089     *                               to check against. Default empty.
    40794090     * @return bool Whether the query is for an existing single post.
    40804091     */
     
    41254136     * @since 3.1.0
    41264137     *
    4127      * @param string|array $post_types Optional. Post type or array of post types. Default empty.
    4128      * @return bool Whether the query is for an existing single post of any of the given post types.
     4138     * @param string|array $post_types Optional. Post type or array of post types
     4139     *                                 to check against. Default empty.
     4140     * @return bool Whether the query is for an existing single post
     4141     *              or any of the given post types.
    41294142     */
    41304143    public function is_singular( $post_types = '' ) {
  • trunk/src/wp-includes/query.php

    r47397 r47401  
    173173 * @global WP_Query $wp_query WordPress Query object.
    174174 *
    175  * @param string|array $post_types Optional. Post type or array of posts types to check against.
     175 * @param string|string[] $post_types Optional. Post type or array of posts types
     176 *                                    to check against. Default empty.
    176177 * @return bool
    177178 */
     
    198199 * @global WP_Query $wp_query WordPress Query object.
    199200 *
    200  * @param int|string|array|object $attachment Attachment ID, title, slug, or array of such.
     201 * @param int|string|int[]|string[] $attachment Optional. Attachment ID, title, slug, or array of such
     202 *                                              to check against. Default empty.
    201203 * @return bool
    202204 */
     
    226228 * @global WP_Query $wp_query WordPress Query object.
    227229 *
    228  * @param int|string|int[]|string[] $author Optional. User ID, nickname, nicename, or array of such to check against.
     230 * @param int|string|int[]|string[] $author Optional. User ID, nickname, nicename, or array of such
     231 *                                          to check against. Default empty.
    229232 * @return bool
    230233 */
     
    254257 * @global WP_Query $wp_query WordPress Query object.
    255258 *
    256  * @param int|string|int[]|string[] $category Optional. Category ID, name, slug, or array of such to check against.
     259 * @param int|string|int[]|string[] $category Optional. Category ID, name, slug, or array of such
     260 *                                            to check against. Default empty.
    257261 * @return bool
    258262 */
     
    282286 * @global WP_Query $wp_query WordPress Query object.
    283287 *
    284  * @param int|string|int[]|string[] $tag Optional. Tag ID, name, slug, or array of such to check against.
     288 * @param int|string|int[]|string[] $tag Optional. Tag ID, name, slug, or array of such
     289 *                                       to check against. Default empty.
    285290 * @return bool
    286291 */
     
    315320 *
    316321 * @param string|string[]           $taxonomy Optional. Taxonomy slug or slugs to check against.
    317  * @param int|string|int[]|string[] $term     Optional. Term ID, name, slug, or array of such to check against.
    318  * @return bool True for custom taxonomy archive pages, false for built-in taxonomies (category and tag archives).
     322 *                                            Default empty.
     323 * @param int|string|int[]|string[] $term     Optional. Term ID, name, slug, or array of such
     324 *                                            to check against. Default empty.
     325 * @return bool True for custom taxonomy archive pages, false for built-in taxonomies
     326 *              (category and tag archives).
    319327 */
    320328function is_tax( $taxonomy = '', $term = '' ) {
     
    390398 * @global WP_Query $wp_query WordPress Query object.
    391399 *
    392  * @param string|array $feeds Optional feed types to check.
     400 * @param string|string[] $feeds Optional. Feed type or array of feed types
     401 *                                         to check against. Default empty.
    393402 * @return bool
    394403 */
     
    561570 * @global WP_Query $wp_query WordPress Query object.
    562571 *
    563  * @param int|string|array $page Optional. Page ID, title, slug, or array of such. Default empty.
     572 * @param int|string|array $page Optional. Page ID, title, slug, or array of such
     573 *                               to check against. Default empty.
    564574 * @return bool Whether the query is for an existing single page.
    565575 */
     
    706716 * @global WP_Query $wp_query WordPress Query object.
    707717 *
    708  * @param int|string|array $post Optional. Post ID, title, slug, or array of such. Default empty.
     718 * @param int|string|array $post Optional. Post ID, title, slug, or array of such
     719 *                               to check against. Default empty.
    709720 * @return bool Whether the query is for an existing single post.
    710721 */
     
    738749 * @global WP_Query $wp_query WordPress Query object.
    739750 *
    740  * @param string|array $post_types Optional. Post type or array of post types. Default empty.
    741  * @return bool Whether the query is for an existing single post of any of the given post types.
     751 * @param string|array $post_types Optional. Post type or array of post types
     752 *                                 to check against. Default empty.
     753 * @return bool Whether the query is for an existing single post
     754 *              or any of the given post types.
    742755 */
    743756function is_singular( $post_types = '' ) {
Note: See TracChangeset for help on using the changeset viewer.