wp_embed_register_handler() WordPress Function

The wp_embed_register_handler() function allows you to register your own handler for the [embed] shortcode. This can be useful if you want to customize the way your content is embedded in other sites.

wp_embed_register_handler( string $id, string $regex, callable $callback, int $priority = 10 ) #

Registers an embed handler.


Description

Should probably only be used for sites that do not support oEmbed.


Top ↑

Parameters

$id

(string)(Required)An internal ID/name for the handler. Needs to be unique.

$regex

(string)(Required)The regex that will be used to see if this handler should be used for a URL.

$callback

(callable)(Required)The callback function that will be called if the regex is matched.

$priority

(int)(Optional) Used to specify the order in which the registered handlers will be tested.

Default value: 10


Top ↑

Source

File: wp-includes/embed.php

function wp_embed_register_handler( $id, $regex, $callback, $priority = 10 ) {
	global $wp_embed;
	$wp_embed->register_handler( $id, $regex, $callback, $priority );
}


Top ↑

Changelog

Changelog
VersionDescription
2.9.0Introduced.

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.