pre_oembed_result WordPress Filter Hook

The pre_oembed_result hook is triggered before the result of an oEmbed request is returned. This hook is useful for modifying the result before it is cached or returned to the user.

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.


Top ↑

Parameters

$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) Additional arguments for retrieving embed HTML. See wp_oembed_get() for accepted arguments. Default empty.


Top ↑

Source

File: wp-includes/class-wp-oembed.php

View on Trac



Top ↑

Changelog

Changelog
VersionDescription
4.5.3Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.