Filter hook 'pre_oembed_result'

in WP Core File wp-includes/class-wp-oembed.php at line 406

Description

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.

Occurrences

Filename Line Number
wp-includes/class-wp-oembed.php 406

Parameters

Type Name Description
null|string $result The UNSANITIZED (and potentially unsafe) HTML that should be used to embed. Default null to continue retrieving the result.
string $url The URL to the content that should be attempted to be embedded.
string|array $args Optional. Additional arguments for retrieving embed HTML. See wp_oembed_get() for accepted arguments. Default empty.

PHP Doc

/**
		 * 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.
		 *
		 * @since 4.5.3
		 *
		 * @param null|string  $result The UNSANITIZED (and potentially unsafe) HTML that should be used to embed.
		 *                             Default null to continue retrieving the result.
		 * @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. Default empty.
		 */