wp_image_file_matches_image_meta( string $image_location, array $image_meta, int $attachment_id = 0 ): bool

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$image_locationstring

The full path or URI to the image file.

$image_metaarray

The attachment meta data as returned by 'wp_get_attachment_metadata()'.

$attachment_idintoptional

The image attachment ID. Default 0.Default: 0

Return value

bool

Whether the image meta is for this image file.

Performance profile

How much work a call to wp_image_file_matches_image_meta() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

14–81

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 83.

Plugin surface

1 hook

Third-party callbacks on 'wp_image_file_matches_image_meta' run inside this call, and their cost is not bounded by anything here.

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly

What one call costs · 8 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_image_file_matches_image_meta() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

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

1. 1
   apply_filters( wp_image_file_matches_image_meta )filterline 1701 (+51 into the body)

   Filters whether an image path or URI matches image meta.

Uses · 3

• _wp_get_attachment_relative_path()Gets the attachment path relative to the upload directory.
• trailingslashit()Appends a trailing slash.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 1

• WP_REST_Attachments_Controller::edit_media_item()Applies edits to a media item and creates a new attachment record.

Source code

View on Trac ↗View on GitHub ↗

1650function wp_image_file_matches_image_meta( $image_location, $image_meta, $attachment_id = 0 ) {1651	$match = false;1652 1653	// Ensure the $image_meta is valid.1654	if ( isset( $image_meta['file'] ) && strlen( $image_meta['file'] ) > 4 ) {1655		// Remove query args in image URI.1656		list( $image_location ) = explode( '?', $image_location );1657 1658		// Check if the relative image path from the image meta is at the end of $image_location.1659		if ( strrpos( $image_location, $image_meta['file'] ) === strlen( $image_location ) - strlen( $image_meta['file'] ) ) {1660			$match = true;1661		} else {1662			// Retrieve the uploads sub-directory from the full size image.1663			$dirname = _wp_get_attachment_relative_path( $image_meta['file'] );1664 1665			if ( $dirname ) {1666				$dirname = trailingslashit( $dirname );1667			}1668 1669			if ( ! empty( $image_meta['original_image'] ) ) {1670				$relative_path = $dirname . $image_meta['original_image'];1671 1672				if ( strrpos( $image_location, $relative_path ) === strlen( $image_location ) - strlen( $relative_path ) ) {1673					$match = true;1674				}1675			}1676 1677			if ( ! $match && ! empty( $image_meta['sizes'] ) ) {1678				foreach ( $image_meta['sizes'] as $image_size_data ) {1679					$relative_path = $dirname . $image_size_data['file'];1680 1681					if ( strrpos( $image_location, $relative_path ) === strlen( $image_location ) - strlen( $relative_path ) ) {1682						$match = true;1683						break;1684					}1685				}1686			}1687		}1688	}1689 1690	/**1691	 * Filters whether an image path or URI matches image meta.1692	 *1693	 * @since 5.5.01694	 *1695	 * @param bool   $match          Whether the image relative path from the image meta1696	 *                               matches the end of the URI or path to the image file.1697	 * @param string $image_location Full path or URI to the tested image file.1698	 * @param array  $image_meta     The image meta data as returned by 'wp_get_attachment_metadata()'.1699	 * @param int    $attachment_id  The image attachment ID or 0 if not supplied.1700	 */1701	return apply_filters( 'wp_image_file_matches_image_meta', $match, $image_location, $image_meta, $attachment_id );1702}

Changelog

Introduced in 5.5.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.9.7 tag, from src/wp-includes/media.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.