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.

Built from https://develop.svn.wordpress.org/trunk@37069


git-svn-id: http://core.svn.wordpress.org/trunk@37036 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2016-03-23 17:08:27 +00:00
parent d78762c1ef
commit 9f48d46be3
2 changed files with 6 additions and 6 deletions

View File

@ -310,8 +310,8 @@ class WP_oEmbed {
* @since 2.9.0 * @since 2.9.0
* @access public * @access public
* *
* @param string $url The URL to the content that should be attempted to be embedded. * @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 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. * @return false|string False on failure, otherwise the UNSANITIZED (and potentially unsafe) HTML that should be used to embed.
*/ */
public function get_html( $url, $args = '' ) { public function get_html( $url, $args = '' ) {
@ -422,9 +422,9 @@ class WP_oEmbed {
* @since 2.9.0 * @since 2.9.0
* @access public * @access public
* *
* @param string $provider The URL to the oEmbed provider. * @param string $provider The URL to the oEmbed provider.
* @param string $url The URL to the content that is desired to be embedded. * @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 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. * @return false|object False on failure, otherwise the result in the form of an object.
*/ */
public function fetch( $provider, $url, $args = '' ) { public function fetch( $provider, $url, $args = '' ) {

View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.5-beta4-37068'; $wp_version = '4.5-beta4-37069';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.