sergiotarxz
/
Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Docs: Standardize filter docs in wp-includes/media.php to use third-person singular verbs per the inline documentation standards for PHP. 

See #36913.


git-svn-id: https://develop.svn.wordpress.org/trunk@37505 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2016-05-22 18:31:20 +00:00
parent 516fbd33b7
commit b9f3c04720
1 changed files with 46 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

92
src/wp-includes/media.php
View File

@ -95,7 +95,7 @@ function image_constrain_size_for_editor( $width, $height, $size = 'medium', $co
}
/**
* Filter the maximum image size dimensions for the editor.
* Filters the maximum image size dimensions for the editor.
*
* @since 2.5.0
*
@ -168,7 +168,7 @@ function image_downsize( $id, $size = 'medium' ) {
return false;
/**
* Filter whether to preempt the output of image_downsize().
* Filters whether to preempt the output of image_downsize().
*
* Passing a truthy value to the filter will effectively short-circuit
* down-sizing the image, returning that value as output instead.
@ -339,7 +339,7 @@ function get_image_tag( $id, $alt, $title, $align, $size = 'medium' ) {
$class = 'align' . esc_attr($align) .' size-' . esc_attr($size) . ' wp-image-' . $id;
/**
* Filter the value of the attachment's image tag class attribute.
* Filters the value of the attachment's image tag class attribute.
*
* @since 2.6.0
*
@ -354,7 +354,7 @@ function get_image_tag( $id, $alt, $title, $align, $size = 'medium' ) {
$html = '<img src="' . esc_attr($img_src) . '" alt="' . esc_attr($alt) . '" ' . $title . $hwstring . 'class="' . $class . '" />';
/**
* Filter the HTML content for the image tag.
* Filters the HTML content for the image tag.
*
* @since 2.6.0
*
@ -431,7 +431,7 @@ function wp_constrain_dimensions( $current_width, $current_height, $max_width =
}
/**
* Filter dimensions to constrain down-sampled images to.
* Filters dimensions to constrain down-sampled images to.
*
* @since 4.1.0
*
@ -477,7 +477,7 @@ function image_resize_dimensions( $orig_w, $orig_h, $dest_w, $dest_h, $crop = fa
return false;
/**
* Filter whether to preempt calculating the image resize dimensions.
* Filters whether to preempt calculating the image resize dimensions.
*
* Passing a non-null value to the filter will effectively short-circuit
* image_resize_dimensions(), returning that value instead.
@ -689,7 +689,7 @@ function image_get_intermediate_size( $post_id, $size = 'thumbnail' ) {
}
/**
* Filter the output of image_get_intermediate_size()
* Filters the output of image_get_intermediate_size()
*
* @since 4.4.0
*
@ -720,7 +720,7 @@ function get_intermediate_image_sizes() {
$image_sizes = array_merge( $image_sizes, array_keys( $_wp_additional_image_sizes ) );
/**
* Filter the list of intermediate image sizes.
* Filters the list of intermediate image sizes.
*
* @since 2.5.0
*
@ -767,7 +767,7 @@ function wp_get_attachment_image_src( $attachment_id, $size = 'thumbnail', $icon
}
}
/**
* Filter the image src result.
* Filters the image src result.
*
* @since 4.3.0
*
@ -840,7 +840,7 @@ function wp_get_attachment_image($attachment_id, $size = 'thumbnail', $icon = fa
}
/**
* Filter the list of attachment image attributes.
* Filters the list of attachment image attributes.
*
* @since 2.8.0
*
@ -1043,7 +1043,7 @@ function wp_calculate_image_srcset( $size_array, $image_src, $image_meta, $attac
$image_edited = preg_match( '/-e[0-9]{13}/', wp_basename( $image_src ), $image_edit_hash );
/**
* Filter the maximum image width to be included in a 'srcset' attribute.
* Filters the maximum image width to be included in a 'srcset' attribute.
*
* @since 4.4.0
*
@ -1085,7 +1085,7 @@ function wp_calculate_image_srcset( $size_array, $image_src, $image_meta, $attac
}
/*
* Filter out images that are wider than '$max_srcset_image_width' unless
* Filters out images that are wider than '$max_srcset_image_width' unless
* that file is in the 'src' attribute.
*/
if ( $max_srcset_image_width && $image['width'] > $max_srcset_image_width && ! $is_src ) {
@ -1124,7 +1124,7 @@ function wp_calculate_image_srcset( $size_array, $image_src, $image_meta, $attac
}
/**
* Filter an image's 'srcset' sources.
* Filters an image's 'srcset' sources.
*
* @since 4.4.0
*
@ -1232,7 +1232,7 @@ function wp_calculate_image_sizes( $size, $image_src = null, $image_meta = null,
$sizes = sprintf( '(max-width: %1$dpx) 100vw, %1$dpx', $width );
/**
* Filter the output of 'wp_calculate_image_sizes()'.
* Filters the output of 'wp_calculate_image_sizes()'.
*
* @since 4.4.0
*
@ -1467,7 +1467,7 @@ function img_caption_shortcode( $attr, $content = null ) {
}
/**
* Filter the default caption shortcode output.
* Filters the default caption shortcode output.
*
* If the filtered output isn't empty, it will be used instead of generating
* the default caption template.
@ -1506,7 +1506,7 @@ function img_caption_shortcode( $attr, $content = null ) {
$width = $html5 ? $atts['width'] : ( 10 + $atts['width'] );
/**
* Filter the width of an image's caption.
* Filters the width of an image's caption.
*
* By default, the caption is 10 pixels greater than the width of the image,
* to prevent post content from running up against a floated image.
@ -1589,7 +1589,7 @@ function gallery_shortcode( $attr ) {
}
/**
* Filter the default gallery shortcode output.
* Filters the default gallery shortcode output.
*
* If the filtered output isn't empty, it will be used instead of generating
* the default gallery template.
@ -1673,7 +1673,7 @@ function gallery_shortcode( $attr ) {
$gallery_style = '';
/**
* Filter whether to print default gallery styles.
* Filters whether to print default gallery styles.
*
* @since 3.1.0
*
@ -1707,7 +1707,7 @@ function gallery_shortcode( $attr ) {
$gallery_div = "<div id='$selector' class='gallery galleryid-{$id} gallery-columns-{$columns} gallery-size-{$size_class}'>";
/**
* Filter the default gallery shortcode CSS styles.
* Filters the default gallery shortcode CSS styles.
*
* @since 2.5.0
*
@ -1875,7 +1875,7 @@ function wp_playlist_shortcode( $attr ) {
}
/**
* Filter the playlist output.
* Filters the playlist output.
*
* Passing a non-empty value to the filter will short-circuit generation
* of the default playlist output, returning the passed value instead.
@ -2081,7 +2081,7 @@ add_shortcode( 'playlist', 'wp_playlist_shortcode' );
*/
function wp_mediaelement_fallback( $url ) {
/**
* Filter the Mediaelement fallback output for no-JS.
* Filters the Mediaelement fallback output for no-JS.
*
* @since 3.6.0
*
@ -2100,7 +2100,7 @@ function wp_mediaelement_fallback( $url ) {
*/
function wp_get_audio_extensions() {
/**
* Filter the list of supported audio formats.
* Filters the list of supported audio formats.
*
* @since 3.6.0
*
@ -2135,7 +2135,7 @@ function wp_get_attachment_id3_keys( $attachment, $context = 'display' ) {
}
/**
* Filter the editable list of keys to look up data from an attachment's metadata.
* Filters the editable list of keys to look up data from an attachment's metadata.
*
* @since 3.9.0
*
@ -2175,7 +2175,7 @@ function wp_audio_shortcode( $attr, $content = '' ) {
$instance++;
/**
* Filter the default audio shortcode output.
* Filters the default audio shortcode output.
*
* If the filtered output isn't empty, it will be used instead of generating the default audio template.
*
@ -2243,7 +2243,7 @@ function wp_audio_shortcode( $attr, $content = '' ) {
}
/**
* Filter the media library used for the audio shortcode.
* Filters the media library used for the audio shortcode.
*
* @since 3.6.0
*
@ -2256,7 +2256,7 @@ function wp_audio_shortcode( $attr, $content = '' ) {
}
/**
* Filter the class attribute for the audio shortcode output container.
* Filters the class attribute for the audio shortcode output container.
*
* @since 3.6.0
*
@ -2310,7 +2310,7 @@ function wp_audio_shortcode( $attr, $content = '' ) {
$html .= '</audio>';
/**
* Filter the audio shortcode output.
* Filters the audio shortcode output.
*
* @since 3.6.0
*
@ -2333,7 +2333,7 @@ add_shortcode( 'audio', 'wp_audio_shortcode' );
*/
function wp_get_video_extensions() {
/**
* Filter the list of supported video formats.
* Filters the list of supported video formats.
*
* @since 3.6.0
*
@ -2379,7 +2379,7 @@ function wp_video_shortcode( $attr, $content = '' ) {
$instance++;
/**
* Filter the default video shortcode output.
* Filters the default video shortcode output.
*
* If the filtered output isn't empty, it will be used instead of generating
* the default video template.
@ -2480,7 +2480,7 @@ function wp_video_shortcode( $attr, $content = '' ) {
}
/**
* Filter the media library used for the video shortcode.
* Filters the media library used for the video shortcode.
*
* @since 3.6.0
*
@ -2493,7 +2493,7 @@ function wp_video_shortcode( $attr, $content = '' ) {
}
/**
* Filter the class attribute for the video shortcode output container.
* Filters the class attribute for the video shortcode output container.
*
* @since 3.6.0
*
@ -2568,7 +2568,7 @@ function wp_video_shortcode( $attr, $content = '' ) {
$output = sprintf( '<div style="%s" class="wp-video">%s</div>', $width_rule, $html );
/**
* Filter the output of the video shortcode.
* Filters the output of the video shortcode.
*
* @since 3.6.0
*
@ -2651,7 +2651,7 @@ function adjacent_image_link( $prev = true, $size = 'thumbnail', $text = false )
$adjacent = $prev ? 'previous' : 'next';
/**
* Filter the adjacent image link.
* Filters the adjacent image link.
*
* The dynamic portion of the hook name, `$adjacent`, refers to the type of adjacency,
* either 'next', or 'previous'.
@ -2810,7 +2810,7 @@ function wp_max_upload_size() {
$p_bytes = wp_convert_hr_to_bytes( ini_get( 'post_max_size' ) );
/**
* Filter the maximum upload size allowed in php.ini.
* Filters the maximum upload size allowed in php.ini.
*
* @since 2.5.0
*
@ -2888,7 +2888,7 @@ function _wp_image_editor_choose( $args = array() ) {
require_once ABSPATH . WPINC . '/class-wp-image-editor-imagick.php';
/**
* Filter the list of image editing library classes.
* Filters the list of image editing library classes.
*
* @since 3.5.0
*
@ -2953,7 +2953,7 @@ function wp_plupload_default_settings() {
}
/**
* Filter the Plupload default settings.
* Filters the Plupload default settings.
*
* @since 3.4.0
*
@ -2966,7 +2966,7 @@ function wp_plupload_default_settings() {
);
/**
* Filter the Plupload default parameters.
* Filters the Plupload default parameters.
*
* @since 3.4.0
*
@ -3184,7 +3184,7 @@ function wp_prepare_attachment_for_js( $attachment ) {
$response['compat'] = get_compat_media_markup( $attachment->ID, array( 'in_modal' => true ) );
/**
* Filter the attachment data prepared for JavaScript.
* Filters the attachment data prepared for JavaScript.
*
* @since 3.5.0
*
@ -3455,7 +3455,7 @@ function wp_enqueue_media( $args = array() ) {
);
/**
* Filter the media view settings.
* Filters the media view settings.
*
* @since 3.5.0
*
@ -3465,7 +3465,7 @@ function wp_enqueue_media( $args = array() ) {
$settings = apply_filters( 'media_view_settings', $settings, $post );
/**
* Filter the media view strings.
* Filters the media view strings.
*
* @since 3.5.0
*
@ -3526,7 +3526,7 @@ function get_attached_media( $type, $post = 0 ) {
);
/**
* Filter arguments used to retrieve media attached to the given post.
* Filters arguments used to retrieve media attached to the given post.
*
* @since 3.6.0
*
@ -3539,7 +3539,7 @@ function get_attached_media( $type, $post = 0 ) {
$children = get_children( $args );
/**
* Filter the list of media attached to the given post.
* Filters the list of media attached to the given post.
*
* @since 3.6.0
*
@ -3563,7 +3563,7 @@ function get_media_embedded_in_content( $content, $types = null ) {
$html = array();
/**
* Filter the embedded media types that are allowed to be returned from the content blob.
* Filters the embedded media types that are allowed to be returned from the content blob.
*
* @since 4.2.0
*
@ -3633,7 +3633,7 @@ function get_post_galleries( $post, $html = true ) {
}
/**
* Filter the list of all found galleries in the given post.
* Filters the list of all found galleries in the given post.
*
* @since 3.6.0
*
@ -3657,7 +3657,7 @@ function get_post_gallery( $post = 0, $html = true ) {
$gallery = reset( $galleries );
/**
* Filter the first-found post gallery.
* Filters the first-found post gallery.
*
* @since 3.6.0
*
@ -3759,7 +3759,7 @@ function attachment_url_to_postid( $url ) {
$post_id = $wpdb->get_var( $sql );
/**
* Filter an attachment id found by URL.
* Filters an attachment id found by URL.
*
* @since 4.2.0
*