get_oembed_endpoint_url( string $permalink = '', string $format = 'json' )

Retrieves the oEmbed endpoint URL for a given permalink.


Description Description

Pass an empty string as the first argument to get the endpoint base URL.


Parameters Parameters

$permalink

(string) (Optional) The permalink used for the url query arg.

Default value: ''

$format

(string) (Optional) The requested response format.

Default value: 'json'


Top ↑

Return Return

(string) The oEmbed endpoint URL.


Top ↑

Source Source

File: wp-includes/embed.php

function get_oembed_endpoint_url( $permalink = '', $format = 'json' ) {
	$url = rest_url( 'oembed/1.0/embed' );

	if ( '' !== $permalink ) {
		$url = add_query_arg( array(
			'url'    => urlencode( $permalink ),
			'format' => ( 'json' !== $format ) ? $format : false,
		), $url );
	}

	/**
	 * Filters the oEmbed endpoint URL.
	 *
	 * @since 4.4.0
	 *
	 * @param string $url       The URL to the oEmbed endpoint.
	 * @param string $permalink The permalink used for the `url` query arg.
	 * @param string $format    The requested response format.
	 */
	return apply_filters( 'oembed_endpoint_url', $url, $permalink, $format );
}

Top ↑

Changelog Changelog

Changelog
Version Description
4.4.0 Introduced.


Top ↑

User Contributed Notes User Contributed Notes

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