Make WordPress Core


Ignore:
Timestamp:
08/05/2022 02:05:20 PM (23 months ago)
Author:
audrasjb
Message:

Docs: Various docblock fixes in wp-admin/includes/image.php class, as per docs standards.

See #55646.

File:
1 edited

Legend:

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

    r53751 r53843  
    7272
    7373/**
    74  * Compare the existing image sub-sizes (as saved in the attachment meta)
    75  * to the currently registered image sub-sizes, and return the difference.
     74 * Compares the existing image sub-sizes (as saved in the attachment meta)
     75 * to the currently registered image sub-sizes, and returns the difference.
    7676 *
    7777 * Registered sub-sizes that are larger than the image are skipped.
     
    729729
    730730/**
    731  * Check if an image belongs to an attachment.
     731 * Checks if an image belongs to an attachment.
    732732 *
    733733 * @since 6.1.0
    734734 * @access private
    735735 *
    736  * @param string $filename     Full path to the image file.
    737  * @param int   $attachment_id Attachment ID to check.
     736 * @param string $filename      Full path to the image file.
     737 * @param int    $attachment_id Attachment ID to check.
    738738 * @return bool True if the image belongs to the attachment, false otherwise.
    739739 */
     
    761761
    762762/**
    763  * Generate attachment meta data and create image sub-sizes for images.
     763 * Generates attachment meta data and create image sub-sizes for images.
    764764 *
    765765 * @since 2.1.0
     
    846846                 *     Information about the newly-uploaded file.
    847847                 *
    848                  *     @type string $file  Filename of the newly-uploaded file.
    849                  *     @type string $url   URL of the uploaded file.
    850                  *     @type string $type  File type.
     848                 *     @type string $file Filename of the newly-uploaded file.
     849                 *     @type string $url  URL of the uploaded file.
     850                 *     @type string $type File type.
    851851                 * }
    852852                 */
     
    945945
    946946/**
    947  * Convert a fraction string to a decimal.
     947 * Converts a fraction string to a decimal.
    948948 *
    949949 * @since 2.5.0
     
    986986
    987987/**
    988  * Convert the exif date format to a unix timestamp.
     988 * Converts the exif date format to a unix timestamp.
    989989 *
    990990 * @since 2.5.0
     
    10011001
    10021002/**
    1003  * Get extended image metadata, exif or iptc as available.
     1003 * Gets extended image metadata, exif or iptc as available.
    10041004 *
    10051005 * Retrieves the EXIF metadata aperture, credit, camera, caption, copyright, iso
     
    12351235
    12361236/**
    1237  * Validate that file is an image.
     1237 * Validates that file is an image.
    12381238 *
    12391239 * @since 2.5.0
     
    12481248
    12491249/**
    1250  * Validate that file is suitable for displaying within a web page.
     1250 * Validates that file is suitable for displaying within a web page.
    12511251 *
    12521252 * @since 2.5.0
     
    12791279
    12801280/**
    1281  * Load an image resource for editing.
     1281 * Loads an image resource for editing.
    12821282 *
    12831283 * @since 2.9.0
     
    13401340
    13411341/**
    1342  * Retrieve the path or URL of an attachment's attached file.
     1342 * Retrieves the path or URL of an attachment's attached file.
    13431343 *
    13441344 * If the attached file is not present on the local filesystem (usually due to replication plugins),
     
    14081408
    14091409/**
    1410  * Copy an existing image file.
     1410 * Copies an existing image file.
    14111411 *
    14121412 * @since 3.4.0
     
    14551455 * @since 6.1.0
    14561456 *
    1457  * @param int    $attachment_id  The attachment ID.
     1457 * @param int    $attachment_id The attachment ID.
    14581458 * @return array An array of valid mime types, where the key is the source file mime type and the list of mime types to
    14591459 *               generate.
     
    14671467
    14681468    /**
    1469      * Filter the output mime types for a given input mime type and image size.
     1469     * Filters the output mime types for a given input mime type and image size.
    14701470     *
    14711471     * @since 6.1.0
    14721472     *
    1473      * @param array  $image_mime_transforms A map with the valid mime transforms where the key is the source file mime type
     1473     * @param array $image_mime_transforms A map with the valid mime transforms where the key is the source file mime type
    14741474     *                                      and the value is one or more mime file types to generate.
    1475      * @param int    $attachment_id         The ID of the attachment where the hook was dispatched.
     1475     * @param int   $attachment_id         The ID of the attachment where the hook was dispatched.
    14761476     */
    14771477    $image_mime_transforms = apply_filters( 'wp_upload_image_mime_transforms', $image_mime_transforms, $attachment_id );
     
    14901490
    14911491/**
    1492  * Extract the primary and additional mime output types for an image from the $image_mime_transforms.
     1492 * Extracts the primary and additional mime output types for an image from the $image_mime_transforms.
    14931493 *
    14941494 * @since 6.1.0
Note: See TracChangeset for help on using the changeset viewer.