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

Inline documentation cleanup for 4.0 audit. 

Added in [28652]:
* Various phpDoc improvements for `wp_embed_handler_youtube()`
* Adds `@see` reference to `wp_embed_handler_youtube()` in 'wp_embed_handler_youtube' filter docs

Added in [29029]:
* s/post_id/post ID in `@return` description for `attachment_url_to_postid()`

See #28885.


git-svn-id: https://develop.svn.wordpress.org/trunk@29164 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes (DrewAPicture) 2014-07-14 01:06:58 +00:00
parent 551f829c55
commit a752c42b05
1 changed files with 12 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -2281,14 +2281,17 @@ function wp_embed_handler_googlevideo( $matches, $attr, $url, $rawattr ) {
} }
/** /**
* The YouTube embed handler callback. Catches URLs that can be parsed but aren't supported by oEmbed. * YouTube embed handler callback.
*
* Catches URLs that can be parsed but aren't supported by oEmbed.
* *
* @since 4.0.0 * @since 4.0.0
* *
* @param array $matches The regex matches from the provided regex when calling {@link wp_embed_register_handler()}. * @param array $matches The regex matches from the provided regex when calling
* @param array $attr Embed attributes. * {@link wp_embed_register_handler()}.
* @param string $url The original URL that was matched by the regex. * @param array $attr Embed attributes.
* @param array $rawattr The original unmodified attributes. * @param string $url The original URL that was matched by the regex.
* @param array $rawattr The original unmodified attributes.
* @return string The embed HTML. * @return string The embed HTML.
*/ */
function wp_embed_handler_youtube( $matches, $attr, $url, $rawattr ) { function wp_embed_handler_youtube( $matches, $attr, $url, $rawattr ) {
@ -2299,6 +2302,8 @@ function wp_embed_handler_youtube( $matches, $attr, $url, $rawattr ) {
* *
* @since 4.0.0 * @since 4.0.0
* *
* @see wp_embed_handler_youtube()
*
* @param string $embed YouTube embed output. * @param string $embed YouTube embed output.
* @param array $attr An array of embed attributes. * @param array $attr An array of embed attributes.
* @param string $url The original URL that was matched by the regex. * @param string $url The original URL that was matched by the regex.
@ -3232,8 +3237,9 @@ function wp_maybe_generate_attachment_metadata( $attachment ) {
* @since 4.0.0 * @since 4.0.0
* *
* @global wpdb $wpdb WordPress database access abstraction object. * @global wpdb $wpdb WordPress database access abstraction object.
*
* @param string $url The URL to resolve. * @param string $url The URL to resolve.
* @return int The found post_id. * @return int The found post ID.
*/ */
function attachment_url_to_postid( $url ) { function attachment_url_to_postid( $url ) {
global $wpdb; global $wpdb;