get_post_embed_html( int $width, int $height, int|WP_Post $post = null ): string|false

Compatibility

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

Parameters

$widthint

The width for the response.

$heightint

The height for the response.

$postint|WP_Postoptional

Post ID or object. Default is global $post.Default: null

Return value

string|false

Embed code on success, false if post doesn't exist.

Performance profile

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

Reads or writes the filesystem via file_get_contents().

Scaling

Constant

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

Instructions

9–99

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

Plugin surface

1 hook

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

Called by

2

2 places 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
• filesystemfilesystem accessfile_get_contents()called directly
• optionoption read or writeget_option()one call below get_post_embed_html()

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

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

Hooks and filters fired · 1

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

1. 1
   apply_filters( embed_html )filterline 535 (+56 into the body)

   Filters the embed HTML output for a given post.

Uses · 13

• get_post()Retrieves post data given a post ID or post object.
• get_post_embed_url()Retrieves the URL to embed a specific post in an iframe.
• wp_generate_password()Generates a random password drawn from the defined set of characters.
• esc_attr()Escaping for HTML attributes.
• esc_url()Checks and cleans a URL.
• get_permalink()Retrieves the full permalink for the current post or post ID.
• get_the_title()Retrieves the post title.
• absint()Converts a value to non-negative integer.
• __()Retrieves the translation of $text.
• get_bloginfo()Retrieves information about the current site.
• wp_get_inline_script_tag()Constructs an inline script tag.
• wp_scripts_get_suffix()Returns the suffix that can be used for the scripts.

Used by · 2

• get_oembed_response_data_rich()Filters the oEmbed response data to return an iframe embed code.
• print_embed_sharing_dialog()Prints the necessary markup for the embed sharing dialog.

Source code

View on Trac ↗View on GitHub ↗

479function get_post_embed_html( $width, $height, $post = null ) {480	$post = get_post( $post );481 482	if ( ! $post ) {483		return false;484	}485 486	$embed_url = get_post_embed_url( $post );487 488	$secret     = wp_generate_password( 10, false );489	$embed_url .= "#?secret={$secret}";490 491	$output = sprintf(492		'<blockquote class="wp-embedded-content" data-secret="%1$s"><a href="%2$s">%3$s</a></blockquote>',493		esc_attr( $secret ),494		esc_url( get_permalink( $post ) ),495		get_the_title( $post )496	);497 498	$output .= sprintf(499		'<iframe sandbox="allow-scripts" security="restricted" src="%1$s" width="%2$d" height="%3$d" title="%4$s" data-secret="%5$s" frameborder="0" marginwidth="0" marginheight="0" scrolling="no" class="wp-embedded-content"></iframe>',500		esc_url( $embed_url ),501		absint( $width ),502		absint( $height ),503		esc_attr(504			sprintf(505				/* translators: 1: Post title, 2: Site title. */506				__( '&#8220;%1$s&#8221; &#8212; %2$s' ),507				get_the_title( $post ),508				get_bloginfo( 'name' )509			)510		),511		esc_attr( $secret )512	);513 514	/*515	 * Note that the script must be placed after the <blockquote> and <iframe> due to a regexp parsing issue in516	 * `wp_filter_oembed_result()`. Because of the regex pattern starts with `|(<blockquote>.*?</blockquote>)?.*|`517	 * wherein the <blockquote> is marked as being optional, if it is not at the beginning of the string then the group518	 * will fail to match and everything will be matched by `.*` and not included in the group. This regex issue goes519	 * back to WordPress 4.4, so in order to not break older installs this script must come at the end.520	 */521	$output .= wp_get_inline_script_tag(522		file_get_contents( ABSPATH . WPINC . '/js/wp-embed' . wp_scripts_get_suffix() . '.js' )523	);524 525	/**526	 * Filters the embed HTML output for a given post.527	 *528	 * @since 4.4.0529	 *530	 * @param string  $output The default iframe tag to display embedded content.531	 * @param WP_Post $post   Current post object.532	 * @param int     $width  Width of the response.533	 * @param int     $height Height of the response.534	 */535	return apply_filters( 'embed_html', $output, $post, $width, $height );536}

Changelog

Introduced in 4.4.0. One change between 6.7.7 and 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.8.8 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.