is_embed()
Checks whether the request is a request for an embed post page.
Embeds are a short version of the page. For example, if you add /embed to the end of the URL of any post, you will land on the embed page. Here is the embed page for this post: https://wp-kama.com/function/is_embed/embed This conditional tag will work on such a page.
What is Embed read here: oEmbed in WordPress
The URL of the embed page can be obtained using the function get_post_embed_url().
The html code is output using the function get_post_embed_html().
Uses: WP_Query::is_embed()
1 time — 0.000019 sec (very fast) | 50000 times — 0.02 sec (speed of light) | PHP 7.1.2, WP 4.7.3
No Hooks.
Returns
true|false.
Usage
if( is_embed() ){
// request for the embed post page
}
Examples
#1 Add text to the footer on all pages except embeds
add_action( 'wp_footer', 'add_footer_text' );
function add_footer_text() {
// skip the embeds
if ( is_embed() ) {
return;
}
echo 'some text';
}
Notes
- Global. WP_Query. $wp_query WordPress Query object.
Changelog
| Since 4.4.0 | Introduced. |
is_embed() is embed code WP 6.8.3
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();
}