Docs: Misc fixes and improvements in the Administration Media API docblocks, as per documentation standards.
See #54729. Built from https://develop.svn.wordpress.org/trunk@53229 git-svn-id: http://core.svn.wordpress.org/trunk@52818 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
parent
aab2815d58
commit
3d7603869b
|
@ -7,7 +7,7 @@
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Defines the default media upload tabs
|
* Defines the default media upload tabs.
|
||||||
*
|
*
|
||||||
* @since 2.5.0
|
* @since 2.5.0
|
||||||
*
|
*
|
||||||
|
@ -32,7 +32,7 @@ function media_upload_tabs() {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Adds the gallery tab back to the tabs array if post has image attachments
|
* Adds the gallery tab back to the tabs array if post has image attachments.
|
||||||
*
|
*
|
||||||
* @since 2.5.0
|
* @since 2.5.0
|
||||||
*
|
*
|
||||||
|
@ -612,7 +612,7 @@ function wp_iframe( $content_func, ...$args ) {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Adds the media button to the editor
|
* Adds the media button to the editor.
|
||||||
*
|
*
|
||||||
* @since 2.5.0
|
* @since 2.5.0
|
||||||
*
|
*
|
||||||
|
@ -1116,7 +1116,7 @@ function media_upload_library() {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Retrieve HTML for the image alignment radio buttons with the specified one checked.
|
* Retrieves HTML for the image alignment radio buttons with the specified one checked.
|
||||||
*
|
*
|
||||||
* @since 2.7.0
|
* @since 2.7.0
|
||||||
*
|
*
|
||||||
|
@ -1154,7 +1154,7 @@ function image_align_input_fields( $post, $checked = '' ) {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Retrieve HTML for the size radio buttons with the specified one checked.
|
* Retrieves HTML for the size radio buttons with the specified one checked.
|
||||||
*
|
*
|
||||||
* @since 2.7.0
|
* @since 2.7.0
|
||||||
*
|
*
|
||||||
|
@ -1232,7 +1232,7 @@ function image_size_input_fields( $post, $check = '' ) {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Retrieve HTML for the Link URL buttons with the default link type as specified.
|
* Retrieves HTML for the Link URL buttons with the default link type as specified.
|
||||||
*
|
*
|
||||||
* @since 2.7.0
|
* @since 2.7.0
|
||||||
*
|
*
|
||||||
|
@ -1266,7 +1266,7 @@ function image_link_input_fields( $post, $url_type = '' ) {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Output a textarea element for inputting an attachment caption.
|
* Outputs a textarea element for inputting an attachment caption.
|
||||||
*
|
*
|
||||||
* @since 3.4.0
|
* @since 3.4.0
|
||||||
*
|
*
|
||||||
|
@ -1486,7 +1486,7 @@ function get_attachment_fields_to_edit( $post, $errors = null ) {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Retrieve HTML for media items of post gallery.
|
* Retrieves HTML for media items of post gallery.
|
||||||
*
|
*
|
||||||
* The HTML markup retrieved will be created for the progress of SWF Upload
|
* The HTML markup retrieved will be created for the progress of SWF Upload
|
||||||
* component. Will also create link for showing and hiding the form to modify
|
* component. Will also create link for showing and hiding the form to modify
|
||||||
|
@ -1498,7 +1498,7 @@ function get_attachment_fields_to_edit( $post, $errors = null ) {
|
||||||
*
|
*
|
||||||
* @param int $post_id Post ID.
|
* @param int $post_id Post ID.
|
||||||
* @param array $errors Errors for attachment, if any.
|
* @param array $errors Errors for attachment, if any.
|
||||||
* @return string
|
* @return string HTML content for media items of post gallery.
|
||||||
*/
|
*/
|
||||||
function get_media_items( $post_id, $errors ) {
|
function get_media_items( $post_id, $errors ) {
|
||||||
$attachments = array();
|
$attachments = array();
|
||||||
|
@ -1543,7 +1543,7 @@ function get_media_items( $post_id, $errors ) {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Retrieve HTML form for modifying the image attachment.
|
* Retrieves HTML form for modifying the image attachment.
|
||||||
*
|
*
|
||||||
* @since 2.5.0
|
* @since 2.5.0
|
||||||
*
|
*
|
||||||
|
@ -2503,7 +2503,7 @@ function media_upload_type_url_form( $type = null, $errors = null, $id = null )
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Adds gallery form to upload iframe
|
* Adds gallery form to upload iframe.
|
||||||
*
|
*
|
||||||
* @since 2.5.0
|
* @since 2.5.0
|
||||||
*
|
*
|
||||||
|
@ -2877,12 +2877,12 @@ function media_upload_library_form( $errors ) {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Creates the form for external url
|
* Creates the form for external url.
|
||||||
*
|
*
|
||||||
* @since 2.7.0
|
* @since 2.7.0
|
||||||
*
|
*
|
||||||
* @param string $default_view
|
* @param string $default_view
|
||||||
* @return string the form html
|
* @return string HTML content of the form.
|
||||||
*/
|
*/
|
||||||
function wp_media_insert_url_form( $default_view = 'image' ) {
|
function wp_media_insert_url_form( $default_view = 'image' ) {
|
||||||
/** This filter is documented in wp-admin/includes/media.php */
|
/** This filter is documented in wp-admin/includes/media.php */
|
||||||
|
@ -3466,12 +3466,12 @@ function attachment_submitbox_metadata() {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Parse ID3v2, ID3v1, and getID3 comments to extract usable data
|
* Parses ID3v2, ID3v1, and getID3 comments to extract usable data.
|
||||||
*
|
*
|
||||||
* @since 3.6.0
|
* @since 3.6.0
|
||||||
*
|
*
|
||||||
* @param array $metadata An existing array with data
|
* @param array $metadata An existing array with data.
|
||||||
* @param array $data Data supplied by ID3 tags
|
* @param array $data Data supplied by ID3 tags.
|
||||||
*/
|
*/
|
||||||
function wp_add_id3_tag_data( &$metadata, $data ) {
|
function wp_add_id3_tag_data( &$metadata, $data ) {
|
||||||
foreach ( array( 'id3v2', 'id3v1' ) as $version ) {
|
foreach ( array( 'id3v2', 'id3v1' ) as $version ) {
|
||||||
|
@ -3511,7 +3511,7 @@ function wp_add_id3_tag_data( &$metadata, $data ) {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Retrieve metadata from a video file's ID3 tags
|
* Retrieves metadata from a video file's ID3 tags.
|
||||||
*
|
*
|
||||||
* @since 3.6.0
|
* @since 3.6.0
|
||||||
*
|
*
|
||||||
|
@ -3625,7 +3625,7 @@ function wp_read_video_metadata( $file ) {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Retrieve metadata from an audio file's ID3 tags.
|
* Retrieves metadata from an audio file's ID3 tags.
|
||||||
*
|
*
|
||||||
* @since 3.6.0
|
* @since 3.6.0
|
||||||
*
|
*
|
||||||
|
@ -3692,7 +3692,7 @@ function wp_read_audio_metadata( $file ) {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Parse creation date from media metadata.
|
* Parses creation date from media metadata.
|
||||||
*
|
*
|
||||||
* The getID3 library doesn't have a standard method for getting creation dates,
|
* The getID3 library doesn't have a standard method for getting creation dates,
|
||||||
* so the location of this data can vary based on the MIME type.
|
* so the location of this data can vary based on the MIME type.
|
||||||
|
|
|
@ -16,7 +16,7 @@
|
||||||
*
|
*
|
||||||
* @global string $wp_version
|
* @global string $wp_version
|
||||||
*/
|
*/
|
||||||
$wp_version = '6.0-beta2-53228';
|
$wp_version = '6.0-beta2-53229';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.
|
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.
|
||||||
|
|
Loading…
Reference in New Issue