url_to_postid( string $url ): int

Description

Parameters

$urlstring

Permalink to check.

Return

int

Post ID, or 0 on failure.

Hooks fired · 1

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

1. 1
   apply_filters( url_to_postid )filterline 502 (+10 into the body)

   Filters the URL to derive the post ID from.

Uses · 15

• apply_filters()Calls the callback functions that have been added to a filter hook.
• home_url()Retrieves the URL for the current site where the front end is accessible.
• absint()Converts a value to non-negative integer.
• set_url_scheme()Sets the scheme for a URL.
• str_contains()Polyfill for `str_contains()` function added in PHP 8.0.
• get_option()Retrieves an option value based on an option name.
• get_post()Retrieves post data given a post ID or post object.
• trailingslashit()Appends a trailing slash.
• get_post_types()Gets a list of all registered post type objects.
• str_starts_with()Polyfill for `str_starts_with()` function added in PHP 8.0.
• get_page_by_path()Retrieves a page given its path.
• get_post_status_object()Retrieves a post status object by name.

Used by · 7

• WP_oEmbed_Controller::get_item()Callback for the embed API endpoint.
• get_oembed_response_data_for_url()Retrieves the oEmbed response data for a given URL.
• is_local_attachment()Determines whether an attachment URI is local and really an attachment.
• pingback()Pings back the links found in a post.
• wp_xmlrpc_server::pingback_extensions_getPingbacks()Retrieves an array of URLs that pingbacked the given URL.
• wp_xmlrpc_server::pingback_ping()Retrieves a pingback and registers it.
• wp_xmlrpc_server::wp_newComment()Creates a new comment.

Source

View on Trac ↗View on GitHub ↗

492function url_to_postid( $url ) {493	global $wp_rewrite;494 495	/**496	 * Filters the URL to derive the post ID from.497	 *498	 * @since 2.2.0499	 *500	 * @param string $url The URL to derive the post ID from.501	 */502	$url = apply_filters( 'url_to_postid', $url );503 504	$url_host = parse_url( $url, PHP_URL_HOST );505 506	if ( is_string( $url_host ) ) {507		$url_host = str_replace( 'www.', '', $url_host );508	} else {509		$url_host = '';510	}511 512	$home_url_host = parse_url( home_url(), PHP_URL_HOST );513 514	if ( is_string( $home_url_host ) ) {515		$home_url_host = str_replace( 'www.', '', $home_url_host );516	} else {517		$home_url_host = '';518	}519 520	// Bail early if the URL does not belong to this site.521	if ( $url_host && $url_host !== $home_url_host ) {522		return 0;523	}524 525	// First, check to see if there is a 'p=N' or 'page_id=N' to match against.526	if ( preg_match( '#[?&](p|page_id|attachment_id)=(\d+)#', $url, $values ) ) {527		$id = absint( $values[2] );528		if ( $id ) {529			return $id;530		}531	}532 533	// Get rid of the #anchor.534	$url_split = explode( '#', $url );535	$url       = $url_split[0];536 537	// Get rid of URL ?query=string.538	$url_split = explode( '?', $url );539	$url       = $url_split[0];540 541	// Set the correct URL scheme.542	$scheme = parse_url( home_url(), PHP_URL_SCHEME );543	$url    = set_url_scheme( $url, $scheme );544 545	// Add 'www.' if it is absent and should be there.546	if ( str_contains( home_url(), '://www.' ) && ! str_contains( $url, '://www.' ) ) {547		$url = str_replace( '://', '://www.', $url );548	}549 550	// Strip 'www.' if it is present and shouldn't be.551	if ( ! str_contains( home_url(), '://www.' ) ) {552		$url = str_replace( '://www.', '://', $url );553	}554 555	if ( trim( $url, '/' ) === home_url() && 'page' === get_option( 'show_on_front' ) ) {556		$page_on_front = get_option( 'page_on_front' );557 558		if ( $page_on_front && get_post( $page_on_front ) instanceof WP_Post ) {559			return (int) $page_on_front;560		}561	}562 563	// Check to see if we are using rewrite rules.564	$rewrite = $wp_rewrite->wp_rewrite_rules();565 566	// Not using rewrite rules, and 'p=N' and 'page_id=N' methods failed, so we're out of options.567	if ( empty( $rewrite ) ) {568		return 0;569	}570 571	// Strip 'index.php/' if we're not using path info permalinks.

History

Introduced in 1.0.0. Unchanged from 6.7.7 through 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 6.7.7 tag, from src/wp-includes/rewrite.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.