is_embed(): bool
- Since
- 4.4.0
- Source
wp-includes/query.php:878
Return
bool- Whether the query is for an embedded post.
Cost profile
Measured from the compiled opcodes, not from a stopwatch. Every number here is identical on any machine that runs the same PHP version, and every function in core is ranked by these figures.
- Cost class
- Trivial
- Scaling
- Constant
- Instructions
- 6–12
- Plugin surface
- None
- Called by
- 4
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.4, depending on the branch taken. The body compiles to 15.
Nothing here hands control to plugin code.
4 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
do_action()one call below is_embed()
Further down the call graph this can also reach query, option, 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 is_embed() can have, taken from its control-flow graph on PHP 8.4.
| When | Instructions | Calls it makes |
|---|---|---|
isset($wp_query) | 6 | ->is_embed() |
!isset($wp_query) | 12 | __()_doing_it_wrong() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
7.4 | 15 | 6–12 | 1 | Compiles to the same instructions |
8.1 | 15 | 6–12 | 1 | Compiles to the same instructions |
8.2 | 15 | 6–12 | 1 | Compiles to the same instructions |
8.3 | 15 | 6–12 | 1 | Compiles to the same instructions |
8.4 | 15 | 6–12 | 1 | Compiles to the same instructions |
Oldest PHP that compiles this body: 7.4. An instruction is not a fixed amount of time, so a version with the same count is not necessarily the same speed; what the count rules out is a difference in the work itself.
Uses · 2
- _doing_it_wrong()Marks something as being incorrectly called.
- __()Retrieves the translation of $text.
Used by · 4
- is_admin_bar_showing()Determines whether the admin bar should be showing.
- wp_embed_excerpt_more()Filters the string in the 'more' link displayed after a trimmed excerpt.
- wp_old_slug_redirect()Redirect old slugs to the correct permalink.
- wp_robots_noindex_embeds()Adds `noindex` to the robots meta tag for embeds.
Source
function is_embed() { global $wp_query; if ( ! isset( $wp_query ) ) { _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1.0' ); return false; } return $wp_query->is_embed();}History
Introduced in 4.4.0. Unchanged from 6.7.7 through 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/query.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.