Make WordPress Core

Changeset 53229


Ignore:
Timestamp:
04/20/2022 08:28:00 AM (23 months ago)
Author:
audrasjb
Message:

Docs: Misc fixes and improvements in the Administration Media API docblocks, as per documentation standards.

See #54729.

File:
1 edited

Legend:

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

    r53228 r53229  
    88
    99/**
    10  * Defines the default media upload tabs
     10 * Defines the default media upload tabs.
    1111 *
    1212 * @since 2.5.0
     
    3333
    3434/**
    35  * Adds the gallery tab back to the tabs array if post has image attachments
     35 * Adds the gallery tab back to the tabs array if post has image attachments.
    3636 *
    3737 * @since 2.5.0
     
    613613
    614614/**
    615  * Adds the media button to the editor
     615 * Adds the media button to the editor.
    616616 *
    617617 * @since 2.5.0
     
    11171117
    11181118/**
    1119  * Retrieve HTML for the image alignment radio buttons with the specified one checked.
     1119 * Retrieves HTML for the image alignment radio buttons with the specified one checked.
    11201120 *
    11211121 * @since 2.7.0
     
    11551155
    11561156/**
    1157  * Retrieve HTML for the size radio buttons with the specified one checked.
     1157 * Retrieves HTML for the size radio buttons with the specified one checked.
    11581158 *
    11591159 * @since 2.7.0
     
    12331233
    12341234/**
    1235  * Retrieve HTML for the Link URL buttons with the default link type as specified.
     1235 * Retrieves HTML for the Link URL buttons with the default link type as specified.
    12361236 *
    12371237 * @since 2.7.0
     
    12671267
    12681268/**
    1269  * Output a textarea element for inputting an attachment caption.
     1269 * Outputs a textarea element for inputting an attachment caption.
    12701270 *
    12711271 * @since 3.4.0
     
    14871487
    14881488/**
    1489  * Retrieve HTML for media items of post gallery.
     1489 * Retrieves HTML for media items of post gallery.
    14901490 *
    14911491 * The HTML markup retrieved will be created for the progress of SWF Upload
     
    14991499 * @param int   $post_id Post ID.
    15001500 * @param array $errors  Errors for attachment, if any.
    1501  * @return string
     1501 * @return string HTML content for media items of post gallery.
    15021502 */
    15031503function get_media_items( $post_id, $errors ) {
     
    15441544
    15451545/**
    1546  * Retrieve HTML form for modifying the image attachment.
     1546 * Retrieves HTML form for modifying the image attachment.
    15471547 *
    15481548 * @since 2.5.0
     
    25042504
    25052505/**
    2506  * Adds gallery form to upload iframe
     2506 * Adds gallery form to upload iframe.
    25072507 *
    25082508 * @since 2.5.0
     
    28782878
    28792879/**
    2880  * Creates the form for external url
     2880 * Creates the form for external url.
    28812881 *
    28822882 * @since 2.7.0
    28832883 *
    28842884 * @param string $default_view
    2885  * @return string the form html
     2885 * @return string HTML content of the form.
    28862886 */
    28872887function wp_media_insert_url_form( $default_view = 'image' ) {
     
    34673467
    34683468/**
    3469  * Parse ID3v2, ID3v1, and getID3 comments to extract usable data
     3469 * Parses ID3v2, ID3v1, and getID3 comments to extract usable data.
    34703470 *
    34713471 * @since 3.6.0
    34723472 *
    3473  * @param array $metadata An existing array with data
    3474  * @param array $data Data supplied by ID3 tags
     3473 * @param array $metadata An existing array with data.
     3474 * @param array $data Data supplied by ID3 tags.
    34753475 */
    34763476function wp_add_id3_tag_data( &$metadata, $data ) {
     
    35123512
    35133513/**
    3514  * Retrieve metadata from a video file's ID3 tags
     3514 * Retrieves metadata from a video file's ID3 tags.
    35153515 *
    35163516 * @since 3.6.0
     
    36263626
    36273627/**
    3628  * Retrieve metadata from an audio file's ID3 tags.
     3628 * Retrieves metadata from an audio file's ID3 tags.
    36293629 *
    36303630 * @since 3.6.0
     
    36933693
    36943694/**
    3695  * Parse creation date from media metadata.
     3695 * Parses creation date from media metadata.
    36963696 *
    36973697 * The getID3 library doesn't have a standard method for getting creation dates,
Note: See TracChangeset for help on using the changeset viewer.