WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

wp_oembed_add_provider()

wp_oembed_add_provider( string $format, string $provider, bool $regex = false )

In this article

Back to top

Adds a URL format and oEmbed provider URL pair.

Description

See also

Parameters

$formatstringrequired
The format of URL that this provider can handle. You can use asterisks as wildcards.
$providerstringrequired
The URL to the oEmbed provider.
$regexbooloptional
Whether the $format parameter is in a RegEx format.

Default:false

Source

function wp_oembed_add_provider( $format, $provider, $regex = false ) {
	if ( did_action( 'plugins_loaded' ) ) {
		$oembed                       = _wp_oembed_get_object();
		$oembed->providers[ $format ] = array( $provider, $regex );
	} else {
		WP_oEmbed::_add_provider_early( $format, $provider, $regex );
	}
}

View all references View on Trac View on GitHub

UsesDescription
WP_oEmbed::_add_provider_early()wp-includes/class-wp-oembed.php

Adds an oEmbed provider.

_wp_oembed_get_object()wp-includes/embed.php

Returns the initialized WP_oEmbed object.

did_action()wp-includes/plugin.php

Retrieves the number of times an action has been fired during the current request.

Changelog

VersionDescription
2.9.0Introduced.

User Contributed Notes

  1. Skip to note 3 content
    Codex
    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

    Basic Example
    Register a provider for any URL beginning in http://site.com/watchvideo/ using a simple wildcard URL format:

    <?php wp_oembed_add_provider( 'http://site.com/watchvideo/*', 'http://site.com/oembedprovider' ); ?>

    Note: Do not leave empty space, neither before nor after

  2. Skip to note 4 content
    Codex
    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

    YouTube
    Register YouTube’s oEmbed provider for YouTube URLs using a regex URL format:

    <?php wp_oembed_add_provider( '#http://(www\.)?youtube\.com/watch.*#i', 'http://www.youtube.com/oembed', true ); ?>

    Note: YouTube is already registered by default with WordPress. This is merely an example, you do not need to register YouTube yourself.

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