pre_oembed_result │ filter-hook │ WP 4.5.3

Filters the oEmbed result before any HTTP requests are made.

This allows one to short-circuit the default logic, perhaps by replacing it with a routine that is more optimal for your setup.

Returning a non-null value from the filter will effectively short-circuit retrieval and return the passed value instead.

Usage

add_filter( 'pre_oembed_result', 'wp_kama_pre_oembed_result_filter', 10, 3 );

/**
 * Function for `pre_oembed_result` filter-hook.
 * 
 * @param null|string  $result The UNSANITIZED (and potentially unsafe) HTML that should be used to embed.
 * @param string       $url    The URL to the content that should be attempted to be embedded.
 * @param string|array $args   Optional. Additional arguments for retrieving embed HTML. See wp_oembed_get() for accepted arguments.
 *
 * @return null|string
 */
function wp_kama_pre_oembed_result_filter( $result, $url, $args ){

	// filter...
	return $result;
}

$result(null|string)

The UNSANITIZED (and potentially unsafe) HTML that should be used to embed.
Default: null to continue retrieving the result

$url(string)

The URL to the content that should be attempted to be embedded.

$args(string|array)

Optional. Additional arguments for retrieving embed HTML. See wp_oembed_get() for accepted arguments.
Default: ''

Changelog

Where the hook is called

$pre = apply_filters( 'pre_oembed_result', null, $url, $args );

Where the hook is used in WordPress

add_filter( 'pre_oembed_result', 'wp_filter_pre_oembed_result', 10, 3 );