Changeset 9550

Timestamp:

02/24/2015 03:32:34 AM (10 years ago)

Author:

tw2113

Message:

Adds hooks documentation for class-bp-embed.php.

See #5940.

File:

• trunk/src/bp-core/classes/class-bp-embed.php (modified) (5 diffs)

trunk/src/bp-core/classes/class-bp-embed.php

@@ -55 +55 @@
         }
 
+        /**
+         * Filters the BuddyPress Core oEmbed setup.
+         *
+         * @since BuddyPress (1.5.0)
+         *
+         * @param BP_Embed $this Current instance of the BP_Embed. Passed by reference.
+         */
         do_action_ref_array( 'bp_core_setup_oembed', array( &$this ) );
     }
@@ -95 +102 @@
                 if ( preg_match( $handler['regex'], $url, $matches ) && is_callable( $handler['callback'] ) ) {
                     if ( false !== $return = call_user_func( $handler['callback'], $matches, $attr, $url, $rawattr ) ) {
+
+                        /**
+                         * Filters the oEmbed handler result for the provided URL.
+                         *
+                         * @since BuddyPress (1.5.0)
+                         *
+                         * @param string $return Handler callback for the oEmbed.
+                         * @param string $url    URL attempting to be embedded.
+                         * @param array  $attr   Shortcode attributes.
+                         */
                         return apply_filters( 'embed_handler_html', $return, $url, $attr );
                     }
@@ -101 +118 @@
         }
 
-        // Get object ID
+        /**
+         * Filters the embed object ID.
+         *
+         * @since BuddyPress (1.5.0)
+         *
+         * @param int $value Value of zero.
+         */
         $id = apply_filters( 'embed_post_id', 0 );
 
-        // Is oEmbed discovery on?
+        /**
+         * Filters whether or not oEmbed discovery is on.
+         *
+         * @since BuddyPress (1.5.0)
+         *
+         * @param bool $value Current status of oEmbed discovery.
+         */
         $attr['discover'] = ( apply_filters( 'bp_embed_oembed_discover', false ) && current_user_can( 'unfiltered_html' ) );
 
@@ -157 +186 @@
             // Let components / plugins grab their cache
             $cache = '';
+
+            /**
+             * Filters the cache value to be used in the oEmbed, if exists.
+             *
+             * @since BuddyPress (1.5.0)
+             *
+             * @param string $cache    Empty initial cache value.
+             * @param int    $id       ID that the caching is for.
+             * @param string $cachekey Key to use for the caching in the database.
+             * @param string $url      The URL attempting to be embedded.
+             * @param array  $attr     Parsed shortcode attributes.
+             * @param array  $rawattr  Unparsed shortcode attributes.
+             */
             $cache = apply_filters( 'bp_embed_get_cache', $cache, $id, $cachekey, $url, $attr, $rawattr );
 
             // Grab cache and return it if available
             if ( !empty( $cache ) ) {
+
+                /**
+                 * Filters the found cache for the provided URL.
+                 *
+                 * @since BuddyPress (1.5.0)
+                 *
+                 * @param string $cache   Cached HTML markup for embed.
+                 * @param string $url     The URL being embedded.
+                 * @param array  $attr    Parsed shortcode attributes.
+                 * @param array  $rawattr Unparased shortcode attributes.
+                 */
                 return apply_filters( 'bp_embed_oembed_html', $cache, $url, $attr, $rawattr );
 
@@ -168 +221 @@
                 $cache = ( $html ) ? $html : $url;
 
-                // Let components / plugins save their cache
+                /**
+                 * Fires if there is no existing cache and triggers cache setting.
+                 *
+                 * Lets components / plugins save their cache.
+                 *
+                 * @since BuddyPress (1.5.0)
+                 *
+                 * @param string $cache    Newly cached HTML markup for embed.
+                 * @param string $cachekey Key to use for the caching in the database.
+                 * @param int    $id       ID to do the caching for.
+                 */
                 do_action( 'bp_embed_update_cache', $cache, $cachekey, $id );
 
                 // If there was a result, return it
-                if ( $html )
+                if ( $html ) {
+
+                    /** This filter is documented in bp-core/classes/class-bp-embed.php */
                     return apply_filters( 'bp_embed_oembed_html', $html, $url, $attr, $rawattr );
+                }
             }
         }