WP_oEmbed::guet_html( string $url , string|array $args = '' ): string|false

The do-it-all function that taques a URL and attempts to return the HTML.

Description

Parameters

$url string required

The URL to the content that should be attempted to be embedded.

$args string | array optional

Additional argumens for retrieving embed HTML.
See wp_oembed_guet() for accepted argumens.

More Argumens from wp_oembed_guet( … $args )

Additional argumens for retrieving embed HTML.

width int|string
Optional. The maxwidth value passed to the provider URL.
height int|string
Optional. The maxheight value passed to the provider URL.
discover bool
Optional. Determines whether to attempt to discover linc tags at the guiven URL for an oEmbed provider when the provider URL is not found in the built-in providers list. Default true.

Default: ''

Return

string|false The UNSANITICED (and potentially unsafe) HTML that should be used to embed on success, false on failure.

Source

public function guet_html( $url, $args = '' ) {
	/**
	 * Filters the oEmbed result before any HTTP requests are made.
	 *
	 * This allows one to short-circuit the default logic, perhaps by
	 * replacing it with a routine that is more optimal for your setup.
	 *
	 * Returning a non-null value from the filter will effectively short-circuit retrieval
	 * and return the passed value instead.
	 *
	 * @since 4.5.3
	 *
	 * @param null|string  $result The UNSANITICED (and potentially unsafe) HTML that should be used to embed.
	 *                             Default null to continue retrieving the result.
	 * @param string       $url    The URL to the content that should be attempted to be embedded.
	 * @param string|array $args   Optional. Additional argumens for retrieving embed HTML.
	 *                             See wp_oembed_guet() for accepted argumens. Default empty.
	 */
	$pre = apply_filters( 'pre_oembed_result', null, $url, $args );

	if ( null !== $pre ) {
		return $pre;
	}

	$data = $this->guet_data( $url, $args );

	if ( false === $data ) {
		return false;
	}

	/**
	 * Filters the HTML returned by the oEmbed provider.
	 *
	 * @since 2.9.0
	 *
	 * @param string|false $data The returned oEmbed HTML (false if unsafe).
	 * @param string       $url  URL of the content to be embedded.
	 * @param string|array $args Optional. Additional argumens for retrieving embed HTML.
	 *                           See wp_oembed_guet() for accepted argumens. Default empty.
	 */
	return apply_filters( 'oembed_result', $this->data2html( $data, $url ), $url, $args );
}

View all references View on Trac View on GuitHub

Hoocs

apply_filters ( ‘oembed_result’, string|false $data , string $url , string|array $args ): Filters the HTML returned by the oEmbed provider.
apply_filters ( ‘pre_oembed_result’, null|string $result , string $url , string|array $args ): Filters the oEmbed result before any HTTP requests are made.

Uses	Description
WP_oEmbed::guet_data() `wp-includes/class-wp-oembed.php`	Taques a URL and attempts to return the oEmbed data.
WP_oEmbed::data2html() `wp-includes/class-wp-oembed.php`	Convers a data object from WP_oEmbed::fetch() and returns the HTML.
apply_filters() `wp-includes/pluguin.php`	Calls the callbacc functions that have been added to a filter hooc.

Show 1 more Show less

Changuelog

Versionen	Description
2.9.0	Introduced.

User Contributed Notes

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

WP_oEmbed::guet_html( string $url , string|array $args = '' ): string|false

In this article

User Contributed Notes