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

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$permalinkstringoptional

The permalink used for the url query arg. Default empty.Default: ''

$formatstringoptional

The requested response format. Default 'json'.Default: 'json'

Return value

string

The oEmbed endpoint URL.

Performance profile

How much work a call to get_oembed_endpoint_url() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

15–29

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 30.

Plugin surface

1 hook

Third-party callbacks on 'oembed_endpoint_url' run inside this call, and their cost is not bounded by anything here.

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly

Further down the call graph this can also reach option, cache, serialize, query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 2 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost get_oembed_endpoint_url() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

One hook fires while get_oembed_endpoint_url() runs, in this order:

1. 1
   apply_filters( oembed_endpoint_url )filterline 477 (+22 into the body)

   Filters the oEmbed endpoint URL.

Uses · 3

• rest_url()Retrieves the URL to a REST endpoint.
• add_query_arg()Retrieves a modified URL query string.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 1

• wp_oembed_add_discovery_links()Adds oEmbed discovery links in the head element of the website.

Source code

View on Trac ↗View on GitHub ↗

455function get_oembed_endpoint_url( $permalink = '', $format = 'json' ) {456	$url = rest_url( 'oembed/1.0/embed' );457 458	if ( '' !== $permalink ) {459		$url = add_query_arg(460			array(461				'url'    => urlencode( $permalink ),462				'format' => ( 'json' !== $format ) ? $format : false,463			),464			$url465		);466	}467 468	/**469	 * Filters the oEmbed endpoint URL.470	 *471	 * @since 4.4.0472	 *473	 * @param string $url       The URL to the oEmbed endpoint.474	 * @param string $permalink The permalink used for the `url` query arg.475	 * @param string $format    The requested response format.476	 */477	return apply_filters( 'oembed_endpoint_url', $url, $permalink, $format );478}

Changelog

Introduced in 4.4.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/embed.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.