Changeset 53798

Timestamp:

07/30/2022 01:59:15 PM (2 years ago)

Author:

audrasjb

Message:

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

See #55646.

File:

• trunk/src/wp-includes/class-wp-date-query.php (modified) (6 diffs)

trunk/src/wp-includes/class-wp-date-query.php

@@ -234 +234 @@
 
     /**
-     * Determine whether this is a first-order clause.
+     * Determines whether this is a first-order clause.
      *
      * Checks to see if the current clause has any time-related keys.
@@ -277 +277 @@
      *
      * @param array $date_query The date_query array.
-     * @return bool  True if all values in the query are valid, false if one or more fail.
+     * @return bool True if all values in the query are valid, false if one or more fail.
      */
     public function validate_date_values( $date_query = array() ) {
@@ -540 +540 @@
 
     /**
-     * Generate WHERE clause to be appended to a main query.
+     * Generates WHERE clause to be appended to a main query.
      *
      * @since 3.7.0
@@ -563 +563 @@
 
     /**
-     * Generate SQL clauses to be appended to a main query.
+     * Generates SQL clauses to be appended to a main query.
      *
      * Called by the public WP_Date_Query::get_sql(), this method is abstracted
@@ -588 +588 @@
 
     /**
-     * Generate SQL clauses for a single query array.
+     * Generates SQL clauses for a single query array.
      *
      * If nested subqueries are found, this method recurses the tree to
@@ -859 +859 @@
      * @since 3.7.0
      *
-     * @param string|array $datetime       An array of parameters or a strotime() string
+     * @param string|array $datetime       An array of parameters or a strotime() string.
      * @param bool         $default_to_max Whether to round up incomplete dates. Supported by values
      *                                     of $datetime that are arrays, or string values that are a
      *                                     subset of MySQL date format ('Y', 'Y-m', 'Y-m-d', 'Y-m-d H:i').
      *                                     Default: false.
-     * @return string|false A MySQL format date/time or false on failure
+     * @return string|false A MySQL format date/time or false on failure.
      */
     public function build_mysql_datetime( $datetime, $default_to_max = false ) {