| [ Index ] |
PHP Cross Reference of WordPress |
[Source view] [Print] [Project Stats]
File contains all the administration image manipulation functions.
| File Size: | 456 lines (16 kb) |
| Included or required: | 2 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
| wp_create_thumbnail( $file, $max_side, $deprecated = '' ) X-Ref |
| Create a thumbnail from an Image given a maximum side size. This function can handle most image file formats which PHP supports. If PHP does not have the functionality to save in a file of the same format, the thumbnail will be created as a jpeg. param: mixed $file Filename of the original image, Or attachment id. param: int $max_side Maximum length of a single side for the thumbnail. param: mixed $deprecated Never used. return: string Thumbnail path on success, Error string on failure. |
| 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. 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. return: string|WP_Error|false New filepath on success, WP_Error or false on failure. |
| wp_generate_attachment_metadata( $attachment_id, $file ) X-Ref |
| Generate post thumbnail attachment meta data. param: int $attachment_id Attachment Id to process. param: string $file Filepath of the Attached image. return: mixed Metadata for attachment. |
| get_udims( $width, $height) X-Ref |
| Calculated the new dimensions for a downsampled image. param: int $width Current width of the image param: int $height Current height of the image return: mixed Array(height,width) of shrunk dimensions. |
| wp_exif_frac2dec($str) X-Ref |
| Convert a fraction string to a decimal. param: string $str return: int|float |
| wp_exif_date2ts($str) X-Ref |
| Convert the exif date format to a unix timestamp. param: string $str return: int |
| 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: bool|array False on failure. Image metadata array on success. |
| 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. |
| 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. |
| load_image_to_edit( $attachment_id, $mime_type, $size = 'full' ) X-Ref |
| Load an image resource for editing. param: string $attachment_id Attachment ID. param: string $mime_type Image mime type. param: string $size Optional. Image size, defaults to 'full'. return: resource|false The resulting image resource on success, false on failure. |
| _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. param: string $attachment_id Attachment ID. param: string $size Optional. Image size, defaults to 'full'. return: string|false File path or url on success, false on failure. |
| _copy_image_file( $attachment_id ) X-Ref |
| Copy an existing image file. param: string $attachment_id Attachment ID. return: string|false New file path on success, false on failure. |
| Generated: Fri May 25 03:56:23 2012 | Hosted by follow the white rabbit. |