[ Index ]

PHP Cross Reference of WordPress Trunk (Updated Daily)

title

Body

[close]

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

File contains all the administration image manipulation functions.

File Size: 1010 lines (33 kb)
Included or required: 3 times
Referenced: 0 times
Includes or requires: 0 files

Defines 15 functions

  wp_crop_image()
  wp_get_missing_image_subsizes()
  wp_update_image_subsizes()
  wp_create_image_subsizes()
  _wp_make_subsizes()
  wp_generate_attachment_metadata()
  wp_exif_frac2dec()
  wp_exif_date2ts()
  wp_read_image_metadata()
  file_is_valid_image()
  file_is_displayable_image()
  load_image_to_edit()
  _load_image_to_edit_path()
  _copy_image_file()
  wp_get_original_image_path()

Functions
Functions that are not part of a class:

wp_crop_image( $src, $src_x, $src_y, $src_w, $src_h, $dst_w, $dst_h, $src_abs = false, $dst_file = false )   X-Ref
Crop an Image to a given size.

return: string|WP_Error New filepath on success, WP_Error on failure.
param: string|int $src The source file or Attachment ID.
param: int $src_x The start x position to crop from.
param: int $src_y The start y position to crop from.
param: int $src_w The width to crop.
param: int $src_h The height to crop.
param: int $dst_w The destination width.
param: int $dst_h The destination height.
param: int $src_abs Optional. If the source crop points are absolute.
param: string $dst_file Optional. The destination file to write to.

wp_get_missing_image_subsizes( $attachment_id )   X-Ref
Compare the existing image sub-sizes (as saved in the attachment meta)
to the currently registered image sub-sizes, and return the difference.

Registered sub-sizes that are larger than the image are skipped.

return: array An array of the image sub-sizes that are currently defined but don't exist for this image.
param: int $attachment_id The image attachment post ID.

wp_update_image_subsizes( $attachment_id )   X-Ref
If any of the currently registered image sub-sizes are missing,
create them and update the image meta data.

return: array|WP_Error The updated image meta data array or WP_Error object
param: int $attachment_id The image attachment post ID.

wp_create_image_subsizes( $file, $attachment_id )   X-Ref
Creates image sub-sizes, adds the new data to the image meta `sizes` array, and updates the image metadata.

Intended for use after an image is uploaded. Saves/updates the image metadata after each
sub-size is created. If there was an error, it is added to the returned image metadata array.

return: array The image attachment meta data.
param: string $file          Full path to the image file.
param: int    $attachment_id Attachment Id to process.

_wp_make_subsizes( $new_sizes, $file, $image_meta, $attachment_id )   X-Ref
Low-level function to create image sub-sizes.

Updates the image meta after each sub-size is created.
Errors are stored in the returned image metadata array.

return: array The attachment meta data with updated `sizes` array. Includes an array of errors encountered while resizing.
param: array  $new_sizes     Array defining what sizes to create.
param: string $file          Full path to the image file.
param: array  $image_meta    The attachment meta data array.
param: int    $attachment_id Attachment Id to process.

wp_generate_attachment_metadata( $attachment_id, $file )   X-Ref
Generate attachment meta data and create image sub-sizes for images.

return: mixed Metadata for attachment.
param: int $attachment_id Attachment Id to process.
param: string $file Filepath of the Attached image.

wp_exif_frac2dec( $str )   X-Ref
Convert a fraction string to a decimal.

return: int|float
param: string $str

wp_exif_date2ts( $str )   X-Ref
Convert the exif date format to a unix timestamp.

return: int
param: string $str

wp_read_image_metadata( $file )   X-Ref
Get extended image metadata, exif or iptc as available.

Retrieves the EXIF metadata aperture, credit, camera, caption, copyright, iso
created_timestamp, focal_length, shutter_speed, and title.

The IPTC metadata that is retrieved is APP13, credit, byline, created date
and time, caption, copyright, and title. Also includes FNumber, Model,
DateTimeDigitized, FocalLength, ISOSpeedRatings, and ExposureTime.

return: bool|array False on failure. Image metadata array on success.
param: string $file

file_is_valid_image( $path )   X-Ref
Validate that file is an image.

return: bool True if valid image, false if not valid image.
param: string $path File path to test if valid image.

file_is_displayable_image( $path )   X-Ref
Validate that file is suitable for displaying within a web page.

return: bool True if suitable, false if not suitable.
param: string $path File path to test.

load_image_to_edit( $attachment_id, $mime_type, $size = 'full' )   X-Ref
Load an image resource for editing.

return: resource|false The resulting image resource on success, false on failure.
param: string $attachment_id Attachment ID.
param: string $mime_type Image mime type.
param: string $size Optional. Image size, defaults to 'full'.

_load_image_to_edit_path( $attachment_id, $size = 'full' )   X-Ref
Retrieve the path or url of an attachment's attached file.

If the attached file is not present on the local filesystem (usually due to replication plugins),
then the url of the file is returned if url fopen is supported.

return: string|false File path or url on success, false on failure.
param: string $attachment_id Attachment ID.
param: string $size Optional. Image size, defaults to 'full'.

_copy_image_file( $attachment_id )   X-Ref
Copy an existing image file.

return: string|false New file path on success, false on failure.
param: string $attachment_id Attachment ID.

wp_get_original_image_path( $attachment_id )   X-Ref
Retrieves the path to an uploaded image.

Similar to `get_attached_file()` however some images may have been
processed after uploading to make them "web ready".
In this case this function returns the path to the originally uploaded image file.

return: string|false Path to the original image file or false if the attachment is not an image.
param: int $attachment_id Attachment ID.



Generated: Thu Sep 19 08:20:01 2019 Cross-referenced by PHPXref 0.7