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

In this article

This function’s access is marked private. This means it is not intended for use by plugin or theme developers, only in other core functions. It is listed here for completeness.

Fetches result from an oEmbed provider for a specific format and complete provider URL

Parameters

$provider_url_with_argsstringrequired
URL to the provider with full arguments list (url, maxheight, etc.)
$formatstringrequired
Format to use.

Return

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

Source

private function _fetch_with_format( $provider_url_with_args, $format ) {
	$provider_url_with_args = add_query_arg( 'format', $format, $provider_url_with_args );

	/** This filter is documented in wp-includes/class-wp-oembed.php */
	$args = apply_filters( 'oembed_remote_get_args', array(), $provider_url_with_args );

	$response = wp_safe_remote_get( $provider_url_with_args, $args );

	if ( 501 === wp_remote_retrieve_response_code( $response ) ) {
		return new WP_Error( 'not-implemented' );
	}

	$body = wp_remote_retrieve_body( $response );
	if ( ! $body ) {
		return false;
	}

	$parse_method = "_parse_$format";

	return $this->$parse_method( $body );
}

Hooks

apply_filters( ‘oembed_remote_get_args’, array $args, string $url )

Filters oEmbed remote get arguments.

Changelog

VersionDescription
3.0.0Introduced.

User Contributed Notes

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