get_post_embed_url( int|WP_Post $post = null ): string|false
- Since
- 4.4.0
- Source
wp-includes/embed.php:407
Compatibility
- WordPress
- since 4.4.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$postint|WP_Postoptional- Post ID or object. Defaults to the current post.Default:
null
Return value
string|false- The post embed URL on success, false if the post doesn't exist.
Performance profile
How much work a call to get_post_embed_url() 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
- Scaling
- Constant
- Instructions
- 7–52
- Plugin surface
- 1 hook
- Called by
- 1
Reaches the database via get_post().
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 53.
Third-party callbacks on 'post_embed_url' run inside this call, and their cost is not bounded by anything here.
1 place in core call this, so the cost is paid more often than your own code shows.
What it touches
- querycontent query
get_post()called directly - optionoption read or write
get_option()called directly - hookthird-party callbacks
apply_filters()called directly - cacheobject cache
wp_cache_get_last_changed()one call below get_post_embed_url() - serializeserialisation
maybe_unserialize()one call below get_post_embed_url()
Further down the call graph this can also reach transient. That is the worst case, several calls deep and usually down an error path, not what a normal call pays.
What one call costs · 3 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost get_post_embed_url() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 7 | get_post() |
get_option() | 44 | get_post(), get_permalink(), trailingslashit(), user_trailingslashit(), home_url(), get_post_types(), get_page_by_path(), get_option(), apply_filters(), sanitize_url() |
| always | 51–52 | get_post(), get_permalink(), trailingslashit(), user_trailingslashit(), home_url(), get_post_types(), get_page_by_path(), get_option(), get_permalink(), add_query_arg(), apply_filters(), sanitize_url() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 53 | 7–52 | 3 | |
| 8.5 | 53 | 7–52 | 3 | |
| 8.4 | 53 | 7–52 | 3 | 3 fewer instructions than PHP 8.3 |
| 8.3 | 56 | 7–55 | 3 | |
| 8.2 | 56 | 7–55 | 3 | |
| 8.1 | 56 | 7–55 | 3 | |
| 7.4 | 56 | 7–55 | 3 |
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Hooks and filters fired · 1
One hook fires while get_post_embed_url() runs, in this order:
- apply_filters( post_embed_url )filterline 429 (+22 into the body)
Filters the URL to embed a specific post.
Uses · 11
- get_post()Retrieves post data given a post ID or post object.
- trailingslashit()Appends a trailing slash.
- get_permalink()Retrieves the full permalink for the current post or post ID.
- user_trailingslashit()Retrieves a trailing-slashed string if the site is set for adding trailing slashes.
- get_page_by_path()Retrieves a page given its path.
- home_url()Retrieves the URL for the current site where the front end is accessible.
- get_post_types()Gets a list of all registered post type objects.
- get_option()Retrieves an option value based on an option name.
- add_query_arg()Retrieves a modified URL query string.
- sanitize_url()Sanitizes a URL for database or redirect usage.
- apply_filters()Calls the callback functions that have been added to a filter hook.
Used by · 1
- get_post_embed_html()Retrieves the embed code for a specific post.
Source code
function get_post_embed_url( $post = null ) { $post = get_post( $post ); if ( ! $post ) { return false; } $embed_url = trailingslashit( get_permalink( $post ) ) . user_trailingslashit( 'embed' ); $path_conflict = get_page_by_path( str_replace( home_url(), '', $embed_url ), OBJECT, get_post_types( array( 'public' => true ) ) ); if ( ! get_option( 'permalink_structure' ) || $path_conflict ) { $embed_url = add_query_arg( array( 'embed' => 'true' ), get_permalink( $post ) ); } /** * Filters the URL to embed a specific post. * * @since 4.4.0 * * @param string $embed_url The post embed URL. * @param WP_Post $post The corresponding post object. */ return sanitize_url( apply_filters( 'post_embed_url', $embed_url, $post ) );}Changelog
Introduced in 4.4.0. One change between 6.7.7 and 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
$post retyped from int|WP_Post to int|WP_Post|null.verified against sourceAbout this page
- Parsed data
- Generated from the wordpress-develop 6.7.7 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.