Changeset 29164

Timestamp:

07/14/2014 01:06:58 AM (10 years ago)

Author:

DrewAPicture

Message:

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.

File:

• trunk/src/wp-includes/media.php (modified) (3 diffs)

trunk/src/wp-includes/media.php

@@ -2282 +2282 @@
 
 /**
- * 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
  *
- * @param array $matches The regex matches from the provided regex when calling {@link wp_embed_register_handler()}.
- * @param array $attr Embed attributes.
- * @param string $url The original URL that was matched by the regex.
- * @param array $rawattr The original unmodified attributes.
+ * @param array  $matches The regex matches from the provided regex when calling
+ *                        {@link wp_embed_register_handler()}.
+ * @param array  $attr    Embed 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.
  */
@@ -2299 +2302 @@
      *
      * @since 4.0.0
+     *
+     * @see wp_embed_handler_youtube()
      *
      * @param string $embed   YouTube embed output.
@@ -3233 +3238 @@
  *
  * @global wpdb $wpdb WordPress database access abstraction object.
+ *
  * @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 ) {