Make WordPress Core


Ignore:
Timestamp:
10/10/2008 06:21:16 PM (16 years ago)
Author:
ryan
Message:

phpdoc for wp-admin. Props jacobsantos. see #7527

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/wp-admin/includes/image.php

    r9053 r9119  
    1414 * thumbnail will be created as a jpeg.
    1515 *
    16  * @since unknown
     16 * @since 1.2.0
    1717 *
    1818 * @param mixed $file Filename of the original image, Or attachment id.
     
    2828 * Crop an Image to a given size.
    2929 *
    30  * @internal Missing Long Description
    31  *
    32  * @since unknown
    33  *
    34  * @param string|int $src_file The source file or Attachment ID
     30 * @since 2.1.0
     31 *
     32 * @param string|int $src_file The source file or Attachment ID.
    3533 * @param int $src_x The start x position to crop from.
    3634 * @param int $src_y The start y position to crop from.
     
    7876
    7977/**
    80  * Generate post Image attachment Metadata.
    81  *
    82  * @internal Missing Long Description
    83  *
    84  * @since unknown
    85  *
    86  * @param int $attachment_id Attachment Id to process
    87  * @param string $file Filepath of the Attached image
    88  * @return mixed Metadata for attachment
     78 * Generate post image attachment meta data.
     79 *
     80 * @since 2.1.0
     81 *
     82 * @param int $attachment_id Attachment Id to process.
     83 * @param string $file Filepath of the Attached image.
     84 * @return mixed Metadata for attachment.
    8985 */
    9086function wp_generate_attachment_metadata( $attachment_id, $file ) {
     
    130126
    131127/**
    132  * Load an image which PHP Supports.
    133  *
    134  * @internal Missing Long Description
    135  *
    136  * @since unknown
     128 * Load an image from a string, if PHP supports it.
     129 *
     130 * @since 2.1.0
    137131 *
    138132 * @param string $file Filename of the image to load.
     
    160154
    161155/**
    162  * Calculated the new dimentions for downsampled images.
    163  *
    164  * @since unknown
     156 * Calculated the new dimentions for a downsampled image.
     157 *
     158 * @since 2.0.0
    165159 * @see wp_shrink_dimensions()
    166160 *
     
    168162 * @param int $height Current height of the image
    169163 * @return mixed Array(height,width) of shrunk dimensions.
    170  *
    171164 */
    172165function get_udims( $width, $height) {
     
    177170 * Calculates the new dimentions for a downsampled image.
    178171 *
    179  * @since unknown
     172 * @since 2.0.0
    180173 * @see wp_constrain_dimensions()
    181174 *
     
    185178 * @param int $hmax Maximum wanted height
    186179 * @return mixed Array(height,width) of shrunk dimensions.
    187  *
    188180 */
    189181function wp_shrink_dimensions( $width, $height, $wmax = 128, $hmax = 96 ) {
     
    194186 * Convert a fraction string to a decimal.
    195187 *
    196  * @since unknown
     188 * @since 2.5.0
    197189 *
    198190 * @param string $str
     
    209201 * Convert the exif date format to a unix timestamp.
    210202 *
    211  * @since unknown
     203 * @since 2.5.0
    212204 *
    213205 * @param string $str
     
    224216 * Get extended image metadata, exif or iptc as available.
    225217 *
    226  * @since unknown
     218 * Retrieves the EXIF metadata aperture, credit, camera, caption, copyright, iso
     219 * created_timestamp, focal_length, shutter_speed, and title.
     220 *
     221 * The IPTC metadata that is retrieved is APP13, credit, byline, created date
     222 * and time, caption, copyright, and title. Also includes FNumber, Model,
     223 * DateTimeDigitized, FocalLength, ISOSpeedRatings, and ExposureTime.
     224 *
     225 * @todo Try other exif libraries if available.
     226 * @since 2.5.0
    227227 *
    228228 * @param string $file
     
    289289            $meta['shutter_speed'] = wp_exif_frac2dec( $exif['ExposureTime'] );
    290290    }
    291     /** @todo FIXME: try other exif libraries if available */
    292291
    293292    return apply_filters( 'wp_read_image_metadata', $meta, $file, $sourceImageType );
     
    298297 * Validate that file is an image.
    299298 *
    300  * @since unknown
     299 * @since 2.5.0
    301300 *
    302301 * @param string $path File path to test if valid image.
     
    311310 * Validate that file is suitable for displaying within a web page.
    312311 *
    313  * @since unknown
     312 * @since 2.5.0
    314313 * @uses apply_filters() Calls 'file_is_displayable_image' on $result and $path.
    315314 *
Note: See TracChangeset for help on using the changeset viewer.