| [ Index ] |
PHP Cross Reference of WordPress |
[Source view] [Print] [Project Stats]
File contains all the administration image manipulation functions.
| File Size: | 1157 lines (39 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
| wp_crop_image( $src, $src_x, $src_y, $src_w, $src_h, $dst_w, $dst_h, $src_abs = false, $dst_file = false ) X-Ref |
| Crops an image to a given size. 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: bool|false $src_abs Optional. If the source crop points are absolute. param: string|false $dst_file Optional. The destination file to write to. return: string|WP_Error New filepath on success, WP_Error on failure. since: 2.1.0 |
| 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. param: int $attachment_id The image attachment post ID. return: array[] Associative array of arrays of image sub-size information for since: 5.3.0 |
| 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. param: int $attachment_id The image attachment post ID. return: array|WP_Error The updated image meta data array or WP_Error object since: 5.3.0 |
| _wp_image_meta_replace_original( $saved_data, $original_file, $image_meta, $attachment_id ) X-Ref |
| Updates the attached file and image meta data when the original image was edited. param: array $saved_data The data returned from WP_Image_Editor after successfully saving an image. param: string $original_file Path to the original file. param: array $image_meta The image meta data. param: int $attachment_id The attachment post ID. return: array The updated image meta data. since: 5.3.0 |
| 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. param: string $file Full path to the image file. param: int $attachment_id Attachment ID to process. return: array The image attachment meta data. since: 5.3.0 |
| _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. 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. return: array The attachment meta data with updated `sizes` array. Includes an array of errors encountered while resizing. since: 5.3.0 |
| wp_generate_attachment_metadata( $attachment_id, $file ) X-Ref |
| Generate attachment meta data and create image sub-sizes for images. param: int $attachment_id Attachment ID to process. param: string $file Filepath of the attached image. return: array Metadata for attachment. since: 2.1.0 |
| wp_exif_frac2dec( $str ) X-Ref |
| Convert a fraction string to a decimal. param: string $str Fraction string. return: int|float Returns calculated fraction or integer 0 on invalid input. since: 2.5.0 |
| wp_exif_date2ts( $str ) X-Ref |
| Convert the exif date format to a unix timestamp. param: string $str A date string expected to be in Exif format (Y:m:d H:i:s). return: int|false The unix timestamp, or false on failure. since: 2.5.0 |
| 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. param: string $file return: array|false Image metadata array on success, false on failure. since: 2.5.0 |
| file_is_valid_image( $path ) X-Ref |
| Validate that file is an image. param: string $path File path to test if valid image. return: bool True if valid image, false if not valid image. since: 2.5.0 |
| file_is_displayable_image( $path ) X-Ref |
| Validate that file is suitable for displaying within a web page. param: string $path File path to test. return: bool True if suitable, false if not suitable. since: 2.5.0 |
| load_image_to_edit( $attachment_id, $mime_type, $size = 'full' ) X-Ref |
| Load an image resource for editing. param: int $attachment_id Attachment ID. param: string $mime_type Image mime type. param: string|int[] $size Optional. Image size. Accepts any registered image size name, or an array return: resource|GdImage|false The resulting image resource or GdImage instance on success, since: 2.9.0 |
| _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 `allow_url_fopen` is supported. param: int $attachment_id Attachment ID. param: string|int[] $size Optional. Image size. Accepts any registered image size name, or an array return: string|false File path or URL on success, false on failure. since: 3.4.0 |
| _copy_image_file( $attachment_id ) X-Ref |
| Copy an existing image file. param: int $attachment_id Attachment ID. return: string|false New file path on success, false on failure. since: 3.4.0 |
| Generated: Sun Dec 22 01:00:02 2024 | Cross-referenced by PHPXref 0.7.1 |