Changeset 35485 for trunk/src/wp-includes/embed-functions.php

Timestamp:

11/01/2015 03:41:28 PM (9 years ago)

Author:

DrewAPicture

Message:

Docs: Correctly notate that the default $width and $height embed dimensions are passed to the embed_defaults filter as a compacted array, and not two distinct parameters.

Props swissspidy.
Fixes #34522.

File:

• trunk/src/wp-includes/embed-functions.php (modified) (2 diffs)

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

@@ -44 +44 @@
 
 /**
- * Create default array of embed parameters.
+ * Creates default array of embed parameters.
  *
  * The width defaults to the content width as specified by the theme. If the
@@ -75 +75 @@
      * @since 2.9.0
      *
-     * @param int    $width  Width of the embed in pixels.
-     * @param int    $height Height of the embed in pixels.
-     * @param string $url    The URL that should be embedded.
+     * @param array  $size An array of embed width and height values
+     *                     in pixels (in that order).
+     * @param string $url  The URL that should be embedded.
      */
     return apply_filters( 'embed_defaults', compact( 'width', 'height' ), $url );