mirror of
https://github.com/gosticks/wordpress-develop.git
synced 2026-07-01 15:50:09 +00:00
Docs: Various docblock fixes in WP_Date_Query class, as per docs standards.
See #55646. git-svn-id: https://develop.svn.wordpress.org/trunk@53798 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
@@ -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.
|
||||
* If so, it's first-order.
|
||||
@@ -276,7 +276,7 @@ class WP_Date_Query {
|
||||
* @since 4.1.0
|
||||
*
|
||||
* @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() ) {
|
||||
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
|
||||
*
|
||||
@@ -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
|
||||
* 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
|
||||
* produce the properly nested SQL.
|
||||
@@ -858,12 +858,12 @@ class WP_Date_Query {
|
||||
*
|
||||
* @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 ) {
|
||||
if ( ! is_array( $datetime ) ) {
|
||||
|
||||
Reference in New Issue
Block a user