How to use oembed_fetch_url filter in WordPress

oembed_fetch_url filter

Filters the oEmbed URL to be fetched.

To use oembed_fetch_url filter, first you have to register it using add_filter. You can write this code into functions.php of your activated theme or in a custom WordPress Plugin.

We at WePlugins always prefer to create a custom WordPress Plugin while using hooks so nothing breaks when you update your WordPress Theme in the future.

In the below live example, we have defined a function modify_oembed_fetch_url_defaults which takes 3 parameters and we registered using add_filter. The first parameter oembed_fetch_url is the name of the hook, the second parameter modify_oembed_fetch_url_defaults is the name of the function which needs to be called, the third parameter is the priority of calling the hook if the same hook is used multiple times, and the last parameter is the number of arguments (if any) to be passed in the registered function.

Sometimes, you have to remove a registered hook so you can use remove_filter to remove oembed_fetch_url filter.

Parameters

Below are the 3 parameters required to use this hook.

• $provider : (string) URL of the oEmbed provider.
• $url : (string) URL of the content to be embedded.
• $args : (array) Additional arguments for retrieving embed HTML. See wp_oembed_get() for accepted arguments. Default empty.

Live Example

apply_filters('oembed_fetch_url', string $provider, string $url, array $args)

Below is an example of how you can use this hook.

Example 1: Basic Usage

This example demonstrates the basic usage of the oembed_fetch_url filter.

function weplugins_modify_oembed_fetch_url_defaults($provider, $url, $args) {
    // Update the $provider variable according to your website requirements and return this variable.
    return $provider; 
}
// Add the filter
add_filter("oembed_fetch_url", "weplugins_modify_oembed_fetch_url_defaults", 10, 3);

Example 2: Conditional Modification

In this example, the provider URL is modified based on a specific condition.

function weplugins_conditional_oembed_url($provider, $url, $args) {
    if (strpos($url, 'youtube.com') !== false) {
        $provider = 'https://custom-oembed-provider.com';
    }
    return $provider;
}
// Add the filter
add_filter("oembed_fetch_url", "weplugins_conditional_oembed_url", 10, 3);

Example 3: Removing the Hook

To remove a hook callback, use the example below.

remove_filter("oembed_fetch_url", "weplugins_modify_oembed_fetch_url_defaults", 10, 3);

Please make sure to provide the same callback function name, priority, and number of arguments while removing the hook callback.

Contact Us

If you’re having any trouble using this hook, please contact our WordPress Development Team and we’d be happy to assist you.