pre_oembed_result filter
This hook allows you to short-circuit the default logic, maybe even replace it with a routine that’s more optimal for your setup. To use the pre_oembed_result filter, you first need to register it using add_filter. You can write this code into the functions.php of your activated theme or in a custom WordPress Plugin.
WePlugins always prefers to create a custom WordPress Plugin when using hooks so nothing breaks when you update your WordPress Theme in the future.
Example 1: Modifying Default Result
In this example, we define a function weplugins_modify_pre_oembed_result_defaults which takes three parameters. We register it using add_filter. The first parameter pre_oembed_result is the name of the hook, the second parameter is the name of the function 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.
function weplugins_modify_pre_oembed_result_defaults($result, $url, $args) {
// Update the $result variable according to your website requirements and return this variable.
return $result;
}
// add the filter
add_filter("pre_oembed_result", "weplugins_modify_pre_oembed_result_defaults", 10, 3);
Example 2: Removing a Hook Callback
Sometimes, you have to remove a registered hook, so you can use remove_filter to remove the pre_oembed_result filter.
remove_filter("pre_oembed_result", "weplugins_modify_pre_oembed_result_defaults", 10, 3);
Please make sure to provide the same callback function name, priority, and number of arguments while removing the hook callback.
Example 3: Custom Embed Handling
Here’s another approach where you can handle embeds in a custom way according to your site’s requirements.
function weplugins_custom_pre_oembed_result($result, $url, $args) {
// Custom logic to handle embed
if ($url === 'https://example.com') {
$result = '<p>Your custom embed code here</p>';
}
return $result;
}
add_filter("pre_oembed_result", "weplugins_custom_pre_oembed_result", 10, 3);
Parameters
- $result: (null|string) The UNSANITIZED (and potentially unsafe) HTML to 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.
Need more help? Feel free to Contact Us for customization inquiries.
