vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2026-06-28 14:20:15 +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

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 = '' ) {