Make WordPress Core

Changeset 53798


Ignore:
Timestamp:
07/30/2022 01:59:15 PM (19 months ago)
Author:
audrasjb
Message:

Docs: Various docblock fixes in WP_Date_Query class, as per docs standards.

See #55646.

File:
1 edited

Legend:

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

    r52652 r53798  
    234234
    235235    /**
    236      * Determine whether this is a first-order clause.
     236     * Determines whether this is a first-order clause.
    237237     *
    238238     * Checks to see if the current clause has any time-related keys.
     
    277277     *
    278278     * @param array $date_query The date_query array.
    279      * @return bool  True if all values in the query are valid, false if one or more fail.
     279     * @return bool True if all values in the query are valid, false if one or more fail.
    280280     */
    281281    public function validate_date_values( $date_query = array() ) {
     
    540540
    541541    /**
    542      * Generate WHERE clause to be appended to a main query.
     542     * Generates WHERE clause to be appended to a main query.
    543543     *
    544544     * @since 3.7.0
     
    563563
    564564    /**
    565      * Generate SQL clauses to be appended to a main query.
     565     * Generates SQL clauses to be appended to a main query.
    566566     *
    567567     * Called by the public WP_Date_Query::get_sql(), this method is abstracted
     
    588588
    589589    /**
    590      * Generate SQL clauses for a single query array.
     590     * Generates SQL clauses for a single query array.
    591591     *
    592592     * If nested subqueries are found, this method recurses the tree to
     
    859859     * @since 3.7.0
    860860     *
    861      * @param string|array $datetime       An array of parameters or a strotime() string
     861     * @param string|array $datetime       An array of parameters or a strotime() string.
    862862     * @param bool         $default_to_max Whether to round up incomplete dates. Supported by values
    863863     *                                     of $datetime that are arrays, or string values that are a
    864864     *                                     subset of MySQL date format ('Y', 'Y-m', 'Y-m-d', 'Y-m-d H:i').
    865865     *                                     Default: false.
    866      * @return string|false A MySQL format date/time or false on failure
     866     * @return string|false A MySQL format date/time or false on failure.
    867867     */
    868868    public function build_mysql_datetime( $datetime, $default_to_max = false ) {
Note: See TracChangeset for help on using the changeset viewer.