Changeset 29012 for trunk/src/wp-includes/class-oembed.php

Timestamp:

07/07/2014 06:33:23 AM (10 years ago)

Author:

DrewAPicture

Message:

Add phpDoc blocks for two WP_oEmbed methods added in [28846].

Fixes #28284.

File:

• trunk/src/wp-includes/class-oembed.php (modified) (2 diffs)

trunk/src/wp-includes/class-oembed.php

@@ -199 +199 @@
     }
 
+    /**
+     * Add an oEmbed provider just-in-time when wp_oembed_add_provider() is called
+     * before the 'plugins_loaded' hook.
+     *
+     * The just-in-time addition is for the benefit of the 'oembed_providers' filter.
+     *
+     * @since 4.0.0
+     * @static
+     *
+     * @see wp_oembed_add_provider()
+     *
+     * @param string $format   The format of URL that this provider can handle. You can use
+     *                         asterisks as wildcards.
+     * @param string $provider The URL to the oEmbed provider..
+     * @param bool   $regex    Optional. Whether the $format parameter is in a regex format.
+     *                         Default false.
+     */
     public static function _add_provider_early( $format, $provider, $regex = false ) {
         if ( empty( self::$early_providers['add'] ) ) {
@@ -207 +224 @@
     }
 
+    /**
+     * Remove an oEmbed provider just-in-time when wp_oembed_remove_provider() is called
+     * before the 'plugins_loaded' hook.
+     *
+     * The just-in-time removal is for the benefit of the 'oembed_providers' filter.
+     *
+     * @since 4.0.0
+     * @static
+     *
+     * @see wp_oembed_remove_provider()
+     *
+     * @param string $format The format of URL that this provider can handle. You can use
+     *                       asterisks as wildcards.
+     */
     public static function _remove_provider_early( $format ) {
         if ( empty( self::$early_providers['remove'] ) ) {