wp_embed_defaults( string $url = '' ): int[]

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

$urlstringoptional

The URL that should be embedded. Default empty.Default: ''

Return value

int[]

Indexed array of the embed width and height in pixels.

• $0int

  The embed width.

• $1int

  The embed height.

Performance profile

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

22–26

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

Plugin surface

1 hook

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

Called by

3

3 places 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

What one call costs · 1 distinct outcome

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

Hooks and filters fired · 1

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

1. 1
   apply_filters( embed_defaults )filterline 91 (+24 into the body)

   Filters the default array of embed dimensions.

Uses · 1

• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 3

• WP_Embed::get_embed_handler_html()Returns embed HTML for a given URL from embed handlers.
• WP_Embed::shortcode()The do_shortcode() callback function.
• WP_oEmbed::fetch()Connects to an oEmbed provider and returns the result.

Source code

View on Trac ↗View on GitHub ↗

67function wp_embed_defaults( $url = '' ) {68	if ( ! empty( $GLOBALS['content_width'] ) ) {69		$width = (int) $GLOBALS['content_width'];70	}71 72	if ( empty( $width ) ) {73		$width = 500;74	}75 76	$height = min( (int) ceil( $width * 1.5 ), 1000 );77 78	/**79	 * Filters the default array of embed dimensions.80	 *81	 * @since 2.9.082	 *83	 * @param int[]  $size {84	 *     Indexed array of the embed width and height in pixels.85	 *86	 *     @type int $0 The embed width.87	 *     @type int $1 The embed height.88	 * }89	 * @param string $url  The URL that should be embedded.90	 */91	return apply_filters( 'embed_defaults', compact( 'width', 'height' ), $url );92}

Changelog

Introduced in 2.9.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.0.4 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.