vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2026-06-28 06:10:09 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Docs: Document the $args parameter of wp_oembed_get().

Browse Source 
Link to `wp_oembed_get()` as the canonical source when documenting additional arguments in various `WP_oEmbed` methods.

Follow-up to [49620].

See #51269.

git-svn-id: https://develop.svn.wordpress.org/trunk@49626 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov
2020-11-17 10:09:12 +00:00
parent 6b6a643b0b
commit 41decddb7f
2 changed files with 27 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -238,11 +238,11 @@ class WP_oEmbed {
*
* @param string $url The URL to the content.
* @param string|array $args {
* Optional. Additional arguments and parameters for retrieving embed HTML. Default empty.
* Optional. Additional provider arguments. Default empty.
*
* @type bool $discover Optional. Determines whether to attempt to discover link tags at the given URL
* for an oEmbed provider when the oEmbed provider URL is not found in the
* built-in providers list.
* @type bool $discover Optional. Determines whether to attempt to discover link tags
* at the given URL for an oEmbed provider when the provider URL
* is not found in the built-in providers list. Default true.
* }
* @return string|false The oEmbed provider URL on success, false on failure.
*/
@@ -334,15 +334,8 @@ class WP_oEmbed {
* @since 4.8.0
*
* @param string $url The URL to the content that should be attempted to be embedded.
* @param string|array $args {
* Optional. Additional arguments and parameters for retrieving embed HTML. Default empty.
*
* @type int|string $width Optional. The "maxwidth" value passed to the provider URL.
* @type int|string $height Optional. The "maxheight" value passed to the provider URL.
* @type bool $discover Optional. Determines whether to attempt to discover link tags
* at the given URL for an oEmbed provider when the oEmbed
* provider URL is not found in the built-in providers list.
* }
* @param string|array $args Optional. Additional arguments for retrieving embed HTML.
* See wp_oembed_get() for accepted arguments. Default empty.
* @return object|false The result in the form of an object on success, false on failure.
*/
public function get_data( $url, $args = '' ) {
@@ -372,15 +365,8 @@ class WP_oEmbed {
* @since 2.9.0
*
* @param string $url The URL to the content that should be attempted to be embedded.
* @param string|array $args {
* Optional. Additional arguments and parameters for retrieving embed HTML. Default empty.
*
* @type int|string $width Optional. The "maxwidth" value passed to the provider URL.
* @type int|string $height Optional. The "maxheight" value passed to the provider URL.
* @type bool $discover Optional. Determines whether to attempt to discover link tags
* at the given URL for an oEmbed provider when the oEmbed
* provider URL is not found in the built-in providers list.
* }
* @param string|array $args Optional. Additional arguments for retrieving embed HTML.
* See wp_oembed_get() for accepted arguments. Default empty.
* @return string|false The UNSANITIZED (and potentially unsafe) HTML that should be used to embed
* on success, false on failure.
*/
@@ -399,15 +385,8 @@ class WP_oEmbed {
* @param null|string $result The UNSANITIZED (and potentially unsafe) HTML that should be used to embed.
* Default null to continue retrieving the result.
* @param string $url The URL to the content that should be attempted to be embedded.
* @param string|array $args {
* Optional. Additional arguments and parameters for retrieving embed HTML. Default empty.
*
* @type int|string $width Optional. The "maxwidth" value passed to the provider URL.
* @type int|string $height Optional. The "maxheight" value passed to the provider URL.
* @type bool $discover Optional. Determines whether to attempt to discover link tags
* at the given URL for an oEmbed provider when the oEmbed
* provider URL is not found in the built-in providers list.
* }
* @param string|array $args Optional. Additional arguments for retrieving embed HTML.
* See wp_oembed_get() for accepted arguments. Default empty.
*/
$pre = apply_filters( 'pre_oembed_result', null, $url, $args );
@@ -428,15 +407,8 @@ class WP_oEmbed {
*
* @param string|false $data The returned oEmbed HTML (false if unsafe).
* @param string $url URL of the content to be embedded.
* @param string|array $args {
* Optional. Additional arguments and parameters for retrieving embed HTML. Default empty.
*
* @type int|string $width Optional. The "maxwidth" value passed to the provider URL.
* @type int|string $height Optional. The "maxheight" value passed to the provider URL.
* @type bool $discover Optional. Determines whether to attempt to discover link tags
* at the given URL for an oEmbed provider when the oEmbed
* provider URL is not found in the built-in providers list.
* }
* @param string|array $args Optional. Additional arguments for retrieving embed HTML.
* See wp_oembed_get() for accepted arguments. Default empty.
*/
return apply_filters( 'oembed_result', $this->data2html( $data, $url ), $url, $args );
}
@@ -538,15 +510,8 @@ class WP_oEmbed {
*
* @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|array $args {
* Optional. Additional arguments and parameters for retrieving embed HTML. Default empty.
*
* @type int|string $width Optional. The "maxwidth" value passed to the provider URL.
* @type int|string $height Optional. The "maxheight" value passed to the provider URL.
* @type bool $discover Optional. Determines whether to attempt to discover link tags
* at the given URL for an oEmbed provider when the oEmbed
* provider URL is not found in the built-in providers list.
* }
* @param string|array $args Optional. Additional arguments for retrieving embed HTML.
* See wp_oembed_get() for accepted arguments. Default empty.
* @return object|false The result in the form of an object on success, false on failure.
*/
public function fetch( $provider, $url, $args = '' ) {
@@ -563,17 +528,10 @@ class WP_oEmbed {
* @since 2.9.0
* @since 4.9.0 The `dnt` (Do Not Track) query parameter was added to all oEmbed provider URLs.
*
* @param string $provider URL of the oEmbed provider.
* @param string $url URL of the content to be embedded.
* @param string|array $args {
* Optional. Additional arguments and parameters for retrieving embed HTML. Default empty.
*
* @type int|string $width Optional. The "maxwidth" value passed to the provider URL.
* @type int|string $height Optional. The "maxheight" value passed to the provider URL.
* @type bool $discover Optional. Determines whether to attempt to discover link tags
* at the given URL for an oEmbed provider when the oEmbed
* provider URL is not found in the built-in providers list.
* }
* @param string $provider URL of the oEmbed provider.
* @param string $url URL of the content to be embedded.
* @param array $args Optional. Additional arguments for retrieving embed HTML.
* See wp_oembed_get() for accepted arguments. Default empty.
*/
$provider = apply_filters( 'oembed_fetch_url', $provider, $url, $args );

11
src/wp-includes/embed.php
View File

@@ -99,8 +99,15 @@ function wp_embed_defaults( $url = '' ) {
* @see WP_oEmbed
*
* @param string $url The URL that should be embedded.
* @param array $args Optional. Additional arguments and parameters for retrieving embed HTML.
* Default empty.
* @param array $args {
* Optional. Additional arguments for retrieving embed HTML. Default empty.
*
* @type int|string $width Optional. The `maxwidth` value passed to the provider URL.
* @type int|string $height Optional. The `maxheight` value passed to the provider URL.
* @type bool $discover Optional. Determines whether to attempt to discover link tags
* at the given URL for an oEmbed provider when the provider URL
* is not found in the built-in providers list. Default true.
* }
* @return string|false The embed HTML on success, false on failure.
*/
function wp_oembed_get( $url, $args = '' ) {