W3cubDocs

/WordPress

WP_REST_URL_Details_Controller::set_cache( string $key, string $data = ): bool

Utility function to cache a given data set at a given cache key.

Parameters

$keystringrequired
The cache key under which to store the value.
$datastringoptional
The data to be stored at the given cache key.

Default:''

Return

bool True when transient set. False if not set.

Source

private function set_cache( $key, $data = '' ) {
	$ttl = HOUR_IN_SECONDS;

	/**
	 * Filters the cache expiration.
	 *
	 * Can be used to adjust the time until expiration in seconds for the cache
	 * of the data retrieved for the given URL.
	 *
	 * @since 5.9.0
	 *
	 * @param int $ttl The time until cache expiration in seconds.
	 */
	$cache_expiration = apply_filters( 'rest_url_details_cache_expiration', $ttl );

	return set_site_transient( $key, $data, $cache_expiration );
}

Hooks

apply_filters( ‘rest_url_details_cache_expiration’, int $ttl )

Filters the cache expiration.

Changelog

Version Description
5.9.0 Introduced.

© 2003–2024 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_rest_url_details_controller/set_cache