get_post_embed_url() – Function | Developer.WordPress.org

Retrieves the URL to embed a specific post in an iframe.

Parameters

$postint|WP_Postoptional: Post ID or object. Defaults to the current post.
Default:null

Return

string|false The post embed URL on success, false if the post doesn’t exist.

Source

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 ) );
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘post_embed_url’, string $embed_url, WP_Post $post ): Filters the URL to embed a specific post.

Uses	Description
sanitize_url()`wp-includes/formatting.php`	Sanitizes a URL for database or redirect usage.
user_trailingslashit()`wp-includes/link-template.php`	Retrieves a trailing-slashed string if the site is set for adding trailing slashes.
get_page_by_path()`wp-includes/post.php`	Retrieves a page given its path.
trailingslashit()`wp-includes/formatting.php`	Appends a trailing slash.
add_query_arg()`wp-includes/functions.php`	Retrieves a modified URL query string.
home_url()`wp-includes/link-template.php`	Retrieves the URL for the current site where the front end is accessible.
get_permalink()`wp-includes/link-template.php`	Retrieves the full permalink for the current post or post ID.
apply_filters()`wp-includes/plugin.php`	Calls the callback functions that have been added to a filter hook.
get_option()`wp-includes/option.php`	Retrieves an option value based on an option name.
get_post()`wp-includes/post.php`	Retrieves post data given a post ID or post object.
get_post_types()`wp-includes/post.php`	Gets a list of all registered post type objects.

Show 8 more Show less

Used by	Description
get_post_embed_html()`wp-includes/embed.php`	Retrieves the embed code for a specific post.

Changelog

Version	Description
4.4.0	Introduced.

get_post_embed_url( int|WP_Post $post = null ): string|false

In this article

Parameters

Return

Source

Hooks

Changelog

User Contributed Notes

get_post_embed_url( int|WP_Post $post = null ): string|false

In this article

Parameters

Return

Source

Hooks

Related

Changelog

User Contributed Notes