WP_Object_Cache::is_valid_key() │ protected │ WP 6.1.0

Serves as a utility function to determine whether a key is valid.

Method of the class: WP_Object_Cache{}

No Hooks.

Return

true|false. Whether the key is valid.

Usage

// protected - for code of main (parent) or child class
$result = $this->is_valid_key( $key );

$key(int|string) (required)

Cache key to check for validity.

Changelog

WP_Object_Cache::is_valid_key() WP Object Cache::is valid key code ^{WP 6.5.2}

protected function is_valid_key( $key ) {
	if ( is_int( $key ) ) {
		return true;
	}

	if ( is_string( $key ) && trim( $key ) !== '' ) {
		return true;
	}

	$type = gettype( $key );

	if ( ! function_exists( '__' ) ) {
		wp_load_translations_early();
	}

	$message = is_string( $key )
		? __( 'Cache key must not be an empty string.' )
		/* translators: %s: The type of the given cache key. */
		: sprintf( __( 'Cache key must be an integer or a non-empty string, %s given.' ), $type );

	_doing_it_wrong(
		sprintf( '%s::%s', __CLASS__, debug_backtrace( DEBUG_BACKTRACE_IGNORE_ARGS, 2 )[1]['function'] ),
		$message,
		'6.1.0'
	);

	return false;
}