IntenseWebs/WordPress
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Inline documentation cleanup for 4.0 audit.

Browse Source 
* Fill out inline documentation for the `__call()` magic method added in [28507]
* Inline documentation tweaks for `get_provider()`, added in [28728]
* Inline documentation tweaks for `_add_provider_early()`, added in [28846]
* `@access` tag added for `_remove_provider_early()`, added in [28846]

See #22234 and #28885.

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


git-svn-id: http://core.svn.wordpress.org/trunk@28939 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2014-07-14 00:23:15 +00:00
parent 204a4bc6bf
commit f5e5bc8934
1 changed files with 13 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
wp-includes/class-oembed.php
View File

@ -160,9 +160,11 @@ class WP_oEmbed {
* Make private/protected methods readable for backwards compatibility * Make private/protected methods readable for backwards compatibility
* *
* @since 4.0.0 * @since 4.0.0
* @param string $name * @access public
* @param array $arguments *
* @return mixed * @param callable $name Method to call.
* @param array $arguments Arguments to pass when calling.
* @return mixed|bool Return value of the callback, false otherwise.
*/ */
public function __call( $name, $arguments ) { public function __call( $name, $arguments ) {
return call_user_func_array( array( $this, $name ), $arguments ); return call_user_func_array( array( $this, $name ), $arguments );
@ -171,12 +173,14 @@ class WP_oEmbed {
/** /**
* Takes a URL and returns the corresponding oEmbed provider's URL, if there is one. * Takes a URL and returns the corresponding oEmbed provider's URL, if there is one.
* *
* @since 4.0.0
* @access public
*
* @see WP_oEmbed::discover() * @see WP_oEmbed::discover()
* *
* @param string $url The URL to the content. * @param string $url The URL to the content.
* @param array $args Optional arguments. * @param string|array $args Optional provider arguments.
* @return bool|string False on failure, otherwise the oEmbed provider URL. * @return bool|string False on failure, otherwise the oEmbed provider URL.
* @since 4.0.0
*/ */
public function get_provider( $url, $args = '' ) { public function get_provider( $url, $args = '' ) {
@ -213,11 +217,12 @@ class WP_oEmbed {
* The just-in-time addition is for the benefit of the 'oembed_providers' filter. * The just-in-time addition is for the benefit of the 'oembed_providers' filter.
* *
* @since 4.0.0 * @since 4.0.0
* @access public
* @static * @static
* *
* @see wp_oembed_add_provider() * @see wp_oembed_add_provider()
* *
* @param string $format The format of URL that this provider can handle. You can use * @param string $format Format of URL that this provider can handle. You can use
* asterisks as wildcards. * asterisks as wildcards.
* @param string $provider The URL to the oEmbed provider.. * @param string $provider The URL to the oEmbed provider..
* @param bool $regex Optional. Whether the $format parameter is in a regex format. * @param bool $regex Optional. Whether the $format parameter is in a regex format.
@ -238,6 +243,7 @@ class WP_oEmbed {
* The just-in-time removal is for the benefit of the 'oembed_providers' filter. * The just-in-time removal is for the benefit of the 'oembed_providers' filter.
* *
* @since 4.0.0 * @since 4.0.0
* @access public
* @static * @static
* *
* @see wp_oembed_remove_provider() * @see wp_oembed_remove_provider()