WordPress.org

Make WordPress Core

Changeset 51906


Ignore:
Timestamp:
10/14/2021 06:03:07 PM (3 months ago)
Author:
SergeyBiryukov
Message:

Docs: Update WP_Date_Query documentation to reflect changes in accepted column names.

Remove outdated list of accepted column name values, add a reference to WP_Date_Query::validate_column() and the date_query_valid_columns filter instead for a more detailed description.

Follow-up to [25139], [25860], [29933], [29934], [29938], [37477], [51905].

Props dimadin, johnjamesjacoby.
Fixes #54248.

File:
1 edited

Legend:

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

    r51905 r51906  
    7575     *     @type array ...$0 {
    7676     *         @type string $column   Optional. The column to query against. If undefined, inherits the value of
    77      *                                the `$default_column` parameter. Accepts 'post_date', 'post_date_gmt',
    78      *                                'post_modified','post_modified_gmt', 'comment_date', 'comment_date_gmt'.
     77     *                                the `$default_column` parameter. See WP_Date_Query::validate_column() and
     78     *                                the {@see 'date_query_valid_columns'} filter for the list of accepted values.
    7979     *                                Default 'post_date'.
    8080     *         @type string $compare  Optional. The comparison operator. Accepts '=', '!=', '>', '>=', '<', '<=',
     
    105105     *                                     Default (string:empty)|(array:last day of month).
    106106     *             }
    107      *             @type string       $column        Optional. Used to add a clause comparing a column other than the
    108      *                                               column specified in the top-level `$column` parameter. Accepts
    109      *                                               'post_date', 'post_date_gmt', 'post_modified', 'post_modified_gmt',
    110      *                                               'comment_date', 'comment_date_gmt'. Default is the value of
    111      *                                               top-level `$column`.
     107     *             @type string       $column        Optional. Used to add a clause comparing a column other than
     108     *                                               the column specified in the top-level `$column` parameter.
     109     *                                               See WP_Date_Query::validate_column() and
     110     *                                               the {@see 'date_query_valid_columns'} filter for the list
     111     *                                               of accepted values. Default is the value of top-level `$column`.
    112112     *             @type string       $compare       Optional. The comparison operator. Accepts '=', '!=', '>', '>=',
    113113     *                                               '<', '<=', 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN'. 'IN',
     
    141141     *     }
    142142     * }
    143      * @param string $default_column Optional. Default column to query against. Default 'post_date'.
    144      *                               Accepts 'post_date', 'post_date_gmt', 'post_modified', 'post_modified_gmt',
    145      *                               'comment_date', 'comment_date_gmt'.
     143     * @param string $default_column Optional. Default column to query against. See WP_Date_Query::validate_column()
     144     *                               and the {@see 'date_query_valid_columns'} filter for the list of accepted values.
     145     *                               Default 'post_date'.
    146146     */
    147147    public function __construct( $date_query, $default_column = 'post_date' ) {
Note: See TracChangeset for help on using the changeset viewer.