close
WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

is_post_embeddable()

is_post_embeddable( int|WP_Post|null $post = null ): bool

In this article

Back to top

Determines whether a post is embeddable.

Parameters

$postint|WP_Post|nulloptional
Post ID or WP_Post object. Defaults to global $post.

Default:null

Return

bool Whether the post should be considered embeddable.

Source

function is_post_embeddable( $post = null ) {
	$post = get_post( $post );

	if ( ! $post ) {
		return false;
	}

	$post_type = get_post_type_object( $post->post_type );

	if ( ! $post_type ) {
		return false;
	}

	$is_embeddable = $post_type->embeddable;

	/**
	 * Filter whether a post is embeddable.
	 *
	 * @since 6.8.0
	 *
	 * @param bool    $is_embeddable Whether the post is embeddable.
	 * @param WP_Post $post          Post object.
	 */
	return apply_filters( 'is_post_embeddable', $is_embeddable, $post );
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘is_post_embeddable’, bool $is_embeddable, WP_Post $post )

Filter whether a post is embeddable.

UsesDescription
apply_filters()wp-includes/plugin.php

Calls the callback functions that have been added to a filter hook.

get_post()wp-includes/post.php

Retrieves post data given a post ID or post object.

get_post_type_object()wp-includes/post.php

Retrieves a post type object by name.

Show 1 moreShow less
Used byDescription
wp_oembed_add_discovery_links()wp-includes/embed.php

Adds oEmbed discovery links in the head element of the website.

get_oembed_response_data()wp-includes/embed.php

Retrieves the oEmbed response data for a given post.

Changelog

VersionDescription
6.8.0Introduced.

User Contributed Notes

  1. Skip to note 2 content
    Md Abul Bashar
    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note

    is_post_embeddable() checks whether a post is publicly viewable and of an embeddable post type. This is commonly used in oEmbed handlers and custom preview generators to ensure a post can be safely embedded before outputting embed HTML.

    Example: Only show embed link if the post is embeddable

    $post_id = get_the_ID();
if ( is_post_embeddable( $post_id ) ) {
    echo '<a href="' . esc_url( get_permalink( $post_id ) ) . '">' .
         esc_html__( 'Embed this post', 'your-textdomain' ) .
         '</a>';
} else {
    echo esc_html__( 'Embedding not allowed for this post.', 'your-textdomain' );
}

    This function helps prevent attempting to embed protected, private, or unsupported post types. It’s particularly useful in custom oEmbed endpoints or when building embed previews manually.

You must log in before being able to contribute a note or feedback.