WP_Date_Query::validate_date_values( array $date_query = array() ): bool

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$date_queryarrayoptional

The date_query array.Default: array()

Return value

bool

True if all values in the query are valid, false if one or more fail.

Performance profile

How much work a call to WP_Date_Query::validate_date_values() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

41–161

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 285.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

2

2 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()one call below WP_Date_Query::validate_date_values()

Further down the call graph this can also reach option, cache, serialize, query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 40 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Date_Query::validate_date_values() can have, taken from its control-flow graph on PHP 8.5.

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Uses · 5

• __()Retrieves the translation of $text.
• esc_html()Escaping for HTML blocks.
• _doing_it_wrong()Marks something as being incorrectly called.
• wp_checkdate()Tests if the supplied date is valid for the Gregorian calendar.
• WP_Date_Query::validate_date_values()Validates the given date_query values and triggers errors if something is not valid.

Used by · 2

• WP_Date_Query::sanitize_query()Recursive-friendly query sanitizer.
• WP_Date_Query::validate_date_values()Validates the given date_query values and triggers errors if something is not valid.

Source code

View on Trac ↗View on GitHub ↗

285	public function validate_date_values( $date_query = array() ) {286		if ( empty( $date_query ) ) {287			return false;288		}289 290		$valid = true;291 292		/*293		 * Validate 'before' and 'after' up front, then let the294		 * validation routine continue to be sure that all invalid295		 * values generate errors too.296		 */297		if ( array_key_exists( 'before', $date_query ) && is_array( $date_query['before'] ) ) {298			$valid = $this->validate_date_values( $date_query['before'] );299		}300 301		if ( array_key_exists( 'after', $date_query ) && is_array( $date_query['after'] ) ) {302			$valid = $this->validate_date_values( $date_query['after'] );303		}304 305		// Array containing all min-max checks.306		$min_max_checks = array();307 308		// Days per year.309		if ( array_key_exists( 'year', $date_query ) ) {310			/*311			 * If a year exists in the date query, we can use it to get the days.312			 * If multiple years are provided (as in a BETWEEN), use the first one.313			 */314			if ( is_array( $date_query['year'] ) ) {315				$_year = reset( $date_query['year'] );316			} else {317				$_year = $date_query['year'];318			}319 320			$max_days_of_year = (int) gmdate( 'z', mktime( 0, 0, 0, 12, 31, $_year ) ) + 1;321		} else {322			// Otherwise we use the max of 366 (leap-year).323			$max_days_of_year = 366;324		}325 326		$min_max_checks['dayofyear'] = array(327			'min' => 1,328			'max' => $max_days_of_year,329		);330 331		// Days per week.332		$min_max_checks['dayofweek'] = array(333			'min' => 1,334			'max' => 7,335		);336 337		// Days per week.338		$min_max_checks['dayofweek_iso'] = array(339			'min' => 1,340			'max' => 7,341		);342 343		// Months per year.344		$min_max_checks['month'] = array(345			'min' => 1,346			'max' => 12,347		);348 349		// Weeks per year.350		if ( isset( $_year ) ) {351			/*352			 * If we have a specific year, use it to calculate number of weeks.353			 * Note: the number of weeks in a year is the date in which Dec 28 appears.354			 */355			$week_count = gmdate( 'W', mktime( 0, 0, 0, 12, 28, $_year ) );356 357		} else {358			// Otherwise set the week-count to a maximum of 53.359			$week_count = 53;360		}361 362		$min_max_checks['week'] = array(363			'min' => 1,364			'max' => $week_count,

Changelog

Introduced in 4.1.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.9.7 tag, from src/wp-includes/class-wp-date-query.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.