Changeset 26915 for trunk/src/wp-includes/class-wp-embed.php

Timestamp:

01/07/2014 04:06:48 PM (11 years ago)

Author:

johnbillion

Message:

Inline documentation for core shortcode attributes.

Props DrewAPicture, johnbillion.
Fixes #25661.

File:

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

trunk/src/wp-includes/class-wp-embed.php

@@ -131 +131 @@
      * @uses update_post_meta()
      *
-     * @param array $attr Shortcode attributes.
+     * @param array $attr {
+     *     Shortcode attributes. Optional.
+     *
+     *     @type int $width  Width of the embed in pixels.
+     *     @type int $height Height of the embed in pixels.
+     * }
      * @param string $url The URL attempting to be embedded.
      * @return string The embed HTML on success, otherwise the original URL.
@@ -159 +164 @@
                          * @since 2.9.0
                          *
+                         * @see WP_Embed::shortcode()
+                         *
                          * @param mixed  $return The shortcode callback function to call.
                          * @param string $url    The attempted embed URL.
@@ -189 +196 @@
                      *
                      * @since 2.9.0
+                     *
+                     * @see WP_Embed::shortcode()
                      *
                      * @param mixed  $cache   The cached HTML result, stored in post meta.