Fix doc blocks for `media*.php`
See #32444. Built from https://develop.svn.wordpress.org/trunk@32609 git-svn-id: http://core.svn.wordpress.org/trunk@32579 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Scott Taylor
parent
5845a0c372
commit
4bf8e158ec
|
|
@ -136,6 +136,8 @@ function wp_underscore_video_template() {
|
|||
* Prints the templates used in the media manager.
|
||||
*
|
||||
* @since 3.5.0
|
||||
*
|
||||
* @global bool $is_IE
|
||||
*/
|
||||
function wp_print_media_templates() {
|
||||
global $is_IE;
|
||||
|
|
|
|||
|
|
@ -26,6 +26,9 @@
|
|||
*
|
||||
* @since 2.5.0
|
||||
*
|
||||
* @global int $content_width
|
||||
* @global array $_wp_additional_image_sizes
|
||||
*
|
||||
* @param int $width Width of the image in pixels.
|
||||
* @param int $height Height of the image in pixels.
|
||||
* @param string|array $size Optional. Size or array of sizes of what the result image
|
||||
|
|
@ -145,7 +148,7 @@ function image_hwstring( $width, $height ) {
|
|||
* @param int $id Attachment ID for image.
|
||||
* @param array|string $size Optional. Image size to scale to. Accepts a registered image size
|
||||
* or flat array of height and width values. Default 'medium'.
|
||||
* @return bool|array False on failure, array on success.
|
||||
* @return false|array False on failure, array on success.
|
||||
*/
|
||||
function image_downsize( $id, $size = 'medium' ) {
|
||||
|
||||
|
|
@ -242,6 +245,8 @@ function add_image_size( $name, $width = 0, $height = 0, $crop = false ) {
|
|||
*
|
||||
* @since 3.9.0
|
||||
*
|
||||
* @global array $_wp_additional_image_sizes
|
||||
*
|
||||
* @param string $name The image size to check.
|
||||
* @return bool True if the image size exists, false if not.
|
||||
*/
|
||||
|
|
@ -256,6 +261,8 @@ function has_image_size( $name ) {
|
|||
*
|
||||
* @since 3.9.0
|
||||
*
|
||||
* @global array $_wp_additional_image_sizes
|
||||
*
|
||||
* @param string $name The image size to remove.
|
||||
* @return bool True if the image size was successfully removed, false on failure.
|
||||
*/
|
||||
|
|
@ -343,9 +350,7 @@ function get_image_tag( $id, $alt, $title, $align, $size = 'medium' ) {
|
|||
* @param string $align Part of the class name for aligning the image.
|
||||
* @param string $size Optional. Default is 'medium'.
|
||||
*/
|
||||
$html = apply_filters( 'get_image_tag', $html, $id, $alt, $title, $align, $size );
|
||||
|
||||
return $html;
|
||||
return apply_filters( 'get_image_tag', $html, $id, $alt, $title, $align, $size );
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -445,7 +450,7 @@ function wp_constrain_dimensions( $current_width, $current_height, $max_width =
|
|||
* @param int $dest_h New height in pixels.
|
||||
* @param bool|array $crop Optional. Whether to crop image to specified height and width or resize.
|
||||
* An array can specify positioning of the crop area. Default false.
|
||||
* @return bool|array False on failure. Returned array matches parameters for `imagecopyresampled()`.
|
||||
* @return false|array False on failure. Returned array matches parameters for `imagecopyresampled()`.
|
||||
*/
|
||||
function image_resize_dimensions($orig_w, $orig_h, $dest_w, $dest_h, $crop = false) {
|
||||
|
||||
|
|
@ -551,7 +556,7 @@ function image_resize_dimensions($orig_w, $orig_h, $dest_w, $dest_h, $crop = fal
|
|||
* @param int $height Image height.
|
||||
* @param bool $crop Optional. Whether to crop image to specified height and width or resize.
|
||||
* Default false.
|
||||
* @return bool|array False, if no image was created. Metadata array on success.
|
||||
* @return false|array False, if no image was created. Metadata array on success.
|
||||
*/
|
||||
function image_make_intermediate_size( $file, $width, $height, $crop = false ) {
|
||||
if ( $width || $height ) {
|
||||
|
|
@ -594,7 +599,7 @@ function image_make_intermediate_size( $file, $width, $height, $crop = false ) {
|
|||
* @param int $post_id Attachment ID.
|
||||
* @param array|string $size Optional. Registered image size to retrieve or flat array of height
|
||||
* and width dimensions. Default 'thumbnail'.
|
||||
* @return bool|array False on failure or array of file path, width, and height on success.
|
||||
* @return false|array False on failure or array of file path, width, and height on success.
|
||||
*/
|
||||
function image_get_intermediate_size( $post_id, $size = 'thumbnail' ) {
|
||||
if ( !is_array( $imagedata = wp_get_attachment_metadata( $post_id ) ) )
|
||||
|
|
@ -685,7 +690,7 @@ function get_intermediate_image_sizes() {
|
|||
* @param string|array $size Optional. Registered image size to retrieve the source for or a flat
|
||||
* array of height and width dimensions. Default 'thumbnail'.
|
||||
* @param bool $icon Optional. Whether the image should be treated as an icon. Default false.
|
||||
* @return bool|array Returns an array (url, width, height), or false, if no image is available.
|
||||
* @return false|array Returns an array (url, width, height), or false, if no image is available.
|
||||
*/
|
||||
function wp_get_attachment_image_src( $attachment_id, $size = 'thumbnail', $icon = false ) {
|
||||
|
||||
|
|
@ -725,7 +730,6 @@ function wp_get_attachment_image_src( $attachment_id, $size = 'thumbnail', $icon
|
|||
* @return string HTML img element or empty string on failure.
|
||||
*/
|
||||
function wp_get_attachment_image($attachment_id, $size = 'thumbnail', $icon = false, $attr = '') {
|
||||
|
||||
$html = '';
|
||||
$image = wp_get_attachment_image_src($attachment_id, $size, $icon);
|
||||
if ( $image ) {
|
||||
|
|
@ -926,6 +930,8 @@ add_shortcode('gallery', 'gallery_shortcode');
|
|||
*
|
||||
* @since 2.5.0
|
||||
*
|
||||
* @staticvar int $instance
|
||||
*
|
||||
* @param array $attr {
|
||||
* Attributes of the gallery shortcode.
|
||||
*
|
||||
|
|
@ -1199,6 +1205,9 @@ function wp_playlist_scripts( $type ) {
|
|||
*
|
||||
* @since 3.9.0
|
||||
*
|
||||
* @global int $content_width
|
||||
* @staticvar int $instance
|
||||
*
|
||||
* @param array $attr {
|
||||
* Array of default playlist attributes.
|
||||
*
|
||||
|
|
@ -1519,6 +1528,8 @@ function wp_get_attachment_id3_keys( $attachment, $context = 'display' ) {
|
|||
*
|
||||
* @since 3.6.0
|
||||
*
|
||||
* @staticvar int $instance
|
||||
*
|
||||
* @param array $attr {
|
||||
* Attributes of the audio shortcode.
|
||||
*
|
||||
|
|
@ -1531,7 +1542,7 @@ function wp_get_attachment_id3_keys( $attachment, $context = 'display' ) {
|
|||
* @type string $style The 'style' attribute for the `<audio>` element. Default 'width: 100%'.
|
||||
* }
|
||||
* @param string $content Shortcode content.
|
||||
* @return string HTML content to display audio.
|
||||
* @return string|void HTML content to display audio.
|
||||
*/
|
||||
function wp_audio_shortcode( $attr, $content = '' ) {
|
||||
$post_id = get_post() ? get_the_ID() : 0;
|
||||
|
|
@ -1712,6 +1723,9 @@ function wp_get_video_extensions() {
|
|||
*
|
||||
* @since 3.6.0
|
||||
*
|
||||
* @global int $content_width
|
||||
* @staticvar int $instance
|
||||
*
|
||||
* @param array $attr {
|
||||
* Attributes of the shortcode.
|
||||
*
|
||||
|
|
@ -1729,7 +1743,7 @@ function wp_get_video_extensions() {
|
|||
* Default 'video-{$post_id}-{$instance}'.
|
||||
* }
|
||||
* @param string $content Shortcode content.
|
||||
* @return string HTML content to display video.
|
||||
* @return string|void HTML content to display video.
|
||||
*/
|
||||
function wp_video_shortcode( $attr, $content = '' ) {
|
||||
global $content_width;
|
||||
|
|
@ -1949,7 +1963,6 @@ add_shortcode( 'video', 'wp_video_shortcode' );
|
|||
* @param string|array $size Optional. Registered image size or flat array of height and width dimensions.
|
||||
* 0 or 'none' will default to 'post_title' or `$text`. Default 'thumbnail'.
|
||||
* @param string $text Optional. Link text. Default false.
|
||||
* @return string HTML output for the previous image link.
|
||||
*/
|
||||
function previous_image_link( $size = 'thumbnail', $text = false ) {
|
||||
adjacent_image_link(true, $size, $text);
|
||||
|
|
@ -1965,7 +1978,6 @@ function previous_image_link( $size = 'thumbnail', $text = false ) {
|
|||
* @param string|array $size Optional. Registered image size or flat array of height and width dimensions.
|
||||
* 0 or 'none' will default to 'post_title' or `$text`. Default 'thumbnail'.
|
||||
* @param string $text Optional. Link text. Default false.
|
||||
* @return string HTML output for the next image link.
|
||||
*/
|
||||
function next_image_link($size = 'thumbnail', $text = false) {
|
||||
adjacent_image_link(false, $size, $text);
|
||||
|
|
@ -1982,7 +1994,6 @@ function next_image_link($size = 'thumbnail', $text = false) {
|
|||
* @param string|array $size Optional. Registered image size or flat array of height and width dimensions.
|
||||
* Default 'thumbnail'.
|
||||
* @param bool $text Optional. Link text. Default false.
|
||||
* @return string The adjacent image link.
|
||||
*/
|
||||
function adjacent_image_link( $prev = true, $size = 'thumbnail', $text = false ) {
|
||||
$post = get_post();
|
||||
|
|
@ -2120,7 +2131,7 @@ function wp_imagecreatetruecolor($width, $height) {
|
|||
*
|
||||
* @since 2.9.0
|
||||
*
|
||||
* @see WP_Embed::register_handler()
|
||||
* @global WP_Embed $wp_embed
|
||||
*
|
||||
* @param string $id An internal ID/name for the handler. Needs to be unique.
|
||||
* @param string $regex The regex that will be used to see if this handler should be used for a URL.
|
||||
|
|
@ -2138,7 +2149,7 @@ function wp_embed_register_handler( $id, $regex, $callback, $priority = 10 ) {
|
|||
*
|
||||
* @since 2.9.0
|
||||
*
|
||||
* @see WP_Embed::unregister_handler()
|
||||
* @global WP_Embed $wp_embed
|
||||
*
|
||||
* @param string $id The handler ID that should be removed.
|
||||
* @param int $priority Optional. The priority of the handler to be removed. Default 10.
|
||||
|
|
@ -2160,6 +2171,8 @@ function wp_embed_unregister_handler( $id, $priority = 10 ) {
|
|||
*
|
||||
* @since 2.9.0
|
||||
*
|
||||
* @global int $content_width
|
||||
*
|
||||
* @param string $url Optional. The URL that should be embedded. Default empty.
|
||||
*
|
||||
* @return array Default embed parameters.
|
||||
|
|
@ -2366,6 +2379,8 @@ function wp_embed_handler_googlevideo( $matches, $attr, $url, $rawattr ) {
|
|||
*
|
||||
* @since 4.0.0
|
||||
*
|
||||
* @global WP_Embed $wp_embed
|
||||
*
|
||||
* @param array $matches The RegEx matches from the provided regex when calling
|
||||
* wp_embed_register_handler().
|
||||
* @param array $attr Embed attributes.
|
||||
|
|
@ -2552,7 +2567,7 @@ function wp_image_editor_supports( $args = array() ) {
|
|||
* @since 3.5.0
|
||||
*
|
||||
* @param array $args Optional. Array of arguments for choosing a capable editor. Default empty array.
|
||||
* @return string|bool Class name for the first editor that claims to support the request. False if no
|
||||
* @return string|false Class name for the first editor that claims to support the request. False if no
|
||||
* editor claims to support the request.
|
||||
*/
|
||||
function _wp_image_editor_choose( $args = array() ) {
|
||||
|
|
@ -2598,7 +2613,7 @@ function _wp_image_editor_choose( $args = array() ) {
|
|||
* @since 3.4.0
|
||||
*/
|
||||
function wp_plupload_default_settings() {
|
||||
global $wp_scripts;
|
||||
$wp_scripts = wp_scripts();
|
||||
|
||||
$data = $wp_scripts->get_data( 'wp-plupload', 'data' );
|
||||
if ( $data && false !== strpos( $data, '_wpPluploadSettings' ) )
|
||||
|
|
@ -2673,7 +2688,7 @@ function wp_plupload_default_settings() {
|
|||
* @since 3.5.0
|
||||
*
|
||||
* @param mixed $attachment Attachment ID or object.
|
||||
* @return array Array of attachment details.
|
||||
* @return array|void Array of attachment details.
|
||||
*/
|
||||
function wp_prepare_attachment_for_js( $attachment ) {
|
||||
if ( ! $attachment = get_post( $attachment ) )
|
||||
|
|
@ -2866,15 +2881,17 @@ function wp_prepare_attachment_for_js( $attachment ) {
|
|||
*
|
||||
* @since 3.5.0
|
||||
*
|
||||
* @global int $content_width
|
||||
* @global wpdb $wpdb
|
||||
* @global WP_Locale $wp_locale
|
||||
*
|
||||
* @param array $args {
|
||||
* Arguments for enqueuing media scripts.
|
||||
*
|
||||
* @type int|WP_Post A post object or ID.
|
||||
* }
|
||||
* @return array List of media view settings.
|
||||
*/
|
||||
function wp_enqueue_media( $args = array() ) {
|
||||
|
||||
// Enqueue me just once per page, please.
|
||||
if ( did_action( 'wp_enqueue_media' ) )
|
||||
return;
|
||||
|
|
@ -3427,7 +3444,7 @@ function attachment_url_to_postid( $url ) {
|
|||
*
|
||||
* @since 4.0.0
|
||||
*
|
||||
* @global $wp_version
|
||||
* @global string $wp_version
|
||||
*
|
||||
* @return array The relevant CSS file URLs.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
*
|
||||
* @global string $wp_version
|
||||
*/
|
||||
$wp_version = '4.3-alpha-32608';
|
||||
$wp_version = '4.3-alpha-32609';
|
||||
|
||||
/**
|
||||
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.
|
||||
|
|
|
|||
Loading…
Reference in New Issue