A WordPress-centric search engine for devs and theme authors



wp_image_matches_ratio ›

Since4.6.0
Deprecatedn/a
wp_image_matches_ratio ( $source_width, $source_height, $target_width, $target_height )
Parameters: (4)
  • (int) $source_width Width of the first image in pixels.
    Required: Yes
  • (int) $source_height Height of the first image in pixels.
    Required: Yes
  • (int) $target_width Width of the second image in pixels.
    Required: Yes
  • (int) $target_height Height of the second image in pixels.
    Required: Yes
Returns:
  • (bool) True if aspect ratios match within 1px. False if not.
Defined at:
Codex:

Helper function to test if aspect ratios for two images match.



Source

function wp_image_matches_ratio( $source_width, $source_height, $target_width, $target_height ) {
	/*
	 * To test for varying crops, we constrain the dimensions of the larger image
	 * to the dimensions of the smaller image and see if they match.
	 */
	if ( $source_width > $target_width ) {
		$constrained_size = wp_constrain_dimensions( $source_width, $source_height, $target_width );
		$expected_size    = array( $target_width, $target_height );
	} else {
		$constrained_size = wp_constrain_dimensions( $target_width, $target_height, $source_width );
		$expected_size    = array( $source_width, $source_height );
	}

	// If the image dimensions are within 1px of the expected size, we consider it a match.
	$matched = ( abs( $constrained_size[0] - $expected_size[0] ) <= 1 && abs( $constrained_size[1] - $expected_size[1] ) <= 1 );

	return $matched;
}