Docs: Standardize filter docs in wp-includes/embed.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@37513 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2016-05-22 18:41:51 +00:00
parent 53a58c6933
commit 872e55281b
1 changed files with 16 additions and 16 deletions

View File

@ -70,7 +70,7 @@ function wp_embed_defaults( $url = '' ) {
$height = min( ceil( $width * 1.5 ), 1000 ); $height = min( ceil( $width * 1.5 ), 1000 );
/** /**
* Filter the default array of embed dimensions. * Filters the default array of embed dimensions.
* *
* @since 2.9.0 * @since 2.9.0
* *
@ -161,7 +161,7 @@ function wp_oembed_remove_provider( $format ) {
*/ */
function wp_maybe_load_embeds() { function wp_maybe_load_embeds() {
/** /**
* Filter whether to load the default embed handlers. * Filters whether to load the default embed handlers.
* *
* Returning a falsey value will prevent loading the default embed handlers. * Returning a falsey value will prevent loading the default embed handlers.
* *
@ -178,7 +178,7 @@ function wp_maybe_load_embeds() {
wp_embed_register_handler( 'googlevideo', '#http://video\.google\.([A-Za-z.]{2,5})/videoplay\?docid=([\d-]+)(.*?)#i', 'wp_embed_handler_googlevideo' ); wp_embed_register_handler( 'googlevideo', '#http://video\.google\.([A-Za-z.]{2,5})/videoplay\?docid=([\d-]+)(.*?)#i', 'wp_embed_handler_googlevideo' );
/** /**
* Filter the audio embed handler callback. * Filters the audio embed handler callback.
* *
* @since 3.6.0 * @since 3.6.0
* *
@ -187,7 +187,7 @@ function wp_maybe_load_embeds() {
wp_embed_register_handler( 'audio', '#^https?://.+?\.(' . join( '|', wp_get_audio_extensions() ) . ')$#i', apply_filters( 'wp_audio_embed_handler', 'wp_embed_handler_audio' ), 9999 ); wp_embed_register_handler( 'audio', '#^https?://.+?\.(' . join( '|', wp_get_audio_extensions() ) . ')$#i', apply_filters( 'wp_audio_embed_handler', 'wp_embed_handler_audio' ), 9999 );
/** /**
* Filter the video embed handler callback. * Filters the video embed handler callback.
* *
* @since 3.6.0 * @since 3.6.0
* *
@ -220,7 +220,7 @@ function wp_embed_handler_googlevideo( $matches, $attr, $url, $rawattr ) {
} }
/** /**
* Filter the Google Video embed output. * Filters the Google Video embed output.
* *
* @since 2.9.0 * @since 2.9.0
* *
@ -254,7 +254,7 @@ function wp_embed_handler_youtube( $matches, $attr, $url, $rawattr ) {
$embed = $wp_embed->autoembed( "https://youtube.com/watch?v={$matches[2]}" ); $embed = $wp_embed->autoembed( "https://youtube.com/watch?v={$matches[2]}" );
/** /**
* Filter the YoutTube embed output. * Filters the YoutTube embed output.
* *
* @since 4.0.0 * @since 4.0.0
* *
@ -283,7 +283,7 @@ function wp_embed_handler_audio( $matches, $attr, $url, $rawattr ) {
$audio = sprintf( '[audio src="%s" /]', esc_url( $url ) ); $audio = sprintf( '[audio src="%s" /]', esc_url( $url ) );
/** /**
* Filter the audio embed output. * Filters the audio embed output.
* *
* @since 3.6.0 * @since 3.6.0
* *
@ -315,7 +315,7 @@ function wp_embed_handler_video( $matches, $attr, $url, $rawattr ) {
$video = sprintf( '[video %s src="%s" /]', $dimensions, esc_url( $url ) ); $video = sprintf( '[video %s src="%s" /]', $dimensions, esc_url( $url ) );
/** /**
* Filter the video embed output. * Filters the video embed output.
* *
* @since 3.6.0 * @since 3.6.0
* *
@ -354,7 +354,7 @@ function wp_oembed_add_discovery_links() {
} }
/** /**
* Filter the oEmbed discovery links HTML. * Filters the oEmbed discovery links HTML.
* *
* @since 4.4.0 * @since 4.4.0
* *
@ -395,7 +395,7 @@ function get_post_embed_url( $post = null ) {
} }
/** /**
* Filter the URL to embed a specific post. * Filters the URL to embed a specific post.
* *
* @since 4.4.0 * @since 4.4.0
* *
@ -431,7 +431,7 @@ function get_oembed_endpoint_url( $permalink = '', $format = 'json' ) {
} }
/** /**
* Filter the oEmbed endpoint URL. * Filters the oEmbed endpoint URL.
* *
* @since 4.4.0 * @since 4.4.0
* *
@ -501,7 +501,7 @@ JS;
); );
/** /**
* Filter the embed HTML output for a given post. * Filters the embed HTML output for a given post.
* *
* @since 4.4.0 * @since 4.4.0
* *
@ -534,7 +534,7 @@ function get_oembed_response_data( $post, $width ) {
} }
/** /**
* Filter the allowed minimum and maximum widths for the oEmbed response. * Filters the allowed minimum and maximum widths for the oEmbed response.
* *
* @since 4.4.0 * @since 4.4.0
* *
@ -571,7 +571,7 @@ function get_oembed_response_data( $post, $width ) {
} }
/** /**
* Filter the oEmbed response data. * Filters the oEmbed response data.
* *
* @since 4.4.0 * @since 4.4.0
* *
@ -839,7 +839,7 @@ function the_excerpt_embed() {
$output = get_the_excerpt(); $output = get_the_excerpt();
/** /**
* Filter the post excerpt for the embed template. * Filters the post excerpt for the embed template.
* *
* @since 4.4.0 * @since 4.4.0
* *
@ -1070,7 +1070,7 @@ function the_embed_site_title() {
$site_title = '<div class="wp-embed-site-title">' . $site_title . '</div>'; $site_title = '<div class="wp-embed-site-title">' . $site_title . '</div>';
/** /**
* Filter the site title HTML in the embed footer. * Filters the site title HTML in the embed footer.
* *
* @since 4.4.0 * @since 4.4.0
* *