Changeset 47122 for trunk/src/wp-includes/class-wp-embed.php

Timestamp:

01/29/2020 12:43:23 AM (7 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve inline comments per the documentation standards.

Includes minor code layout fixes for better readability.

See #48303.

File:

• trunk/src/wp-includes/class-wp-embed.php (modified) (7 diffs)

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

@@ -29 +29 @@
          */
         public function __construct() {
-                // Hack to get the [embed] shortcode to run before wpautop()
+                // Hack to get the [embed] shortcode to run before wpautop().
                 add_filter( 'the_content', array( $this, 'run_shortcode' ), 8 );
                 add_filter( 'widget_text_content', array( $this, 'run_shortcode' ), 8 );
 
-                // Shortcode placeholder for strip_shortcodes()
+                // Shortcode placeholder for strip_shortcodes().
                 add_shortcode( 'embed', '__return_false' );
 
-                // Attempts to embed all URLs in a post
+                // Attempts to embed all URLs in a post.
                 add_filter( 'the_content', array( $this, 'autoembed' ), 8 );
                 add_filter( 'widget_text_content', array( $this, 'autoembed' ), 8 );
 
-                // After a post is saved, cache oEmbed items via Ajax
+                // After a post is saved, cache oEmbed items via Ajax.
                 add_action( 'edit_form_advanced', array( $this, 'maybe_run_ajax_cache' ) );
                 add_action( 'edit_page_form', array( $this, 'maybe_run_ajax_cache' ) );
@@ -60 +60 @@
                 global $shortcode_tags;
 
-                // Back up current registered shortcodes and clear them all out
+                // Back up current registered shortcodes and clear them all out.
                 $orig_shortcode_tags = $shortcode_tags;
                 remove_all_shortcodes();
@@ -66 +66 @@
                 add_shortcode( 'embed', array( $this, 'shortcode' ) );
 
-                // Do the shortcode (only the [embed] one is registered)
+                // Do the shortcode (only the [embed] one is registered).
                 $content = do_shortcode( $content, true );
 
-                // Put the original shortcodes back
+                // Put the original shortcodes back.
                 $shortcode_tags = $orig_shortcode_tags;
 
@@ -162 +162 @@
                 $this->last_attr = $attr;
 
-                // kses converts & into & and we need to undo this
+                // KSES converts & 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 ) {
@@ -340 +340 @@
                 }
 
-                // Still unknown
+                // Still unknown.
                 return $this->maybe_make_link( $url );
         }
@@ -382 +382 @@
                 }
 
-                // Trigger a caching
+                // Trigger a caching.
                 if ( ! empty( $post->post_content ) ) {
                         $this->post_ID  = $post->ID;
@@ -487 +487 @@
 
                 if ( ! empty( $oembed_post_query->posts ) ) {
-                        // Note: 'fields'=>'ids' is not being used in order to cache the post object as it will be needed.
+                        // Note: 'fields' => 'ids' is not being used in order to cache the post object as it will be needed.
                         $oembed_post_id = $oembed_post_query->posts[0]->ID;
                         wp_cache_set( $cache_key, $oembed_post_id, $cache_group );