attachment_url_to_postid( string $url ): int

Tries to convert an attachment URL into a post ID.

Contents

Parameters

$url string Required
The URL to resolve.

Top ↑

Return

int The found post ID, or 0 on failure.

Top ↑

Source

File: wp-includes/media.php. View all references 

function attachment_url_to_postid( $url ) {
	global $wpdb;

	$dir  = wp_get_upload_dir();
	$path = $url;

	$site_url   = parse_url( $dir['url'] );
	$image_path = parse_url( $path );

	// Force the protocols to match if needed.
	if ( isset( $image_path['scheme'] ) && ( $image_path['scheme'] !== $site_url['scheme'] ) ) {
		$path = str_replace( $image_path['scheme'], $site_url['scheme'], $path );
	}

	if ( str_starts_with( $path, $dir['baseurl'] . '/' ) ) {
		$path = substr( $path, strlen( $dir['baseurl'] . '/' ) );
	}

	$sql = $wpdb->prepare(
		"SELECT post_id, meta_value FROM $wpdb->postmeta WHERE meta_key = '_wp_attached_file' AND meta_value = %s",
		$path
	);

	$results = $wpdb->get_results( $sql );
	$post_id = null;

	if ( $results ) {
		// Use the first available result, but prefer a case-sensitive match, if exists.
		$post_id = reset( $results )->post_id;

		if ( count( $results ) > 1 ) {
			foreach ( $results as $result ) {
				if ( $path === $result->meta_value ) {
					$post_id = $result->post_id;
					break;
				}
			}
		}
	}

	/**
	 * Filters an attachment ID found by URL.
	 *
	 * @since 4.2.0
	 *
	 * @param int|null $post_id The post_id (if any) found by the function.
	 * @param string   $url     The URL being looked up.
	 */
	return (int) apply_filters( 'attachment_url_to_postid', $post_id, $url );
}

View on Trac View on GitHub

Top ↑

Hooks

Top ↑

Top ↑

Changelog

Changelog
Version Description
4.0.0 Introduced.

Top ↑

User Contributed Notes

  2. Skip to note 2 content
    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
    Contributed by Milana Cap —

    Applying WordPress coding standards and best practices, example should look like this, Muhibul.

    $attachment_url     = 'https://example.com/wp-content/uploads/2023/09/image.jpg';
$attachment_post_id = attachment_url_to_postid( esc_url( $attachment_url ) );

if ( 0 !== $attachment_post_id ) {
    // An attachment post or page was found.
    printf( esc_html__( 'Attachment is associated with post ID: %s', 'textdomain'),
        $attachment_post_id
    );
} else {
    // No attachment post or page found for the URL.
    esc_html_e( 'No post or page found for the provided attachment URL.', 'textdomain');
}
  3. Skip to note 3 content
    You must log in to vote on the helpfulness of this noteVote results for this note: -1You must log in to vote on the helpfulness of this note
    Contributed by Muhibul Haque —

    The attachment_url_to_postid() function is a WordPress function used to retrieve the post ID associated with a given attachment URL (usually an image or other media file). This function takes one parameter:

    $url (string): The URL of the attachment you want to find the post ID for.
    The function returns an integer value representing the post ID associated with the provided attachment URL.

    $attachment_url = 'https://example.com/wp-content/uploads/2023/09/image.jpg';
$attachment_post_id = attachment_url_to_postid( $attachment_url );

if ( 0 !== $attachment_post_id ) {
    // An attachment post or page was found.
    echo 'Attachment is associated with post ID: ' . $attachment_post_id;
} else {
    // No attachment post or page found for the URL.
    echo 'No post or page found for the provided attachment URL.';
}

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