Changeset 31789 for trunk/src/wp-includes/formatting.php

Timestamp:

03/16/2015 01:42:26 AM (10 years ago)

Author:

DrewAPicture

Message:

Clean up some inline documentation for emoji functionality, including a missing @since for mail_emoji(), and a changelog entry for wp_insert_post().

See #31242.

File:

• trunk/src/wp-includes/formatting.php (modified) (6 diffs)

trunk/src/wp-includes/formatting.php

@@ -4058 +4058 @@
 /**
  * Convert any 4 byte emoji in a string to their equivalent HTML entity.
+ *
  * Currently, only Unicode 7 emoji are supported. Unicode 8 emoji will be added
  * when the spec in finalised, along with the new skin-tone modifiers.
@@ -4104 +4105 @@
 
 /**
- * Convert emoji to a static <img> link.
+ * Convert emoji to a static img element.
  *
  * @since 4.2.0
@@ -4120 +4121 @@
     /** This filter is documented in wp-includes/script-loader.php */
     $cdn_url = apply_filters( 'emoji_url', '//s0.wp.com/wp-content/mu-plugins/emoji/twemoji/72x72/' );
+
     /** This filter is documented in wp-includes/script-loader.php */
     $ext = apply_filters( 'emoji_ext', '.png' );
 
     $output = '';
-    // HTML loop taken from smiley function, which was taking from texturize function. It'll never be consolidated.
-    $textarr = preg_split( '/(<.*>)/U', $text, -1, PREG_SPLIT_DELIM_CAPTURE ); // capture the tags as well as in between
-    $stop = count( $textarr );// loop stuff
-
-    // Ignore proessing of specific tags
+    /*
+     * HTML loop taken from smiley function, which was taking from texturize function.
+     * It'll never be consolidated.
+     *
+     * First, capture the tags as well as in between.
+     */
+    $textarr = preg_split( '/(<.*>)/U', $text, -1, PREG_SPLIT_DELIM_CAPTURE );
+    $stop = count( $textarr );
+
+    // Ignore processing of specific tags.
     $tags_to_ignore = 'code|pre|style|script|textarea';
     $ignore_block_element = '';
@@ -4135 +4142 @@
         $content = $textarr[$i];
 
-        // If we're in an ignore block, wait until we find its closing tag
+        // If we're in an ignore block, wait until we find its closing tag.
         if ( '' == $ignore_block_element && preg_match( '/^<(' . $tags_to_ignore . ')>/', $content, $matches ) )  {
             $ignore_block_element = $matches[1];
         }
 
-        // If it's not a tag and not in ignore block
+        // If it's not a tag and not in ignore block.
         if ( '' ==  $ignore_block_element && strlen( $content ) > 0 && '<' != $content[0] ) {
             $matches = array();
@@ -4172 +4179 @@
         }
 
-        // did we exit ignore block
+        // Did we exit ignore block.
         if ( '' != $ignore_block_element && '</' . $ignore_block_element . '>' == $content )  {
             $ignore_block_element = '';
@@ -4186 +4193 @@
  * Convert emoji in emails into static images.
  *
+ * @since 4.2.0
+ *
  * @param array $mail The email data array.
- *
  * @return array The email data array, with emoji in the message staticized.
  */