Changeset 10355 for trunk/src/bp-core/classes/class-bp-embed.php

Timestamp:

11/15/2015 07:13:42 PM (11 years ago)

Author:

tw2113

Message:

More documentation cleanup for part of BP-Core component.

See #6398.

File:

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

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

@@ -32 +32 @@
         // These are providers that use a regex callback on the URL in question.
         // Do not confuse with oEmbed providers, which require an external ping.
-        // Used in WP_Embed::shortcode()
+        // Used in WP_Embed::shortcode().
         $this->handlers = $wp_embed->handlers;
 
@@ -83 +83 @@
      * @param array  $attr Shortcode attributes.
      * @param string $url  The URL attempting to be embeded.
-     *
      * @return string The embed HTML on success, otherwise the original URL.
      */
@@ -93 +92 @@
         $attr = wp_parse_args( $attr, wp_embed_defaults() );
 
-        // kses converts & into & and we need to undo this
-        // See https://core.trac.wordpress.org/ticket/11311
+        // Use kses to convert & into & and we need to undo this
+        // See https://core.trac.wordpress.org/ticket/11311.
         $url = str_replace( '&', '&', $url );
 
-        // Look for known internal handlers
+        // Look for known internal handlers.
         ksort( $this->handlers );
         foreach ( $this->handlers as $priority => $handlers ) {
@@ -137 +136 @@
         $attr['discover'] = ( apply_filters( 'bp_embed_oembed_discover', false ) && current_user_can( 'unfiltered_html' ) );
 
-        // Set up a new WP oEmbed object to check URL with registered oEmbed providers
+        // Set up a new WP oEmbed object to check URL with registered oEmbed providers.
         require_once( ABSPATH . WPINC . '/class-oembed.php' );
         $oembed_obj = _wp_oembed_get_object();
 
-        // If oEmbed discovery is true, skip oEmbed provider check
+        // If oEmbed discovery is true, skip oEmbed provider check.
         $is_oembed_link = false;
         if ( !$attr['discover'] ) {
@@ -151 +150 @@
             }
 
-            // If url doesn't match a WP oEmbed provider, stop parsing
+            // If url doesn't match a WP oEmbed provider, stop parsing.
             if ( !$is_oembed_link )
                 return $this->maybe_make_link( $url );
@@ -176 +175 @@
      * @param array  $rawattr Untouched shortcode attributes from
      *                        {@link WP_Embed::shortcode()}.
-     *
      * @return string The embed HTML on success, otherwise the original URL.
      */
@@ -183 +181 @@
 
         if ( $id ) {
-            // Setup the cachekey
+            // Setup the cachekey.
             $cachekey = '_oembed_' . md5( $url . serialize( $attr ) );
 
-            // Let components / plugins grab their cache
+            // Let components / plugins grab their cache.
             $cache = '';
 
@@ -203 +201 @@
             $cache = apply_filters( 'bp_embed_get_cache', $cache, $id, $cachekey, $url, $attr, $rawattr );
 
-            // Grab cache and return it if available
+            // Grab cache and return it if available.
             if ( !empty( $cache ) ) {
 
@@ -218 +216 @@
                 return apply_filters( 'bp_embed_oembed_html', $cache, $url, $attr, $rawattr );
 
-            // If no cache, ping the oEmbed provider and cache the result
+            // If no cache, ping the oEmbed provider and cache the result.
             } else {
                 $html = wp_oembed_get( $url, $attr );
@@ -236 +234 @@
                 do_action( 'bp_embed_update_cache', $cache, $cachekey, $id );
 
-                // If there was a result, return it
+                // If there was a result, return it.
                 if ( $html ) {
 
@@ -245 +243 @@
         }
 
-        // Still unknown
+        // Still unknown.
         return $this->maybe_make_link( $url );
     }