function file_validate_image_resolution

7.x file.inc file_validate_image_resolution(stdClass $file, $maximum_dimensions = 0, $minimum_dimensions = 0)
6.x file.inc file_validate_image_resolution(&$file, $maximum_dimensions = 0, $minimum_dimensions = 0)
8.x file.module file_validate_image_resolution(FileInterface $file, $maximum_dimensions = 0, $minimum_dimensions = 0)

Verifies that image dimensions are within the specified maximum and minimum.

Non-image files will be ignored. If a image toolkit is available the image will be scaled to fit within the desired maximum dimensions.

Parameters

$file: A Drupal file object. This function may resize the file affecting its size.

$maximum_dimensions: An optional string in the form WIDTHxHEIGHT e.g. '640x480' or '85x85'. If an image toolkit is installed the image will be resized down to these dimensions. A value of 0 indicates no restriction on size, so resizing will be attempted.

$minimum_dimensions: An optional string in the form WIDTHxHEIGHT. This will check that the image meets a minimum size. A value of 0 indicates no restriction.

Return value

An array. If the file is an image and did not meet the requirements, it will contain an error message.

See also

hook_file_validate()

Related topics

1 call to file_validate_image_resolution()
FileValidatorTest::testFileValidateImageResolution in drupal/modules/simpletest/tests/file.test
This ensures the resolution of a specific file is within bounds. The image will be resized if it's too large.
3 string references to 'file_validate_image_resolution'
image_field_widget_form in drupal/modules/image/image.field.inc
Implements hook_field_widget_form().
theme_file_upload_help in drupal/modules/file/file.field.inc
Returns HTML for help text based on file upload validators.
user_validate_picture in drupal/modules/user/user.module
Validates an image uploaded by a user.

File

drupal/includes/file.inc, line 1809
API for handling file uploads and server file management.

Code

function file_validate_image_resolution(stdClass $file, $maximum_dimensions = 0, $minimum_dimensions = 0) {
  $errors = array();

  // Check first that the file is an image.
  if ($info = image_get_info($file->uri)) {
    if ($maximum_dimensions) {
      // Check that it is smaller than the given dimensions.
      list($width, $height) = explode('x', $maximum_dimensions);
      if ($info['width'] > $width || $info['height'] > $height) {
        // Try to resize the image to fit the dimensions.
        if ($image = image_load($file->uri)) {
          image_scale($image, $width, $height);
          image_save($image);
          $file->filesize = $image->info['file_size'];
          drupal_set_message(t('The image was resized to fit within the maximum allowed dimensions of %dimensions pixels.', array('%dimensions' => $maximum_dimensions)));
        }
        else {
          $errors[] = t('The image is too large; the maximum dimensions are %dimensions pixels.', array('%dimensions' => $maximum_dimensions));
        }
      }
    }

    if ($minimum_dimensions) {
      // Check that it is larger than the given dimensions.
      list($width, $height) = explode('x', $minimum_dimensions);
      if ($info['width'] < $width || $info['height'] < $height) {
        $errors[] = t('The image is too small; the minimum dimensions are %dimensions pixels.', array('%dimensions' => $minimum_dimensions));
      }
    }
  }

  return $errors;
}