WordPress.org

Make WordPress Core

Changeset 29155


Ignore:
Timestamp:
07/14/2014 12:22:18 AM (4 years ago)
Author:
DrewAPicture
Message:

Inline documentation cleanup for 4.0 audit.

  • 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.

File:
1 edited

Legend:

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

    r29114 r29155  
    161161     *
    162162     * @since 4.0.0
    163      * @param string $name
    164      * @param array $arguments
    165      * @return mixed
     163     * @access public
     164     *
     165     * @param callable $name      Method to call.
     166     * @param array    $arguments Arguments to pass when calling.
     167     * @return mixed|bool Return value of the callback, false otherwise.
    166168     */
    167169    public function __call( $name, $arguments ) {
     
    172174     * Takes a URL and returns the corresponding oEmbed provider's URL, if there is one.
    173175     *
     176     * @since 4.0.0
     177     * @access public
     178     *
    174179     * @see WP_oEmbed::discover()
    175180     *
    176      * @param string $url  The URL to the content.
    177      * @param array  $args Optional arguments.
     181     * @param string        $url  The URL to the content.
     182     * @param string|array  $args Optional provider arguments.
    178183     * @return bool|string False on failure, otherwise the oEmbed provider URL.
    179      * @since 4.0.0
    180184     */
    181185    public function get_provider( $url, $args = '' ) {
     
    214218     *
    215219     * @since 4.0.0
     220     * @access public
    216221     * @static
    217222     *
    218223     * @see wp_oembed_add_provider()
    219224     *
    220      * @param string $format   The format of URL that this provider can handle. You can use
     225     * @param string $format   Format of URL that this provider can handle. You can use
    221226     *                         asterisks as wildcards.
    222227     * @param string $provider The URL to the oEmbed provider..
     
    239244     *
    240245     * @since 4.0.0
     246     * @access public
    241247     * @static
    242248     *
Note: See TracChangeset for help on using the changeset viewer.