WP_Embed::shortcode( array $attr, string $url = '' ): string|false

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

$attrarray

Shortcode attributes. Optional.

• $widthint

  Width of the embed in pixels.

• $heightint

  Height of the embed in pixels.

$urlstringoptional

The URL attempting to be embedded.Default: ''

Return value

string|false

The embed HTML on success, otherwise the original URL.
->maybe_make_link() can return false on failure.

Performance profile

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

Heavy

Reaches the database via get_post().

Scaling

Constant

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

Instructions

14–145

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

Plugin surface

3 hooks

Third-party callbacks on 'oembed_ttl', 'embed_oembed_html', 'embed_oembed_discover' 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

• querycontent queryget_post()called directly
• hookthird-party callbacksapply_filters()called directly
• serializeserialisationserialize()called directly
• optionoption read or writeget_option()one call below WP_Embed::shortcode()

Further down the call graph this can also reach cache 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 · 122 distinct outcomes

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

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Hooks and filters fired · 4

4 hooks fire while WP_Embed::shortcode() runs, in this order:

1. 1
   apply_filters( oembed_ttl )filterline 249 (+53 into the body)

   Filters the oEmbed TTL value (time to live).

2. 2
   apply_filters( embed_oembed_html )filterline 291 (+95 into the body)

   Filters the cached oEmbed HTML.

3. 3
   apply_filters( embed_oembed_discover )filterline 305 (+109 into the body)

   Filters whether to inspect the given URL for discoverable link tags.

4. 4
   apply_filters( embed_oembed_html )filterline 374 (+178 into the body)

   Filters the cached oEmbed HTML.

Uses · 16

• get_post()Retrieves post data given a post ID or post object.
• wp_parse_args()Merges user defined arguments into defaults array.
• wp_embed_defaults()Creates default array of embed parameters.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• get_post_meta()Retrieves a post meta field for the given post ID.
• wp_oembed_get()Attempts to fetch the embed HTML for a provided URL using oEmbed.
• update_post_meta()Updates a post meta field based on the given post ID.
• has_filter()Checks if any filter has been registered for a hook.
• kses_remove_filters()Removes all KSES input form content filters.
• wp_update_post()Updates a post with new post data.
• wp_slash()Adds slashes to a string or recursively adds slashes to strings within an array.
• wp_insert_post()Inserts or update a post.

Used by · 1

• WP_Embed::autoembed_callback()Callback function for WP_Embed::autoembed().

Source code

View on Trac ↗View on GitHub ↗

196	public function shortcode( $attr, $url = '' ) {197		$post = get_post();198 199		if ( empty( $url ) && ! empty( $attr['src'] ) ) {200			$url = $attr['src'];201		}202 203		$this->last_url = $url;204 205		if ( empty( $url ) ) {206			$this->last_attr = $attr;207			return '';208		}209 210		$rawattr = $attr;211		$attr    = wp_parse_args( $attr, wp_embed_defaults( $url ) );212 213		$this->last_attr = $attr;214 215		/*216		 * KSES converts & into &amp; and we need to undo this.217		 * See https://core.trac.wordpress.org/ticket/11311218		 */219		$url = str_replace( '&amp;', '&', $url );220 221		// Look for known internal handlers.222		$embed_handler_html = $this->get_embed_handler_html( $rawattr, $url );223		if ( false !== $embed_handler_html ) {224			return $embed_handler_html;225		}226 227		$post_id = ( ! empty( $post->ID ) ) ? $post->ID : null;228 229		// Potentially set by WP_Embed::cache_oembed().230		if ( ! empty( $this->post_ID ) ) {231			$post_id = $this->post_ID;232		}233 234		// Check for a cached result (stored as custom post or in the post meta).235		$key_suffix    = md5( $url . serialize( $attr ) );236		$cachekey      = '_oembed_' . $key_suffix;237		$cachekey_time = '_oembed_time_' . $key_suffix;238 239		/**240		 * Filters the oEmbed TTL value (time to live).241		 *242		 * @since 4.0.0243		 *244		 * @param int    $time    Time to live (in seconds).245		 * @param string $url     The attempted embed URL.246		 * @param array  $attr    An array of shortcode attributes.247		 * @param int    $post_id Post ID.248		 */249		$ttl = apply_filters( 'oembed_ttl', DAY_IN_SECONDS, $url, $attr, $post_id );250 251		$cache      = '';252		$cache_time = 0;253 254		$cached_post_id = $this->find_oembed_post_id( $key_suffix );255 256		if ( $post_id ) {257			$cache      = get_post_meta( $post_id, $cachekey, true );258			$cache_time = get_post_meta( $post_id, $cachekey_time, true );259 260			if ( ! $cache_time ) {261				$cache_time = 0;262			}263		} elseif ( $cached_post_id ) {264			$cached_post = get_post( $cached_post_id );265 266			$cache      = $cached_post->post_content;267			$cache_time = strtotime( $cached_post->post_modified_gmt );268		}269 270		$cached_recently = ( time() - $cache_time ) < $ttl;271 272		if ( $this->usecache || $cached_recently ) {273			// Failures are cached. Serve one if we're using the cache.274			if ( '{{unknown}}' === $cache ) {275				return $this->maybe_make_link( $url );

Changelog

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-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.