rest_oembed_ttl │ filter-hook │ WP 4.8.0

Filters the oEmbed TTL value (time to live).

Similar to the oembed_ttl filter, but for the REST API oEmbed proxy endpoint.

Usage

add_filter( 'rest_oembed_ttl', 'wp_kama_rest_oembed_ttl_filter', 10, 3 );

/**
 * Function for `rest_oembed_ttl` filter-hook.
 * 
 * @param int    $time Time to live (in seconds).
 * @param string $url  The attempted embed URL.
 * @param array  $args An array of embed request arguments.
 *
 * @return int
 */
function wp_kama_rest_oembed_ttl_filter( $time, $url, $args ){

	// filter...
	return $time;
}

$time(int)

Time to live (in seconds).

$url(string)

The attempted embed URL.

$args(array)

An array of embed request arguments.

Changelog

Where the hook is called

$ttl = apply_filters( 'rest_oembed_ttl', DAY_IN_SECONDS, $url, $args );

Where the hook is used in WordPress