Make WordPress Core


Ignore:
Timestamp:
11/17/2020 10:09:12 AM (3 years ago)
Author:
SergeyBiryukov
Message:

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

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

Follow-up to [49620].

See #51269.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/embed.php

    r49383 r49626  
    100100 *
    101101 * @param string $url  The URL that should be embedded.
    102  * @param array  $args Optional. Additional arguments and parameters for retrieving embed HTML.
    103  *                     Default empty.
     102 * @param array  $args {
     103 *     Optional. Additional arguments for retrieving embed HTML. Default empty.
     104 *
     105 *     @type int|string $width    Optional. The `maxwidth` value passed to the provider URL.
     106 *     @type int|string $height   Optional. The `maxheight` value passed to the provider URL.
     107 *     @type bool       $discover Optional. Determines whether to attempt to discover link tags
     108 *                                at the given URL for an oEmbed provider when the provider URL
     109 *                                is not found in the built-in providers list. Default true.
     110 * }
    104111 * @return string|false The embed HTML on success, false on failure.
    105112 */
Note: See TracChangeset for help on using the changeset viewer.