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

Parameters

$postint|WP_Post|nulloptional

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.

Hooks fired · 1

One hook fires while get_post_embed_url() runs, in this order:

1. 1
   apply_filters( post_embed_url )filterline 441 (+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

View on Trac ↗View on GitHub ↗

419function get_post_embed_url( $post = null ) {420	$post = get_post( $post );421 422	if ( ! $post ) {423		return false;424	}425 426	$embed_url     = trailingslashit( get_permalink( $post ) ) . user_trailingslashit( 'embed' );427	$path_conflict = get_page_by_path( str_replace( home_url(), '', $embed_url ), OBJECT, get_post_types( array( 'public' => true ) ) );428 429	if ( ! get_option( 'permalink_structure' ) || $path_conflict ) {430		$embed_url = add_query_arg( array( 'embed' => 'true' ), get_permalink( $post ) );431	}432 433	/**434	 * Filters the URL to embed a specific post.435	 *436	 * @since 4.4.0437	 *438	 * @param string  $embed_url The post embed URL.439	 * @param WP_Post $post      The corresponding post object.440	 */441	return sanitize_url( apply_filters( 'post_embed_url', $embed_url, $post ) );442}

History

Introduced in 4.4.0. One change between 6.7.7 and 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 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.