apply_filters( ‘pre_oembed_result’, null|string $result, string $url, string|array $args )

Filters the oEmbed result before any HTTP requests are made.

Description

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.

Parameters

$resultnull|string
The UNSANITIZED (and potentially unsafe) HTML that should be used to embed.
Default null to continue retrieving the result.
$urlstring
The URL to the content that should be attempted to be embedded.
$argsstring|array
Additional arguments for retrieving embed HTML.
See wp_oembed_get() for accepted arguments. Default empty.
More Arguments from wp_oembed_get( … $args )Additional arguments for retrieving embed HTML.
  • width int|string
    Optional. The maxwidth value passed to the provider URL.
  • height int|string
    Optional. The maxheight value passed to the provider URL.
  • discover bool
    Optional. Determines whether to attempt to discover link tags at the given URL for an oEmbed provider when the provider URL is not found in the built-in providers list. Default true.

Source

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

Changelog

VersionDescription
4.5.3Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.