[ Index ]

PHP Cross Reference of WordPress

title

Body

[close]

/wp-admin/includes/ -> image.php (source)

   1  <?php
   2  /**
   3   * File contains all the administration image manipulation functions.
   4   *
   5   * @package WordPress
   6   * @subpackage Administration
   7   */
   8  
   9  /**
  10   * Crop an Image to a given size.
  11   *
  12   * @since 2.1.0
  13   *
  14   * @param string|int $src The source file or Attachment ID.
  15   * @param int $src_x The start x position to crop from.
  16   * @param int $src_y The start y position to crop from.
  17   * @param int $src_w The width to crop.
  18   * @param int $src_h The height to crop.
  19   * @param int $dst_w The destination width.
  20   * @param int $dst_h The destination height.
  21   * @param int $src_abs Optional. If the source crop points are absolute.
  22   * @param string $dst_file Optional. The destination file to write to.
  23   * @return string|WP_Error New filepath on success, WP_Error on failure.
  24   */
  25  function wp_crop_image( $src, $src_x, $src_y, $src_w, $src_h, $dst_w, $dst_h, $src_abs = false, $dst_file = false ) {
  26      $src_file = $src;
  27      if ( is_numeric( $src ) ) { // Handle int as attachment ID.
  28          $src_file = get_attached_file( $src );
  29  
  30          if ( ! file_exists( $src_file ) ) {
  31              // If the file doesn't exist, attempt a URL fopen on the src link.
  32              // This can occur with certain file replication plugins.
  33              $src = _load_image_to_edit_path( $src, 'full' );
  34          } else {
  35              $src = $src_file;
  36          }
  37      }
  38  
  39      $editor = wp_get_image_editor( $src );
  40      if ( is_wp_error( $editor ) ) {
  41          return $editor;
  42      }
  43  
  44      $src = $editor->crop( $src_x, $src_y, $src_w, $src_h, $dst_w, $dst_h, $src_abs );
  45      if ( is_wp_error( $src ) ) {
  46          return $src;
  47      }
  48  
  49      if ( ! $dst_file ) {
  50          $dst_file = str_replace( wp_basename( $src_file ), 'cropped-' . wp_basename( $src_file ), $src_file );
  51      }
  52  
  53      /*
  54       * The directory containing the original file may no longer exist when
  55       * using a replication plugin.
  56       */
  57      wp_mkdir_p( dirname( $dst_file ) );
  58  
  59      $dst_file = dirname( $dst_file ) . '/' . wp_unique_filename( dirname( $dst_file ), wp_basename( $dst_file ) );
  60  
  61      $result = $editor->save( $dst_file );
  62      if ( is_wp_error( $result ) ) {
  63          return $result;
  64      }
  65  
  66      return $dst_file;
  67  }
  68  
  69  /**
  70   * Compare the existing image sub-sizes (as saved in the attachment meta)
  71   * to the currently registered image sub-sizes, and return the difference.
  72   *
  73   * Registered sub-sizes that are larger than the image are skipped.
  74   *
  75   * @since 5.3.0
  76   *
  77   * @param int $attachment_id The image attachment post ID.
  78   * @return array An array of the image sub-sizes that are currently defined but don't exist for this image.
  79   */
  80  function wp_get_missing_image_subsizes( $attachment_id ) {
  81      if ( ! wp_attachment_is_image( $attachment_id ) ) {
  82          return array();
  83      }
  84  
  85      $registered_sizes = wp_get_registered_image_subsizes();
  86      $image_meta       = wp_get_attachment_metadata( $attachment_id );
  87  
  88      // Meta error?
  89      if ( empty( $image_meta ) ) {
  90          return $registered_sizes;
  91      }
  92  
  93      // Use the originally uploaded image dimensions as full_width and full_height.
  94      if ( ! empty( $image_meta['original_image'] ) ) {
  95          $image_file = wp_get_original_image_path( $attachment_id );
  96          $imagesize  = @getimagesize( $image_file );
  97      }
  98  
  99      if ( ! empty( $imagesize ) ) {
 100          $full_width  = $imagesize[0];
 101          $full_height = $imagesize[1];
 102      } else {
 103          $full_width  = (int) $image_meta['width'];
 104          $full_height = (int) $image_meta['height'];
 105      }
 106  
 107      $possible_sizes = array();
 108  
 109      // Skip registered sizes that are too large for the uploaded image.
 110      foreach ( $registered_sizes as $size_name => $size_data ) {
 111          if ( image_resize_dimensions( $full_width, $full_height, $size_data['width'], $size_data['height'], $size_data['crop'] ) ) {
 112              $possible_sizes[ $size_name ] = $size_data;
 113          }
 114      }
 115  
 116      if ( empty( $image_meta['sizes'] ) ) {
 117          $image_meta['sizes'] = array();
 118      }
 119  
 120      /*
 121       * Remove sizes that already exist. Only checks for matching "size names".
 122       * It is possible that the dimensions for a particular size name have changed.
 123       * For example the user has changed the values on the Settings -> Media screen.
 124       * However we keep the old sub-sizes with the previous dimensions
 125       * as the image may have been used in an older post.
 126       */
 127      $missing_sizes = array_diff_key( $possible_sizes, $image_meta['sizes'] );
 128  
 129      /**
 130       * Filters the array of missing image sub-sizes for an uploaded image.
 131       *
 132       * @since 5.3.0
 133       *
 134       * @param array $missing_sizes Array with the missing image sub-sizes.
 135       * @param array $image_meta    The image meta data.
 136       * @param int   $attachment_id The image attachment post ID.
 137       */
 138      return apply_filters( 'wp_get_missing_image_subsizes', $missing_sizes, $image_meta, $attachment_id );
 139  }
 140  
 141  /**
 142   * If any of the currently registered image sub-sizes are missing,
 143   * create them and update the image meta data.
 144   *
 145   * @since 5.3.0
 146   *
 147   * @param int $attachment_id The image attachment post ID.
 148   * @return array|WP_Error The updated image meta data array or WP_Error object
 149   *                        if both the image meta and the attached file are missing.
 150   */
 151  function wp_update_image_subsizes( $attachment_id ) {
 152      $image_meta = wp_get_attachment_metadata( $attachment_id );
 153      $image_file = wp_get_original_image_path( $attachment_id );
 154  
 155      if ( empty( $image_meta ) || ! is_array( $image_meta ) ) {
 156          // Previously failed upload?
 157          // If there is an uploaded file, make all sub-sizes and generate all of the attachment meta.
 158          if ( ! empty( $image_file ) ) {
 159              $image_meta = wp_create_image_subsizes( $image_file, $attachment_id );
 160          } else {
 161              return new WP_Error( 'invalid_attachment', __( 'The attached file cannot be found.' ) );
 162          }
 163      } else {
 164          $missing_sizes = wp_get_missing_image_subsizes( $attachment_id );
 165  
 166          if ( empty( $missing_sizes ) ) {
 167              return $image_meta;
 168          }
 169  
 170          // This also updates the image meta.
 171          $image_meta = _wp_make_subsizes( $missing_sizes, $image_file, $image_meta, $attachment_id );
 172      }
 173  
 174      /** This filter is documented in wp-admin/includes/image.php */
 175      $image_meta = apply_filters( 'wp_generate_attachment_metadata', $image_meta, $attachment_id, 'update' );
 176  
 177      // Save the updated metadata.
 178      wp_update_attachment_metadata( $attachment_id, $image_meta );
 179  
 180      return $image_meta;
 181  }
 182  
 183  /**
 184   * Updates the attached file and image meta data when the original image was edited.
 185   *
 186   * @since 5.3.0
 187   * @access private
 188   *
 189   * @param array  $saved_data    The data returned from WP_Image_Editor after successfully saving an image.
 190   * @param string $original_file Path to the original file.
 191   * @param array  $image_meta    The image meta data.
 192   * @param int    $attachment_id The attachment post ID.
 193   * @return array The updated image meta data.
 194   */
 195  function _wp_image_meta_replace_original( $saved_data, $original_file, $image_meta, $attachment_id ) {
 196      $new_file = $saved_data['path'];
 197  
 198      // Update the attached file meta.
 199      update_attached_file( $attachment_id, $new_file );
 200  
 201      // Width and height of the new image.
 202      $image_meta['width']  = $saved_data['width'];
 203      $image_meta['height'] = $saved_data['height'];
 204  
 205      // Make the file path relative to the upload dir.
 206      $image_meta['file'] = _wp_relative_upload_path( $new_file );
 207  
 208      // Store the original image file name in image_meta.
 209      $image_meta['original_image'] = wp_basename( $original_file );
 210  
 211      return $image_meta;
 212  }
 213  
 214  /**
 215   * Creates image sub-sizes, adds the new data to the image meta `sizes` array, and updates the image metadata.
 216   *
 217   * Intended for use after an image is uploaded. Saves/updates the image metadata after each
 218   * sub-size is created. If there was an error, it is added to the returned image metadata array.
 219   *
 220   * @since 5.3.0
 221   *
 222   * @param string $file          Full path to the image file.
 223   * @param int    $attachment_id Attachment Id to process.
 224   * @return array The image attachment meta data.
 225   */
 226  function wp_create_image_subsizes( $file, $attachment_id ) {
 227      $imagesize = @getimagesize( $file );
 228  
 229      if ( empty( $imagesize ) ) {
 230          // File is not an image.
 231          return array();
 232      }
 233  
 234      // Default image meta.
 235      $image_meta = array(
 236          'width'  => $imagesize[0],
 237          'height' => $imagesize[1],
 238          'file'   => _wp_relative_upload_path( $file ),
 239          'sizes'  => array(),
 240      );
 241  
 242      // Fetch additional metadata from EXIF/IPTC.
 243      $exif_meta = wp_read_image_metadata( $file );
 244  
 245      if ( $exif_meta ) {
 246          $image_meta['image_meta'] = $exif_meta;
 247      }
 248  
 249      // Do not scale (large) PNG images. May result in sub-sizes that have greater file size than the original. See #48736.
 250      if ( $imagesize['mime'] !== 'image/png' ) {
 251  
 252          /**
 253           * Filters the "BIG image" threshold value.
 254           *
 255           * If the original image width or height is above the threshold, it will be scaled down. The threshold is
 256           * used as max width and max height. The scaled down image will be used as the largest available size, including
 257           * the `_wp_attached_file` post meta value.
 258           *
 259           * Returning `false` from the filter callback will disable the scaling.
 260           *
 261           * @since 5.3.0
 262           *
 263           * @param int    $threshold     The threshold value in pixels. Default 2560.
 264           * @param array  $imagesize     {
 265           *     Indexed array of the image width and height in pixels.
 266           *
 267           *     @type int $0 The image width.
 268           *     @type int $1 The image height.
 269           * }
 270           * @param string $file          Full path to the uploaded image file.
 271           * @param int    $attachment_id Attachment post ID.
 272           */
 273          $threshold = (int) apply_filters( 'big_image_size_threshold', 2560, $imagesize, $file, $attachment_id );
 274  
 275          // If the original image's dimensions are over the threshold, scale the image
 276          // and use it as the "full" size.
 277          if ( $threshold && ( $image_meta['width'] > $threshold || $image_meta['height'] > $threshold ) ) {
 278              $editor = wp_get_image_editor( $file );
 279  
 280              if ( is_wp_error( $editor ) ) {
 281                  // This image cannot be edited.
 282                  return $image_meta;
 283              }
 284  
 285              // Resize the image
 286              $resized = $editor->resize( $threshold, $threshold );
 287              $rotated = null;
 288  
 289              // If there is EXIF data, rotate according to EXIF Orientation.
 290              if ( ! is_wp_error( $resized ) && is_array( $exif_meta ) ) {
 291                  $resized = $editor->maybe_exif_rotate();
 292                  $rotated = $resized;
 293              }
 294  
 295              if ( ! is_wp_error( $resized ) ) {
 296                  // Append "-scaled" to the image file name. It will look like "my_image-scaled.jpg".
 297                  // This doesn't affect the sub-sizes names as they are generated from the original image (for best quality).
 298                  $saved = $editor->save( $editor->generate_filename( 'scaled' ) );
 299  
 300                  if ( ! is_wp_error( $saved ) ) {
 301                      $image_meta = _wp_image_meta_replace_original( $saved, $file, $image_meta, $attachment_id );
 302  
 303                      // If the image was rotated update the stored EXIF data.
 304                      if ( true === $rotated && ! empty( $image_meta['image_meta']['orientation'] ) ) {
 305                          $image_meta['image_meta']['orientation'] = 1;
 306                      }
 307                  } else {
 308                      // TODO: log errors.
 309                  }
 310              } else {
 311                  // TODO: log errors.
 312              }
 313          } elseif ( ! empty( $exif_meta['orientation'] ) && (int) $exif_meta['orientation'] !== 1 ) {
 314              // Rotate the whole original image if there is EXIF data and "orientation" is not 1.
 315  
 316              $editor = wp_get_image_editor( $file );
 317  
 318              if ( is_wp_error( $editor ) ) {
 319                  // This image cannot be edited.
 320                  return $image_meta;
 321              }
 322  
 323              // Rotate the image.
 324              $rotated = $editor->maybe_exif_rotate();
 325  
 326              if ( true === $rotated ) {
 327                  // Append `-rotated` to the image file name.
 328                  $saved = $editor->save( $editor->generate_filename( 'rotated' ) );
 329  
 330                  if ( ! is_wp_error( $saved ) ) {
 331                      $image_meta = _wp_image_meta_replace_original( $saved, $file, $image_meta, $attachment_id );
 332  
 333                      // Update the stored EXIF data.
 334                      if ( ! empty( $image_meta['image_meta']['orientation'] ) ) {
 335                          $image_meta['image_meta']['orientation'] = 1;
 336                      }
 337                  } else {
 338                      // TODO: log errors.
 339                  }
 340              }
 341          }
 342      }
 343  
 344      /*
 345       * Initial save of the new metadata.
 346       * At this point the file was uploaded and moved to the uploads directory
 347       * but the image sub-sizes haven't been created yet and the `sizes` array is empty.
 348       */
 349      wp_update_attachment_metadata( $attachment_id, $image_meta );
 350  
 351      $new_sizes = wp_get_registered_image_subsizes();
 352  
 353      /**
 354       * Filters the image sizes automatically generated when uploading an image.
 355       *
 356       * @since 2.9.0
 357       * @since 4.4.0 Added the `$image_meta` argument.
 358       * @since 5.3.0 Added the `$attachment_id` argument.
 359       *
 360       * @param array $new_sizes     Associative array of image sizes to be created.
 361       * @param array $image_meta    The image meta data: width, height, file, sizes, etc.
 362       * @param int   $attachment_id The attachment post ID for the image.
 363       */
 364      $new_sizes = apply_filters( 'intermediate_image_sizes_advanced', $new_sizes, $image_meta, $attachment_id );
 365  
 366      return _wp_make_subsizes( $new_sizes, $file, $image_meta, $attachment_id );
 367  }
 368  
 369  /**
 370   * Low-level function to create image sub-sizes.
 371   *
 372   * Updates the image meta after each sub-size is created.
 373   * Errors are stored in the returned image metadata array.
 374   *
 375   * @since 5.3.0
 376   * @access private
 377   *
 378   * @param array  $new_sizes     Array defining what sizes to create.
 379   * @param string $file          Full path to the image file.
 380   * @param array  $image_meta    The attachment meta data array.
 381   * @param int    $attachment_id Attachment Id to process.
 382   * @return array The attachment meta data with updated `sizes` array. Includes an array of errors encountered while resizing.
 383   */
 384  function _wp_make_subsizes( $new_sizes, $file, $image_meta, $attachment_id ) {
 385      if ( empty( $image_meta ) || ! is_array( $image_meta ) ) {
 386          // Not an image attachment.
 387          return array();
 388      }
 389  
 390      // Check if any of the new sizes already exist.
 391      if ( isset( $image_meta['sizes'] ) && is_array( $image_meta['sizes'] ) ) {
 392          foreach ( $image_meta['sizes'] as $size_name => $size_meta ) {
 393              /*
 394               * Only checks "size name" so we don't override existing images even if the dimensions
 395               * don't match the currently defined size with the same name.
 396               * To change the behavior, unset changed/mismatched sizes in the `sizes` array in image meta.
 397               */
 398              if ( array_key_exists( $size_name, $new_sizes ) ) {
 399                  unset( $new_sizes[ $size_name ] );
 400              }
 401          }
 402      } else {
 403          $image_meta['sizes'] = array();
 404      }
 405  
 406      if ( empty( $new_sizes ) ) {
 407          // Nothing to do...
 408          return $image_meta;
 409      }
 410  
 411      /*
 412       * Sort the image sub-sizes in order of priority when creating them.
 413       * This ensures there is an appropriate sub-size the user can access immediately
 414       * even when there was an error and not all sub-sizes were created.
 415       */
 416      $priority = array(
 417          'medium'       => null,
 418          'large'        => null,
 419          'thumbnail'    => null,
 420          'medium_large' => null,
 421      );
 422  
 423      $new_sizes = array_filter( array_merge( $priority, $new_sizes ) );
 424  
 425      $editor = wp_get_image_editor( $file );
 426  
 427      if ( is_wp_error( $editor ) ) {
 428          // The image cannot be edited.
 429          return $image_meta;
 430      }
 431  
 432      // If stored EXIF data exists, rotate the source image before creating sub-sizes.
 433      if ( ! empty( $image_meta['image_meta'] ) ) {
 434          $rotated = $editor->maybe_exif_rotate();
 435  
 436          if ( is_wp_error( $rotated ) ) {
 437              // TODO: log errors.
 438          }
 439      }
 440  
 441      if ( method_exists( $editor, 'make_subsize' ) ) {
 442          foreach ( $new_sizes as $new_size_name => $new_size_data ) {
 443              $new_size_meta = $editor->make_subsize( $new_size_data );
 444  
 445              if ( is_wp_error( $new_size_meta ) ) {
 446                  // TODO: log errors.
 447              } else {
 448                  // Save the size meta value.
 449                  $image_meta['sizes'][ $new_size_name ] = $new_size_meta;
 450                  wp_update_attachment_metadata( $attachment_id, $image_meta );
 451              }
 452          }
 453      } else {
 454          // Fall back to `$editor->multi_resize()`.
 455          $created_sizes = $editor->multi_resize( $new_sizes );
 456  
 457          if ( ! empty( $created_sizes ) ) {
 458              $image_meta['sizes'] = array_merge( $image_meta['sizes'], $created_sizes );
 459              wp_update_attachment_metadata( $attachment_id, $image_meta );
 460          }
 461      }
 462  
 463      return $image_meta;
 464  }
 465  
 466  /**
 467   * Generate attachment meta data and create image sub-sizes for images.
 468   *
 469   * @since 2.1.0
 470   *
 471   * @param int $attachment_id Attachment Id to process.
 472   * @param string $file Filepath of the Attached image.
 473   * @return mixed Metadata for attachment.
 474   */
 475  function wp_generate_attachment_metadata( $attachment_id, $file ) {
 476      $attachment = get_post( $attachment_id );
 477  
 478      $metadata  = array();
 479      $support   = false;
 480      $mime_type = get_post_mime_type( $attachment );
 481  
 482      if ( preg_match( '!^image/!', $mime_type ) && file_is_displayable_image( $file ) ) {
 483          // Make thumbnails and other intermediate sizes.
 484          $metadata = wp_create_image_subsizes( $file, $attachment_id );
 485      } elseif ( wp_attachment_is( 'video', $attachment ) ) {
 486          $metadata = wp_read_video_metadata( $file );
 487          $support  = current_theme_supports( 'post-thumbnails', 'attachment:video' ) || post_type_supports( 'attachment:video', 'thumbnail' );
 488      } elseif ( wp_attachment_is( 'audio', $attachment ) ) {
 489          $metadata = wp_read_audio_metadata( $file );
 490          $support  = current_theme_supports( 'post-thumbnails', 'attachment:audio' ) || post_type_supports( 'attachment:audio', 'thumbnail' );
 491      }
 492  
 493      if ( $support && ! empty( $metadata['image']['data'] ) ) {
 494          // Check for existing cover.
 495          $hash   = md5( $metadata['image']['data'] );
 496          $posts  = get_posts(
 497              array(
 498                  'fields'         => 'ids',
 499                  'post_type'      => 'attachment',
 500                  'post_mime_type' => $metadata['image']['mime'],
 501                  'post_status'    => 'inherit',
 502                  'posts_per_page' => 1,
 503                  'meta_key'       => '_cover_hash',
 504                  'meta_value'     => $hash,
 505              )
 506          );
 507          $exists = reset( $posts );
 508  
 509          if ( ! empty( $exists ) ) {
 510              update_post_meta( $attachment_id, '_thumbnail_id', $exists );
 511          } else {
 512              $ext = '.jpg';
 513              switch ( $metadata['image']['mime'] ) {
 514                  case 'image/gif':
 515                      $ext = '.gif';
 516                      break;
 517                  case 'image/png':
 518                      $ext = '.png';
 519                      break;
 520              }
 521              $basename = str_replace( '.', '-', wp_basename( $file ) ) . '-image' . $ext;
 522              $uploaded = wp_upload_bits( $basename, '', $metadata['image']['data'] );
 523              if ( false === $uploaded['error'] ) {
 524                  $image_attachment = array(
 525                      'post_mime_type' => $metadata['image']['mime'],
 526                      'post_type'      => 'attachment',
 527                      'post_content'   => '',
 528                  );
 529                  /**
 530                   * Filters the parameters for the attachment thumbnail creation.
 531                   *
 532                   * @since 3.9.0
 533                   *
 534                   * @param array $image_attachment An array of parameters to create the thumbnail.
 535                   * @param array $metadata         Current attachment metadata.
 536                   * @param array $uploaded         An array containing the thumbnail path and url.
 537                   */
 538                  $image_attachment = apply_filters( 'attachment_thumbnail_args', $image_attachment, $metadata, $uploaded );
 539  
 540                  $sub_attachment_id = wp_insert_attachment( $image_attachment, $uploaded['file'] );
 541                  add_post_meta( $sub_attachment_id, '_cover_hash', $hash );
 542                  $attach_data = wp_generate_attachment_metadata( $sub_attachment_id, $uploaded['file'] );
 543                  wp_update_attachment_metadata( $sub_attachment_id, $attach_data );
 544                  update_post_meta( $attachment_id, '_thumbnail_id', $sub_attachment_id );
 545              }
 546          }
 547      } elseif ( 'application/pdf' === $mime_type ) {
 548          // Try to create image thumbnails for PDFs.
 549  
 550          $fallback_sizes = array(
 551              'thumbnail',
 552              'medium',
 553              'large',
 554          );
 555  
 556          /**
 557           * Filters the image sizes generated for non-image mime types.
 558           *
 559           * @since 4.7.0
 560           *
 561           * @param string[] $fallback_sizes An array of image size names.
 562           * @param array    $metadata       Current attachment metadata.
 563           */
 564          $fallback_sizes = apply_filters( 'fallback_intermediate_image_sizes', $fallback_sizes, $metadata );
 565  
 566          $registered_sizes = wp_get_registered_image_subsizes();
 567          $merged_sizes     = array_intersect_key( $registered_sizes, array_flip( $fallback_sizes ) );
 568  
 569          // Force thumbnails to be soft crops.
 570          if ( isset( $merged_sizes['thumbnail'] ) && is_array( $merged_sizes['thumbnail'] ) ) {
 571              $merged_sizes['thumbnail']['crop'] = false;
 572          }
 573  
 574          // Only load PDFs in an image editor if we're processing sizes.
 575          if ( ! empty( $merged_sizes ) ) {
 576              $editor = wp_get_image_editor( $file );
 577  
 578              if ( ! is_wp_error( $editor ) ) { // No support for this type of file
 579                  /*
 580                   * PDFs may have the same file filename as JPEGs.
 581                   * Ensure the PDF preview image does not overwrite any JPEG images that already exist.
 582                   */
 583                  $dirname      = dirname( $file ) . '/';
 584                  $ext          = '.' . pathinfo( $file, PATHINFO_EXTENSION );
 585                  $preview_file = $dirname . wp_unique_filename( $dirname, wp_basename( $file, $ext ) . '-pdf.jpg' );
 586  
 587                  $uploaded = $editor->save( $preview_file, 'image/jpeg' );
 588                  unset( $editor );
 589  
 590                  // Resize based on the full size image, rather than the source.
 591                  if ( ! is_wp_error( $uploaded ) ) {
 592                      $image_file = $uploaded['path'];
 593                      unset( $uploaded['path'] );
 594  
 595                      $metadata['sizes'] = array(
 596                          'full' => $uploaded,
 597                      );
 598  
 599                      // Save the meta data before any image post-processing errors could happen.
 600                      wp_update_attachment_metadata( $attachment_id, $metadata );
 601  
 602                      // Create sub-sizes saving the image meta after each.
 603                      $metadata = _wp_make_subsizes( $merged_sizes, $image_file, $metadata, $attachment_id );
 604                  }
 605              }
 606          }
 607      }
 608  
 609      // Remove the blob of binary data from the array.
 610      if ( $metadata ) {
 611          unset( $metadata['image']['data'] );
 612      }
 613  
 614      /**
 615       * Filters the generated attachment meta data.
 616       *
 617       * @since 2.1.0
 618       * @since 5.3.0 The `$context` parameter was added.
 619       *
 620       * @param array  $metadata      An array of attachment meta data.
 621       * @param int    $attachment_id Current attachment ID.
 622       * @param string $context       Additional context. Can be 'create' when metadata was initially created for new attachment
 623       *                              or 'update' when the metadata was updated.
 624       */
 625      return apply_filters( 'wp_generate_attachment_metadata', $metadata, $attachment_id, 'create' );
 626  }
 627  
 628  /**
 629   * Convert a fraction string to a decimal.
 630   *
 631   * @since 2.5.0
 632   *
 633   * @param string $str
 634   * @return int|float
 635   */
 636  function wp_exif_frac2dec( $str ) {
 637      if ( false === strpos( $str, '/' ) ) {
 638          return $str;
 639      }
 640  
 641      list( $n, $d ) = explode( '/', $str );
 642      if ( ! empty( $d ) ) {
 643          return $n / $d;
 644      }
 645      return $str;
 646  }
 647  
 648  /**
 649   * Convert the exif date format to a unix timestamp.
 650   *
 651   * @since 2.5.0
 652   *
 653   * @param string $str
 654   * @return int
 655   */
 656  function wp_exif_date2ts( $str ) {
 657      list( $date, $time ) = explode( ' ', trim( $str ) );
 658      list( $y, $m, $d )   = explode( ':', $date );
 659  
 660      return strtotime( "{$y}-{$m}-{$d} {$time}" );
 661  }
 662  
 663  /**
 664   * Get extended image metadata, exif or iptc as available.
 665   *
 666   * Retrieves the EXIF metadata aperture, credit, camera, caption, copyright, iso
 667   * created_timestamp, focal_length, shutter_speed, and title.
 668   *
 669   * The IPTC metadata that is retrieved is APP13, credit, byline, created date
 670   * and time, caption, copyright, and title. Also includes FNumber, Model,
 671   * DateTimeDigitized, FocalLength, ISOSpeedRatings, and ExposureTime.
 672   *
 673   * @todo Try other exif libraries if available.
 674   * @since 2.5.0
 675   *
 676   * @param string $file
 677   * @return bool|array False on failure. Image metadata array on success.
 678   */
 679  function wp_read_image_metadata( $file ) {
 680      if ( ! file_exists( $file ) ) {
 681          return false;
 682      }
 683  
 684      list( , , $image_type ) = @getimagesize( $file );
 685  
 686      /*
 687       * EXIF contains a bunch of data we'll probably never need formatted in ways
 688       * that are difficult to use. We'll normalize it and just extract the fields
 689       * that are likely to be useful. Fractions and numbers are converted to
 690       * floats, dates to unix timestamps, and everything else to strings.
 691       */
 692      $meta = array(
 693          'aperture'          => 0,
 694          'credit'            => '',
 695          'camera'            => '',
 696          'caption'           => '',
 697          'created_timestamp' => 0,
 698          'copyright'         => '',
 699          'focal_length'      => 0,
 700          'iso'               => 0,
 701          'shutter_speed'     => 0,
 702          'title'             => '',
 703          'orientation'       => 0,
 704          'keywords'          => array(),
 705      );
 706  
 707      $iptc = array();
 708      /*
 709       * Read IPTC first, since it might contain data not available in exif such
 710       * as caption, description etc.
 711       */
 712      if ( is_callable( 'iptcparse' ) ) {
 713          @getimagesize( $file, $info );
 714  
 715          if ( ! empty( $info['APP13'] ) ) {
 716              $iptc = @iptcparse( $info['APP13'] );
 717  
 718              // Headline, "A brief synopsis of the caption."
 719              if ( ! empty( $iptc['2#105'][0] ) ) {
 720                  $meta['title'] = trim( $iptc['2#105'][0] );
 721                  /*
 722                  * Title, "Many use the Title field to store the filename of the image,
 723                  * though the field may be used in many ways."
 724                  */
 725              } elseif ( ! empty( $iptc['2#005'][0] ) ) {
 726                  $meta['title'] = trim( $iptc['2#005'][0] );
 727              }
 728  
 729              if ( ! empty( $iptc['2#120'][0] ) ) { // description / legacy caption
 730                  $caption = trim( $iptc['2#120'][0] );
 731  
 732                  mbstring_binary_safe_encoding();
 733                  $caption_length = strlen( $caption );
 734                  reset_mbstring_encoding();
 735  
 736                  if ( empty( $meta['title'] ) && $caption_length < 80 ) {
 737                      // Assume the title is stored in 2:120 if it's short.
 738                      $meta['title'] = $caption;
 739                  }
 740  
 741                  $meta['caption'] = $caption;
 742              }
 743  
 744              if ( ! empty( $iptc['2#110'][0] ) ) { // Credit.
 745                  $meta['credit'] = trim( $iptc['2#110'][0] );
 746              } elseif ( ! empty( $iptc['2#080'][0] ) ) { // Creator / legacy byline.
 747                  $meta['credit'] = trim( $iptc['2#080'][0] );
 748              }
 749  
 750              if ( ! empty( $iptc['2#055'][0] ) && ! empty( $iptc['2#060'][0] ) ) { // Created date and time.
 751                  $meta['created_timestamp'] = strtotime( $iptc['2#055'][0] . ' ' . $iptc['2#060'][0] );
 752              }
 753  
 754              if ( ! empty( $iptc['2#116'][0] ) ) { // Copyright.
 755                  $meta['copyright'] = trim( $iptc['2#116'][0] );
 756              }
 757  
 758              if ( ! empty( $iptc['2#025'][0] ) ) { // Keywords array.
 759                  $meta['keywords'] = array_values( $iptc['2#025'] );
 760              }
 761          }
 762      }
 763  
 764      $exif = array();
 765  
 766      /**
 767       * Filters the image types to check for exif data.
 768       *
 769       * @since 2.5.0
 770       *
 771       * @param array $image_types Image types to check for exif data.
 772       */
 773      $exif_image_types = apply_filters( 'wp_read_image_metadata_types', array( IMAGETYPE_JPEG, IMAGETYPE_TIFF_II, IMAGETYPE_TIFF_MM ) );
 774  
 775      if ( is_callable( 'exif_read_data' ) && in_array( $image_type, $exif_image_types, true ) ) {
 776          $exif = @exif_read_data( $file );
 777  
 778          if ( ! empty( $exif['ImageDescription'] ) ) {
 779              mbstring_binary_safe_encoding();
 780              $description_length = strlen( $exif['ImageDescription'] );
 781              reset_mbstring_encoding();
 782  
 783              if ( empty( $meta['title'] ) && $description_length < 80 ) {
 784                  // Assume the title is stored in ImageDescription.
 785                  $meta['title'] = trim( $exif['ImageDescription'] );
 786              }
 787  
 788              if ( empty( $meta['caption'] ) && ! empty( $exif['COMPUTED']['UserComment'] ) ) {
 789                  $meta['caption'] = trim( $exif['COMPUTED']['UserComment'] );
 790              }
 791  
 792              if ( empty( $meta['caption'] ) ) {
 793                  $meta['caption'] = trim( $exif['ImageDescription'] );
 794              }
 795          } elseif ( empty( $meta['caption'] ) && ! empty( $exif['Comments'] ) ) {
 796              $meta['caption'] = trim( $exif['Comments'] );
 797          }
 798  
 799          if ( empty( $meta['credit'] ) ) {
 800              if ( ! empty( $exif['Artist'] ) ) {
 801                  $meta['credit'] = trim( $exif['Artist'] );
 802              } elseif ( ! empty( $exif['Author'] ) ) {
 803                  $meta['credit'] = trim( $exif['Author'] );
 804              }
 805          }
 806  
 807          if ( empty( $meta['copyright'] ) && ! empty( $exif['Copyright'] ) ) {
 808              $meta['copyright'] = trim( $exif['Copyright'] );
 809          }
 810          if ( ! empty( $exif['FNumber'] ) ) {
 811              $meta['aperture'] = round( wp_exif_frac2dec( $exif['FNumber'] ), 2 );
 812          }
 813          if ( ! empty( $exif['Model'] ) ) {
 814              $meta['camera'] = trim( $exif['Model'] );
 815          }
 816          if ( empty( $meta['created_timestamp'] ) && ! empty( $exif['DateTimeDigitized'] ) ) {
 817              $meta['created_timestamp'] = wp_exif_date2ts( $exif['DateTimeDigitized'] );
 818          }
 819          if ( ! empty( $exif['FocalLength'] ) ) {
 820              $meta['focal_length'] = (string) wp_exif_frac2dec( $exif['FocalLength'] );
 821          }
 822          if ( ! empty( $exif['ISOSpeedRatings'] ) ) {
 823              $meta['iso'] = is_array( $exif['ISOSpeedRatings'] ) ? reset( $exif['ISOSpeedRatings'] ) : $exif['ISOSpeedRatings'];
 824              $meta['iso'] = trim( $meta['iso'] );
 825          }
 826          if ( ! empty( $exif['ExposureTime'] ) ) {
 827              $meta['shutter_speed'] = (string) wp_exif_frac2dec( $exif['ExposureTime'] );
 828          }
 829          if ( ! empty( $exif['Orientation'] ) ) {
 830              $meta['orientation'] = $exif['Orientation'];
 831          }
 832      }
 833  
 834      foreach ( array( 'title', 'caption', 'credit', 'copyright', 'camera', 'iso' ) as $key ) {
 835          if ( $meta[ $key ] && ! seems_utf8( $meta[ $key ] ) ) {
 836              $meta[ $key ] = utf8_encode( $meta[ $key ] );
 837          }
 838      }
 839  
 840      foreach ( $meta['keywords'] as $key => $keyword ) {
 841          if ( ! seems_utf8( $keyword ) ) {
 842              $meta['keywords'][ $key ] = utf8_encode( $keyword );
 843          }
 844      }
 845  
 846      $meta = wp_kses_post_deep( $meta );
 847  
 848      /**
 849       * Filters the array of meta data read from an image's exif data.
 850       *
 851       * @since 2.5.0
 852       * @since 4.4.0 The `$iptc` parameter was added.
 853       * @since 5.0.0 The `$exif` parameter was added.
 854       *
 855       * @param array  $meta       Image meta data.
 856       * @param string $file       Path to image file.
 857       * @param int    $image_type Type of image, one of the `IMAGETYPE_XXX` constants.
 858       * @param array  $iptc       IPTC data.
 859       * @param array  $exif       EXIF data.
 860       */
 861      return apply_filters( 'wp_read_image_metadata', $meta, $file, $image_type, $iptc, $exif );
 862  
 863  }
 864  
 865  /**
 866   * Validate that file is an image.
 867   *
 868   * @since 2.5.0
 869   *
 870   * @param string $path File path to test if valid image.
 871   * @return bool True if valid image, false if not valid image.
 872   */
 873  function file_is_valid_image( $path ) {
 874      $size = @getimagesize( $path );
 875      return ! empty( $size );
 876  }
 877  
 878  /**
 879   * Validate that file is suitable for displaying within a web page.
 880   *
 881   * @since 2.5.0
 882   *
 883   * @param string $path File path to test.
 884   * @return bool True if suitable, false if not suitable.
 885   */
 886  function file_is_displayable_image( $path ) {
 887      $displayable_image_types = array( IMAGETYPE_GIF, IMAGETYPE_JPEG, IMAGETYPE_PNG, IMAGETYPE_BMP, IMAGETYPE_ICO );
 888  
 889      $info = @getimagesize( $path );
 890      if ( empty( $info ) ) {
 891          $result = false;
 892      } elseif ( ! in_array( $info[2], $displayable_image_types, true ) ) {
 893          $result = false;
 894      } else {
 895          $result = true;
 896      }
 897  
 898      /**
 899       * Filters whether the current image is displayable in the browser.
 900       *
 901       * @since 2.5.0
 902       *
 903       * @param bool   $result Whether the image can be displayed. Default true.
 904       * @param string $path   Path to the image.
 905       */
 906      return apply_filters( 'file_is_displayable_image', $result, $path );
 907  }
 908  
 909  /**
 910   * Load an image resource for editing.
 911   *
 912   * @since 2.9.0
 913   *
 914   * @param string $attachment_id Attachment ID.
 915   * @param string $mime_type Image mime type.
 916   * @param string $size Optional. Image size, defaults to 'full'.
 917   * @return resource|false The resulting image resource on success, false on failure.
 918   */
 919  function load_image_to_edit( $attachment_id, $mime_type, $size = 'full' ) {
 920      $filepath = _load_image_to_edit_path( $attachment_id, $size );
 921      if ( empty( $filepath ) ) {
 922          return false;
 923      }
 924  
 925      switch ( $mime_type ) {
 926          case 'image/jpeg':
 927              $image = imagecreatefromjpeg( $filepath );
 928              break;
 929          case 'image/png':
 930              $image = imagecreatefrompng( $filepath );
 931              break;
 932          case 'image/gif':
 933              $image = imagecreatefromgif( $filepath );
 934              break;
 935          default:
 936              $image = false;
 937              break;
 938      }
 939      if ( is_resource( $image ) ) {
 940          /**
 941           * Filters the current image being loaded for editing.
 942           *
 943           * @since 2.9.0
 944           *
 945           * @param resource $image         Current image.
 946           * @param string   $attachment_id Attachment ID.
 947           * @param string   $size          Image size.
 948           */
 949          $image = apply_filters( 'load_image_to_edit', $image, $attachment_id, $size );
 950          if ( function_exists( 'imagealphablending' ) && function_exists( 'imagesavealpha' ) ) {
 951              imagealphablending( $image, false );
 952              imagesavealpha( $image, true );
 953          }
 954      }
 955      return $image;
 956  }
 957  
 958  /**
 959   * Retrieve the path or url of an attachment's attached file.
 960   *
 961   * If the attached file is not present on the local filesystem (usually due to replication plugins),
 962   * then the url of the file is returned if url fopen is supported.
 963   *
 964   * @since 3.4.0
 965   * @access private
 966   *
 967   * @param string $attachment_id Attachment ID.
 968   * @param string $size Optional. Image size, defaults to 'full'.
 969   * @return string|false File path or url on success, false on failure.
 970   */
 971  function _load_image_to_edit_path( $attachment_id, $size = 'full' ) {
 972      $filepath = get_attached_file( $attachment_id );
 973  
 974      if ( $filepath && file_exists( $filepath ) ) {
 975          if ( 'full' !== $size ) {
 976              $data = image_get_intermediate_size( $attachment_id, $size );
 977  
 978              if ( $data ) {
 979                  $filepath = path_join( dirname( $filepath ), $data['file'] );
 980  
 981                  /**
 982                   * Filters the path to the current image.
 983                   *
 984                   * The filter is evaluated for all image sizes except 'full'.
 985                   *
 986                   * @since 3.1.0
 987                   *
 988                   * @param string $path          Path to the current image.
 989                   * @param string $attachment_id Attachment ID.
 990                   * @param string $size          Size of the image.
 991                   */
 992                  $filepath = apply_filters( 'load_image_to_edit_filesystempath', $filepath, $attachment_id, $size );
 993              }
 994          }
 995      } elseif ( function_exists( 'fopen' ) && ini_get( 'allow_url_fopen' ) ) {
 996          /**
 997           * Filters the image URL if not in the local filesystem.
 998           *
 999           * The filter is only evaluated if fopen is enabled on the server.
1000           *
1001           * @since 3.1.0
1002           *
1003           * @param string $image_url     Current image URL.
1004           * @param string $attachment_id Attachment ID.
1005           * @param string $size          Size of the image.
1006           */
1007          $filepath = apply_filters( 'load_image_to_edit_attachmenturl', wp_get_attachment_url( $attachment_id ), $attachment_id, $size );
1008      }
1009  
1010      /**
1011       * Filters the returned path or URL of the current image.
1012       *
1013       * @since 2.9.0
1014       *
1015       * @param string|bool $filepath      File path or URL to current image, or false.
1016       * @param string      $attachment_id Attachment ID.
1017       * @param string      $size          Size of the image.
1018       */
1019      return apply_filters( 'load_image_to_edit_path', $filepath, $attachment_id, $size );
1020  }
1021  
1022  /**
1023   * Copy an existing image file.
1024   *
1025   * @since 3.4.0
1026   * @access private
1027   *
1028   * @param string $attachment_id Attachment ID.
1029   * @return string|false New file path on success, false on failure.
1030   */
1031  function _copy_image_file( $attachment_id ) {
1032      $dst_file = get_attached_file( $attachment_id );
1033      $src_file = $dst_file;
1034  
1035      if ( ! file_exists( $src_file ) ) {
1036          $src_file = _load_image_to_edit_path( $attachment_id );
1037      }
1038  
1039      if ( $src_file ) {
1040          $dst_file = str_replace( wp_basename( $dst_file ), 'copy-' . wp_basename( $dst_file ), $dst_file );
1041          $dst_file = dirname( $dst_file ) . '/' . wp_unique_filename( dirname( $dst_file ), wp_basename( $dst_file ) );
1042  
1043          /*
1044           * The directory containing the original file may no longer
1045           * exist when using a replication plugin.
1046           */
1047          wp_mkdir_p( dirname( $dst_file ) );
1048  
1049          if ( ! copy( $src_file, $dst_file ) ) {
1050              $dst_file = false;
1051          }
1052      } else {
1053          $dst_file = false;
1054      }
1055  
1056      return $dst_file;
1057  }


Generated: Fri Jan 24 01:00:03 2020 Cross-referenced by PHPXref 0.7.1