Changeset 37069

Timestamp:

03/23/2016 05:07:58 PM (7 years ago)

Author:

DrewAPicture

Message:

Docs: Properly mark $args parameters in two WP_oEmbed methods as optional.

Also clarify that the $args parameters can accept a string (the default) in addition to an array.

Props ramiy.
See #36296.

File:

• trunk/src/wp-includes/class-oembed.php (modified) (2 diffs)

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

@@ -311 +311 @@
      * @access public
      *
-     * @param string $url The URL to the content that should be attempted to be embedded.
-     * @param array $args Optional arguments. Usually passed from a shortcode.
+     * @param string       $url  The URL to the content that should be attempted to be embedded.
+     * @param array|string $args Optional. Arguments, usually passed from a shortcode. Default empty.
      * @return false|string False on failure, otherwise the UNSANITIZED (and potentially unsafe) HTML that should be used to embed.
      */
@@ -423 +423 @@
      * @access public
      *
-     * @param string $provider The URL to the oEmbed provider.
-     * @param string $url The URL to the content that is desired to be embedded.
-     * @param array $args Optional arguments. Usually passed from a shortcode.
+     * @param string       $provider The URL to the oEmbed provider.
+     * @param string       $url      The URL to the content that is desired to be embedded.
+     * @param array|string $args     Optional. Arguments, usually passed from a shortcode. Default empty.
      * @return false|object False on failure, otherwise the result in the form of an object.
      */