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

Registers an embed handler.

Contents

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: 10

Top ↑

Source

File: wp-includes/embed.php. View all references 

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

View on Trac View on GitHub

Top ↑

Top ↑

Changelog

Changelog
Version Description
2.9.0 Introduced.

Top ↑

User Contributed Notes

  1. Skip to note 1 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
    Contributed by Codex —

    Basic Example

    Register an embed handler for Forbes video embeds.

    wp_embed_register_handler(
	'forbes',
	'#http://(?:www|video)\.forbes\.com/(?:video/embed/embed\.html|embedvideo/)\?show=([\d]+)&format=frame&height=([\d]+)&width=([\d]+)&video=(.+?)($|&)#i',
	'wpdocs_embed_handler_forbes'
);

function wpdocs_embed_handler_forbes( $matches, $attr, $url, $rawattr ) {

	$embed = sprintf(
			'<iframe src="http://www.forbes.com/video/embed/embed.html?show=%1$s&format=frame&height=%2$s&width=%3$s&video=%4$s&mode=render&quot; width="%3$spx" height="%2$spx" frameborder="0" scrolling="no" marginwidth="0" marginheight="0"></iframe>',
			esc_attr($matches[1]),
			esc_attr($matches[2]),
			esc_attr($matches[3]),
			esc_attr($matches[4])
			);

	return $embed;
}
  2. Skip to note 2 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
    Contributed by cogdog —

    Here is a means to add oembed support for web-based audio recorders Vocaroo and Sodaphonic. I found the hard way that sprintf fails when you have a “%” in the string

    add_action( 'init', 'cdb_register_embeds' );
function dcb_register_embeds() {
	// handler for vocaroo audio
	wp_embed_register_handler(
		'vocaroo',
		'#^https?://(vocaroo.com|voca.ro)/([a-zAA-Z0-9]+)$#i',
		'cdb_handler_vocaroo'
	);
	
	// handler for sodaphonic boombox audio	
	wp_embed_register_handler(
		'sodaphonic',
		'#^https?://sodaphonic.com/audio/([a-zAA-Z0-9]+)(.*)$#i',
		'cdb_handler_sodaphonic'
	);
}

function cdb_handler_vocaroo( $matches, $attr, $url, $rawattr ) {
$embed = '';
return $embed;
}

function cdb_handler_sodaphonic( $matches, $attr, $url, $rawattr ) {
$embed = '';
	
return $embed;
}
  3. Skip to note 3 content
    You must log in to vote on the helpfulness of this noteVote results for this note: -1You must log in to vote on the helpfulness of this note
    Contributed by Ryan McCue —

    Note that the $regex parameter is checked against the URL, not against the content, so you can anchor the regular expression with ^ and $. This is useful if you want to use an ungreedy match group at the end of your URL:

    wp_embed_register_handler( $id, '#^http://example.com/(\?.+)?$#', __NAMESPACE__ . '\\handle_embed' );

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