WP_oEmbed::_fetch_with_format( string $provider_url_with_args, string $format ): object|false|WP_Error

Compatibility

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

Parameters

$provider_url_with_argsstring

URL to the provider with full arguments list (url, maxheight, etc.)

$formatstring

Format to use.

Return value

object|false|WP_Error

The result in the form of an object on success, false on failure.

Performance profile

How much work a call to WP_oEmbed::_fetch_with_format() 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

Expensive

Reaches an outbound HTTP request via wp_safe_remote_get().

Scaling

Constant

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

Instructions

28–34

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

Plugin surface

1 hook

Third-party callbacks on 'oembed_remote_get_args' 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
• httpoutbound HTTP requestwp_safe_remote_get()called directly

What one call costs · 3 distinct outcomes

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

Hooks and filters fired · 1

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

1. 1
   apply_filters( oembed_remote_get_args )filterline 578 (+4 into the body)

   Filters oEmbed remote get arguments.

Uses · 7

• add_query_arg()Retrieves a modified URL query string.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• wp_safe_remote_get()Retrieves the raw response from a safe HTTP request using the GET method.
• wp_remote_retrieve_response_code()Retrieves only the response code from the raw response.
• wp_remote_retrieve_body()Retrieves only the body from the raw response.
• WP_Error::__construct()Initializes the error.
• WP_oEmbed::[object Object]()

Used by · 1

• WP_oEmbed::fetch()Connects to an oEmbed provider and returns the result.

Source code

View on Trac ↗View on GitHub ↗

574	private function _fetch_with_format( $provider_url_with_args, $format ) {575		$provider_url_with_args = add_query_arg( 'format', $format, $provider_url_with_args );576 577		/** This filter is documented in wp-includes/class-wp-oembed.php */578		$args = apply_filters( 'oembed_remote_get_args', array(), $provider_url_with_args );579 580		$response = wp_safe_remote_get( $provider_url_with_args, $args );581 582		if ( 501 === wp_remote_retrieve_response_code( $response ) ) {583			return new WP_Error( 'not-implemented' );584		}585 586		$body = wp_remote_retrieve_body( $response );587		if ( ! $body ) {588			return false;589		}590 591		$parse_method = "_parse_$format";592 593		return $this->$parse_method( $body );594	}

Changelog

Introduced in 3.0.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 6.7.7 tag, from src/wp-includes/class-wp-oembed.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.