sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

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

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

Props ramiy.
See #36296.


git-svn-id: https://develop.svn.wordpress.org/trunk@37069 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2016-03-23 17:07:58 +00:00
parent 79150b2561
commit 979d8931d3
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/wp-includes/class-oembed.php
View File

@ -310,8 +310,8 @@ class WP_oEmbed {
* @since 2.9.0
* @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.
*/
public function get_html( $url, $args = '' ) {
@ -422,9 +422,9 @@ class WP_oEmbed {
* @since 2.9.0
* @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.
*/
public function fetch( $provider, $url, $args = '' ) {