Changeset 47122 for trunk/src/wp-includes/class-wp-date-query.php

Timestamp:

01/29/2020 12:43:23 AM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve inline comments per the documentation standards.

Includes minor code layout fixes for better readability.

See #48303.

File:

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

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

@@ -274 +274 @@
      * This method only generates debug notices for these cases.
      *
-     * @since  4.1.0
+     * @since 4.1.0
      *
      * @param  array $date_query The date_query array.
@@ -316 +316 @@
             $max_days_of_year = gmdate( 'z', mktime( 0, 0, 0, 12, 31, $_year ) ) + 1;
         } else {
-            // otherwise we use the max of 366 (leap-year)
+            // Otherwise we use the max of 366 (leap-year).
             $max_days_of_year = 366;
         }
@@ -676 +676 @@
      * compatibility while retaining the naming convention across Query classes.
      *
-     * @since  3.7.0
+     * @since 3.7.0
      *
      * @param  array $query Date query arguments.
@@ -693 +693 @@
      * Turns a first-order date query into SQL for a WHERE clause.
      *
-     * @since  4.1.0
+     * @since 4.1.0
      *
      * @param  array $query        Date query clause.
@@ -746 +746 @@
         );
 
-        // Check of the possible date units and add them to the query
+        // Check of the possible date units and add them to the query.
         foreach ( $date_units as $sql_part => $query_parts ) {
             foreach ( $query_parts as $query_part ) {
@@ -967 +967 @@
         global $wpdb;
 
-        // Have to have at least one
+        // Have to have at least one.
         if ( ! isset( $hour ) && ! isset( $minute ) && ! isset( $second ) ) {
             return false;
         }
 
-        // Complex combined queries aren't supported for multi-value queries
+        // Complex combined queries aren't supported for multi-value queries.
         if ( in_array( $compare, array( 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN' ) ) ) {
             $return = array();
@@ -994 +994 @@
         }
 
-        // Cases where just one unit is set
+        // Cases where just one unit is set.
         if ( isset( $hour ) && ! isset( $minute ) && ! isset( $second ) ) {
             $value = $this->build_value( $compare, $hour );
@@ -1020 +1020 @@
         $time   = '';
 
-        // Hour
+        // Hour.
         if ( null !== $hour ) {
             $format .= '%H.';
@@ -1029 +1029 @@
         }
 
-        // Minute
+        // Minute.
         $format .= '%i';
         $time   .= sprintf( '%02d', $minute );