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

See #55646.

Built from https://develop.svn.wordpress.org/trunk@53798


git-svn-id: http://core.svn.wordpress.org/trunk@53357 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
audrasjb 2022-07-30 14:01:13 +00:00
parent 1cfcf1791e
commit 9ddff60ecd
2 changed files with 8 additions and 8 deletions

View File

@ -233,7 +233,7 @@ class WP_Date_Query {
} }
/** /**
* 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. * Checks to see if the current clause has any time-related keys.
* If so, it's first-order. * If so, it's first-order.
@ -276,7 +276,7 @@ class WP_Date_Query {
* @since 4.1.0 * @since 4.1.0
* *
* @param array $date_query The date_query array. * @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() ) { public function validate_date_values( $date_query = array() ) {
if ( empty( $date_query ) ) { if ( empty( $date_query ) ) {
@ -539,7 +539,7 @@ class WP_Date_Query {
} }
/** /**
* Generate WHERE clause to be appended to a main query. * Generates WHERE clause to be appended to a main query.
* *
* @since 3.7.0 * @since 3.7.0
* *
@ -562,7 +562,7 @@ class WP_Date_Query {
} }
/** /**
* 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 * Called by the public WP_Date_Query::get_sql(), this method is abstracted
* out to maintain parity with the other Query classes. * out to maintain parity with the other Query classes.
@ -587,7 +587,7 @@ class WP_Date_Query {
} }
/** /**
* 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 * If nested subqueries are found, this method recurses the tree to
* produce the properly nested SQL. * produce the properly nested SQL.
@ -858,12 +858,12 @@ class WP_Date_Query {
* *
* @since 3.7.0 * @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 * @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 * 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'). * subset of MySQL date format ('Y', 'Y-m', 'Y-m-d', 'Y-m-d H:i').
* Default: false. * 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 ) { public function build_mysql_datetime( $datetime, $default_to_max = false ) {
if ( ! is_array( $datetime ) ) { if ( ! is_array( $datetime ) ) {

View File

@ -16,7 +16,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '6.1-alpha-53797'; $wp_version = '6.1-alpha-53798';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.