wp-includes/formatting.php

   1 <?php
   2 /**
   3  * Main WordPress Formatting API.
   4  *
   5  * Handles many functions for formatting output.
   6  *
   7  * @package WordPress
   8  */
   9
  10 /**
  11  * Replaces common plain text characters into formatted entities
  12  *
  13  * As an example,
  14  *
  15  *     'cause today's effort makes it worth tomorrow's "holiday" ...
  16  *
  17  * Becomes:
  18  *
  19  *     &#8217;cause today&#8217;s effort makes it worth tomorrow&#8217;s &#8220;holiday&#8221; &#8230;
  20  *
  21  * Code within certain html blocks are skipped.
  22  *
  23  * Do not use this function before the 'init' action hook; everything will break.
  24  *
  25  * @since 0.71
  26  *
  27  * @global array $wp_cockneyreplace Array of formatted entities for certain common phrases
  28  * @global array $shortcode_tags
  29  * @staticvar array $static_characters
  30  * @staticvar array $static_replacements
  31  * @staticvar array $dynamic_characters
  32  * @staticvar array $dynamic_replacements
  33  * @staticvar array $default_no_texturize_tags
  34  * @staticvar array $default_no_texturize_shortcodes
  35  * @staticvar bool  $run_texturize
  36  *
  37  * @param string $text The text to be formatted
  38  * @param bool   $reset Set to true for unit testing. Translated patterns will reset.
  39  * @return string The string replaced with html entities
  40  */
  41 function wptexturize( $text, $reset = false ) {
  42         global $wp_cockneyreplace, $shortcode_tags;
  43         static $static_characters = null,
  44                 $static_replacements = null,
  45                 $dynamic_characters = null,
  46                 $dynamic_replacements = null,
  47                 $default_no_texturize_tags = null,
  48                 $default_no_texturize_shortcodes = null,
  49                 $run_texturize = true,
  50                 $apos = null,
  51                 $prime = null,
  52                 $double_prime = null,
  53                 $opening_quote = null,
  54                 $closing_quote = null,
  55                 $opening_single_quote = null,
  56                 $closing_single_quote = null,
  57                 $open_q_flag = '<!--oq-->',
  58                 $open_sq_flag = '<!--osq-->',
  59                 $apos_flag = '<!--apos-->';
  60
  61         // If there's nothing to do, just stop.
  62         if ( empty( $text ) || false === $run_texturize ) {
  63                 return $text;
  64         }
  65
  66         // Set up static variables. Run once only.
  67         if ( $reset || ! isset( $static_characters ) ) {
  68                 /**
  69                  * Filter whether to skip running wptexturize().
  70                  *
  71                  * Passing false to the filter will effectively short-circuit wptexturize().
  72                  * returning the original text passed to the function instead.
  73                  *
  74                  * The filter runs only once, the first time wptexturize() is called.
  75                  *
  76                  * @since 4.0.0
  77                  *
  78                  * @see wptexturize()
  79                  *
  80                  * @param bool $run_texturize Whether to short-circuit wptexturize().
  81                  */
  82                 $run_texturize = apply_filters( 'run_wptexturize', $run_texturize );
  83                 if ( false === $run_texturize ) {
  84                         return $text;
  85                 }
  86
  87                 /* translators: opening curly double quote */
  88                 $opening_quote = _x( '&#8220;', 'opening curly double quote' );
  89                 /* translators: closing curly double quote */
  90                 $closing_quote = _x( '&#8221;', 'closing curly double quote' );
  91
  92                 /* translators: apostrophe, for example in 'cause or can't */
  93                 $apos = _x( '&#8217;', 'apostrophe' );
  94
  95                 /* translators: prime, for example in 9' (nine feet) */
  96                 $prime = _x( '&#8242;', 'prime' );
  97                 /* translators: double prime, for example in 9" (nine inches) */
  98                 $double_prime = _x( '&#8243;', 'double prime' );
  99
 100                 /* translators: opening curly single quote */
 101                 $opening_single_quote = _x( '&#8216;', 'opening curly single quote' );
 102                 /* translators: closing curly single quote */
 103                 $closing_single_quote = _x( '&#8217;', 'closing curly single quote' );
 104
 105                 /* translators: en dash */
 106                 $en_dash = _x( '&#8211;', 'en dash' );
 107                 /* translators: em dash */
 108                 $em_dash = _x( '&#8212;', 'em dash' );
 109
 110                 $default_no_texturize_tags = array('pre', 'code', 'kbd', 'style', 'script', 'tt');
 111                 $default_no_texturize_shortcodes = array('code');
 112
 113                 // if a plugin has provided an autocorrect array, use it
 114                 if ( isset($wp_cockneyreplace) ) {
 115                         $cockney = array_keys( $wp_cockneyreplace );
 116                         $cockneyreplace = array_values( $wp_cockneyreplace );
 117                 } else {
 118                         /* translators: This is a comma-separated list of words that defy the syntax of quotations in normal use,
 119                          * for example...  'We do not have enough words yet' ... is a typical quoted phrase.  But when we write
 120                          * lines of code 'til we have enough of 'em, then we need to insert apostrophes instead of quotes.
 121                          */
 122                         $cockney = explode( ',', _x( "'tain't,'twere,'twas,'tis,'twill,'til,'bout,'nuff,'round,'cause,'em",
 123                                 'Comma-separated list of words to texturize in your language' ) );
 124
 125                         $cockneyreplace = explode( ',', _x( '&#8217;tain&#8217;t,&#8217;twere,&#8217;twas,&#8217;tis,&#8217;twill,&#8217;til,&#8217;bout,&#8217;nuff,&#8217;round,&#8217;cause,&#8217;em',
 126                                 'Comma-separated list of replacement words in your language' ) );
 127                 }
 128
 129                 $static_characters = array_merge( array( '...', '``', '\'\'', ' (tm)' ), $cockney );
 130                 $static_replacements = array_merge( array( '&#8230;', $opening_quote, $closing_quote, ' &#8482;' ), $cockneyreplace );
 131
 132
 133                 // Pattern-based replacements of characters.
 134                 // Sort the remaining patterns into several arrays for performance tuning.
 135                 $dynamic_characters = array( 'apos' => array(), 'quote' => array(), 'dash' => array() );
 136                 $dynamic_replacements = array( 'apos' => array(), 'quote' => array(), 'dash' => array() );
 137                 $dynamic = array();
 138                 $spaces = wp_spaces_regexp();
 139
 140                 // '99' and '99" are ambiguous among other patterns; assume it's an abbreviated year at the end of a quotation.
 141                 if ( "'" !== $apos || "'" !== $closing_single_quote ) {
 142                         $dynamic[ '/\'(\d\d)\'(?=\Z|[.,:;!?)}\-\]]|&gt;|' . $spaces . ')/' ] = $apos_flag . '$1' . $closing_single_quote;
 143                 }
 144                 if ( "'" !== $apos || '"' !== $closing_quote ) {
 145                         $dynamic[ '/\'(\d\d)"(?=\Z|[.,:;!?)}\-\]]|&gt;|' . $spaces . ')/' ] = $apos_flag . '$1' . $closing_quote;
 146                 }
 147
 148                 // '99 '99s '99's (apostrophe)  But never '9 or '99% or '999 or '99.0.
 149                 if ( "'" !== $apos ) {
 150                         $dynamic[ '/\'(?=\d\d(?:\Z|(?![%\d]|[.,]\d)))/' ] = $apos_flag;
 151                 }
 152
 153                 // Quoted Numbers like '0.42'
 154                 if ( "'" !== $opening_single_quote && "'" !== $closing_single_quote ) {
 155                         $dynamic[ '/(?<=\A|' . $spaces . ')\'(\d[.,\d]*)\'/' ] = $open_sq_flag . '$1' . $closing_single_quote;
 156                 }
 157
 158                 // Single quote at start, or preceded by (, {, <, [, ", -, or spaces.
 159                 if ( "'" !== $opening_single_quote ) {
 160                         $dynamic[ '/(?<=\A|[([{"\-]|&lt;|' . $spaces . ')\'/' ] = $open_sq_flag;
 161                 }
 162
 163                 // Apostrophe in a word.  No spaces, double apostrophes, or other punctuation.
 164                 if ( "'" !== $apos ) {
 165                         $dynamic[ '/(?<!' . $spaces . ')\'(?!\Z|[.,:;!?"\'(){}[\]\-]|&[lg]t;|' . $spaces . ')/' ] = $apos_flag;
 166                 }
 167
 168                 $dynamic_characters['apos'] = array_keys( $dynamic );
 169                 $dynamic_replacements['apos'] = array_values( $dynamic );
 170                 $dynamic = array();
 171
 172                 // Quoted Numbers like "42"
 173                 if ( '"' !== $opening_quote && '"' !== $closing_quote ) {
 174                         $dynamic[ '/(?<=\A|' . $spaces . ')"(\d[.,\d]*)"/' ] = $open_q_flag . '$1' . $closing_quote;
 175                 }
 176
 177                 // Double quote at start, or preceded by (, {, <, [, -, or spaces, and not followed by spaces.
 178                 if ( '"' !== $opening_quote ) {
 179                         $dynamic[ '/(?<=\A|[([{\-]|&lt;|' . $spaces . ')"(?!' . $spaces . ')/' ] = $open_q_flag;
 180                 }
 181
 182                 $dynamic_characters['quote'] = array_keys( $dynamic );
 183                 $dynamic_replacements['quote'] = array_values( $dynamic );
 184                 $dynamic = array();
 185
 186                 // Dashes and spaces
 187                 $dynamic[ '/---/' ] = $em_dash;
 188                 $dynamic[ '/(?<=^|' . $spaces . ')--(?=$|' . $spaces . ')/' ] = $em_dash;
 189                 $dynamic[ '/(?<!xn)--/' ] = $en_dash;
 190                 $dynamic[ '/(?<=^|' . $spaces . ')-(?=$|' . $spaces . ')/' ] = $en_dash;
 191
 192                 $dynamic_characters['dash'] = array_keys( $dynamic );
 193                 $dynamic_replacements['dash'] = array_values( $dynamic );
 194         }
 195
 196         // Must do this every time in case plugins use these filters in a context sensitive manner
 197         /**
 198          * Filter the list of HTML elements not to texturize.
 199          *
 200          * @since 2.8.0
 201          *
 202          * @param array $default_no_texturize_tags An array of HTML element names.
 203          */
 204         $no_texturize_tags = apply_filters( 'no_texturize_tags', $default_no_texturize_tags );
 205         /**
 206          * Filter the list of shortcodes not to texturize.
 207          *
 208          * @since 2.8.0
 209          *
 210          * @param array $default_no_texturize_shortcodes An array of shortcode names.
 211          */
 212         $no_texturize_shortcodes = apply_filters( 'no_texturize_shortcodes', $default_no_texturize_shortcodes );
 213
 214         $no_texturize_tags_stack = array();
 215         $no_texturize_shortcodes_stack = array();
 216
 217         // Look for shortcodes and HTML elements.
 218
 219         preg_match_all( '@\[/?([^<>&/\[\]\x00-\x20=]++)@', $text, $matches );
 220         $tagnames = array_intersect( array_keys( $shortcode_tags ), $matches[1] );
 221         $found_shortcodes = ! empty( $tagnames );
 222         $shortcode_regex = $found_shortcodes ? _get_wptexturize_shortcode_regex( $tagnames ) : '';
 223         $regex = _get_wptexturize_split_regex( $shortcode_regex );
 224
 225         $textarr = preg_split( $regex, $text, -1, PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY );
 226
 227         foreach ( $textarr as &$curl ) {
 228                 // Only call _wptexturize_pushpop_element if $curl is a delimiter.
 229                 $first = $curl[0];
 230                 if ( '<' === $first ) {
 231                         if ( '<!--' === substr( $curl, 0, 4 ) ) {
 232                                 // This is an HTML comment delimiter.
 233                                 continue;
 234                         } else {
 235                                 // This is an HTML element delimiter.
 236
 237                                 // Replace each & with &#038; unless it already looks like an entity.
 238                                 $curl = preg_replace( '/&(?!#(?:\d+|x[a-f0-9]+);|[a-z1-4]{1,8};)/i', '&#038;', $curl );
 239
 240                                 _wptexturize_pushpop_element( $curl, $no_texturize_tags_stack, $no_texturize_tags );
 241                         }
 242
 243                 } elseif ( '' === trim( $curl ) ) {
 244                         // This is a newline between delimiters.  Performance improves when we check this.
 245                         continue;
 246
 247                 } elseif ( '[' === $first && $found_shortcodes && 1 === preg_match( '/^' . $shortcode_regex . '$/', $curl ) ) {
 248                         // This is a shortcode delimiter.
 249
 250                         if ( '[[' !== substr( $curl, 0, 2 ) && ']]' !== substr( $curl, -2 ) ) {
 251                                 // Looks like a normal shortcode.
 252                                 _wptexturize_pushpop_element( $curl, $no_texturize_shortcodes_stack, $no_texturize_shortcodes );
 253                         } else {
 254                                 // Looks like an escaped shortcode.
 255                                 continue;
 256                         }
 257
 258                 } elseif ( empty( $no_texturize_shortcodes_stack ) && empty( $no_texturize_tags_stack ) ) {
 259                         // This is neither a delimiter, nor is this content inside of no_texturize pairs.  Do texturize.
 260
 261                         $curl = str_replace( $static_characters, $static_replacements, $curl );
 262
 263                         if ( false !== strpos( $curl, "'" ) ) {
 264                                 $curl = preg_replace( $dynamic_characters['apos'], $dynamic_replacements['apos'], $curl );
 265                                 $curl = wptexturize_primes( $curl, "'", $prime, $open_sq_flag, $closing_single_quote );
 266                                 $curl = str_replace( $apos_flag, $apos, $curl );
 267                                 $curl = str_replace( $open_sq_flag, $opening_single_quote, $curl );
 268                         }
 269                         if ( false !== strpos( $curl, '"' ) ) {
 270                                 $curl = preg_replace( $dynamic_characters['quote'], $dynamic_replacements['quote'], $curl );
 271                                 $curl = wptexturize_primes( $curl, '"', $double_prime, $open_q_flag, $closing_quote );
 272                                 $curl = str_replace( $open_q_flag, $opening_quote, $curl );
 273                         }
 274                         if ( false !== strpos( $curl, '-' ) ) {
 275                                 $curl = preg_replace( $dynamic_characters['dash'], $dynamic_replacements['dash'], $curl );
 276                         }
 277
 278                         // 9x9 (times), but never 0x9999
 279                         if ( 1 === preg_match( '/(?<=\d)x\d/', $curl ) ) {
 280                                 // Searching for a digit is 10 times more expensive than for the x, so we avoid doing this one!
 281                                 $curl = preg_replace( '/\b(\d(?(?<=0)[\d\.,]+|[\d\.,]*))x(\d[\d\.,]*)\b/', '$1&#215;$2', $curl );
 282                         }
 283
 284                         // Replace each & with &#038; unless it already looks like an entity.
 285                         $curl = preg_replace( '/&(?!#(?:\d+|x[a-f0-9]+);|[a-z1-4]{1,8};)/i', '&#038;', $curl );
 286                 }
 287         }
 288
 289         return implode( '', $textarr );
 290 }
 291
 292 /**
 293  * Implements a logic tree to determine whether or not "7'." represents seven feet,
 294  * then converts the special char into either a prime char or a closing quote char.
 295  *
 296  * @since 4.3.0
 297  *
 298  * @param string $haystack    The plain text to be searched.
 299  * @param string $needle      The character to search for such as ' or ".
 300  * @param string $prime       The prime char to use for replacement.
 301  * @param string $open_quote  The opening quote char. Opening quote replacement must be
 302  *                            accomplished already.
 303  * @param string $close_quote The closing quote char to use for replacement.
 304  * @return string The $haystack value after primes and quotes replacements.
 305  */
 306 function wptexturize_primes( $haystack, $needle, $prime, $open_quote, $close_quote ) {
 307         $spaces = wp_spaces_regexp();
 308         $flag = '<!--wp-prime-or-quote-->';
 309         $quote_pattern = "/$needle(?=\\Z|[.,:;!?)}\\-\\]]|&gt;|" . $spaces . ")/";
 310         $prime_pattern    = "/(?<=\\d)$needle/";
 311         $flag_after_digit = "/(?<=\\d)$flag/";
 312         $flag_no_digit    = "/(?<!\\d)$flag/";
 313
 314         $sentences = explode( $open_quote, $haystack );
 315
 316         foreach ( $sentences as $key => &$sentence ) {
 317                 if ( false === strpos( $sentence, $needle ) ) {
 318                         continue;
 319                 } elseif ( 0 !== $key && 0 === substr_count( $sentence, $close_quote ) ) {
 320                         $sentence = preg_replace( $quote_pattern, $flag, $sentence, -1, $count );
 321                         if ( $count > 1 ) {
 322                                 // This sentence appears to have multiple closing quotes.  Attempt Vulcan logic.
 323                                 $sentence = preg_replace( $flag_no_digit, $close_quote, $sentence, -1, $count2 );
 324                                 if ( 0 === $count2 ) {
 325                                         // Try looking for a quote followed by a period.
 326                                         $count2 = substr_count( $sentence, "$flag." );
 327                                         if ( $count2 > 0 ) {
 328                                                 // Assume the rightmost quote-period match is the end of quotation.
 329                                                 $pos = strrpos( $sentence, "$flag." );
 330                                         } else {
 331                                                 // When all else fails, make the rightmost candidate a closing quote.
 332                                                 // This is most likely to be problematic in the context of bug #18549.
 333                                                 $pos = strrpos( $sentence, $flag );
 334                                         }
 335                                         $sentence = substr_replace( $sentence, $close_quote, $pos, strlen( $flag ) );
 336                                 }
 337                                 // Use conventional replacement on any remaining primes and quotes.
 338                                 $sentence = preg_replace( $prime_pattern, $prime, $sentence );
 339                                 $sentence = preg_replace( $flag_after_digit, $prime, $sentence );
 340                                 $sentence = str_replace( $flag, $close_quote, $sentence );
 341                         } elseif ( 1 == $count ) {
 342                                 // Found only one closing quote candidate, so give it priority over primes.
 343                                 $sentence = str_replace( $flag, $close_quote, $sentence );
 344                                 $sentence = preg_replace( $prime_pattern, $prime, $sentence );
 345                         } else {
 346                                 // No closing quotes found.  Just run primes pattern.
 347                                 $sentence = preg_replace( $prime_pattern, $prime, $sentence );
 348                         }
 349                 } else {
 350                         $sentence = preg_replace( $prime_pattern, $prime, $sentence );
 351                         $sentence = preg_replace( $quote_pattern, $close_quote, $sentence );
 352                 }
 353                 if ( '"' == $needle && false !== strpos( $sentence, '"' ) ) {
 354                         $sentence = str_replace( '"', $close_quote, $sentence );
 355                 }
 356         }
 357
 358         return implode( $open_quote, $sentences );
 359 }
 360
 361 /**
 362  * Search for disabled element tags. Push element to stack on tag open and pop
 363  * on tag close.
 364  *
 365  * Assumes first char of $text is tag opening and last char is tag closing.
 366  * Assumes second char of $text is optionally '/' to indicate closing as in </html>.
 367  *
 368  * @since 2.9.0
 369  * @access private
 370  *
 371  * @param string $text Text to check. Must be a tag like `<html>` or `[shortcode]`.
 372  * @param array  $stack List of open tag elements.
 373  * @param array  $disabled_elements The tag names to match against. Spaces are not allowed in tag names.
 374  */
 375 function _wptexturize_pushpop_element( $text, &$stack, $disabled_elements ) {
 376         // Is it an opening tag or closing tag?
 377         if ( isset( $text[1] ) && '/' !== $text[1] ) {
 378                 $opening_tag = true;
 379                 $name_offset = 1;
 380         } elseif ( 0 == count( $stack ) ) {
 381                 // Stack is empty. Just stop.
 382                 return;
 383         } else {
 384                 $opening_tag = false;
 385                 $name_offset = 2;
 386         }
 387
 388         // Parse out the tag name.
 389         $space = strpos( $text, ' ' );
 390         if ( false === $space ) {
 391                 $space = -1;
 392         } else {
 393                 $space -= $name_offset;
 394         }
 395         $tag = substr( $text, $name_offset, $space );
 396
 397         // Handle disabled tags.
 398         if ( in_array( $tag, $disabled_elements ) ) {
 399                 if ( $opening_tag ) {
 400                         /*
 401                          * This disables texturize until we find a closing tag of our type
 402                          * (e.g. <pre>) even if there was invalid nesting before that
 403                          *
 404                          * Example: in the case <pre>sadsadasd</code>"baba"</pre>
 405                          *          "baba" won't be texturize
 406                          */
 407
 408                         array_push( $stack, $tag );
 409                 } elseif ( end( $stack ) == $tag ) {
 410                         array_pop( $stack );
 411                 }
 412         }
 413 }
 414
 415 /**
 416  * Replaces double line-breaks with paragraph elements.
 417  *
 418  * A group of regex replaces used to identify text formatted with newlines and
 419  * replace double line-breaks with HTML paragraph tags. The remaining line-breaks
 420  * after conversion become <<br />> tags, unless $br is set to '0' or 'false'.
 421  *
 422  * @since 0.71
 423  *
 424  * @param string $pee The text which has to be formatted.
 425  * @param bool   $br  Optional. If set, this will convert all remaining line-breaks
 426  *                    after paragraphing. Default true.
 427  * @return string Text which has been converted into correct paragraph tags.
 428  */
 429 function wpautop( $pee, $br = true ) {
 430         $pre_tags = array();
 431
 432         if ( trim($pee) === '' )
 433                 return '';
 434
 435         // Just to make things a little easier, pad the end.
 436         $pee = $pee . "\n";
 437
 438         /*
 439          * Pre tags shouldn't be touched by autop.
 440          * Replace pre tags with placeholders and bring them back after autop.
 441          */
 442         if ( strpos($pee, '<pre') !== false ) {
 443                 $pee_parts = explode( '</pre>', $pee );
 444                 $last_pee = array_pop($pee_parts);
 445                 $pee = '';
 446                 $i = 0;
 447
 448                 foreach ( $pee_parts as $pee_part ) {
 449                         $start = strpos($pee_part, '<pre');
 450
 451                         // Malformed html?
 452                         if ( $start === false ) {
 453                                 $pee .= $pee_part;
 454                                 continue;
 455                         }
 456
 457                         $name = "<pre wp-pre-tag-$i></pre>";
 458                         $pre_tags[$name] = substr( $pee_part, $start ) . '</pre>';
 459
 460                         $pee .= substr( $pee_part, 0, $start ) . $name;
 461                         $i++;
 462                 }
 463
 464                 $pee .= $last_pee;
 465         }
 466         // Change multiple <br>s into two line breaks, which will turn into paragraphs.
 467         $pee = preg_replace('|<br\s*/?>\s*<br\s*/?>|', "\n\n", $pee);
 468
 469         $allblocks = '(?:table|thead|tfoot|caption|col|colgroup|tbody|tr|td|th|div|dl|dd|dt|ul|ol|li|pre|form|map|area|blockquote|address|math|style|p|h[1-6]|hr|fieldset|legend|section|article|aside|hgroup|header|footer|nav|figure|figcaption|details|menu|summary)';
 470
 471         // Add a single line break above block-level opening tags.
 472         $pee = preg_replace('!(<' . $allblocks . '[\s/>])!', "\n$1", $pee);
 473
 474         // Add a double line break below block-level closing tags.
 475         $pee = preg_replace('!(</' . $allblocks . '>)!', "$1\n\n", $pee);
 476
 477         // Standardize newline characters to "\n".
 478         $pee = str_replace(array("\r\n", "\r"), "\n", $pee);
 479
 480         // Find newlines in all elements and add placeholders.
 481         $pee = wp_replace_in_html_tags( $pee, array( "\n" => " <!-- wpnl --> " ) );
 482
 483         // Collapse line breaks before and after <option> elements so they don't get autop'd.
 484         if ( strpos( $pee, '<option' ) !== false ) {
 485                 $pee = preg_replace( '|\s*<option|', '<option', $pee );
 486                 $pee = preg_replace( '|</option>\s*|', '</option>', $pee );
 487         }
 488
 489         /*
 490          * Collapse line breaks inside <object> elements, before <param> and <embed> elements
 491          * so they don't get autop'd.
 492          */
 493         if ( strpos( $pee, '</object>' ) !== false ) {
 494                 $pee = preg_replace( '|(<object[^>]*>)\s*|', '$1', $pee );
 495                 $pee = preg_replace( '|\s*</object>|', '</object>', $pee );
 496                 $pee = preg_replace( '%\s*(</?(?:param|embed)[^>]*>)\s*%', '$1', $pee );
 497         }
 498
 499         /*
 500          * Collapse line breaks inside <audio> and <video> elements,
 501          * before and after <source> and <track> elements.
 502          */
 503         if ( strpos( $pee, '<source' ) !== false || strpos( $pee, '<track' ) !== false ) {
 504                 $pee = preg_replace( '%([<\[](?:audio|video)[^>\]]*[>\]])\s*%', '$1', $pee );
 505                 $pee = preg_replace( '%\s*([<\[]/(?:audio|video)[>\]])%', '$1', $pee );
 506                 $pee = preg_replace( '%\s*(<(?:source|track)[^>]*>)\s*%', '$1', $pee );
 507         }
 508
 509         // Remove more than two contiguous line breaks.
 510         $pee = preg_replace("/\n\n+/", "\n\n", $pee);
 511
 512         // Split up the contents into an array of strings, separated by double line breaks.
 513         $pees = preg_split('/\n\s*\n/', $pee, -1, PREG_SPLIT_NO_EMPTY);
 514
 515         // Reset $pee prior to rebuilding.
 516         $pee = '';
 517
 518         // Rebuild the content as a string, wrapping every bit with a <p>.
 519         foreach ( $pees as $tinkle ) {
 520                 $pee .= '<p>' . trim($tinkle, "\n") . "</p>\n";
 521         }
 522
 523         // Under certain strange conditions it could create a P of entirely whitespace.
 524         $pee = preg_replace('|<p>\s*</p>|', '', $pee);
 525
 526         // Add a closing <p> inside <div>, <address>, or <form> tag if missing.
 527         $pee = preg_replace('!<p>([^<]+)</(div|address|form)>!', "<p>$1</p></$2>", $pee);
 528
 529         // If an opening or closing block element tag is wrapped in a <p>, unwrap it.
 530         $pee = preg_replace('!<p>\s*(</?' . $allblocks . '[^>]*>)\s*</p>!', "$1", $pee);
 531
 532         // In some cases <li> may get wrapped in <p>, fix them.
 533         $pee = preg_replace("|<p>(<li.+?)</p>|", "$1", $pee);
 534
 535         // If a <blockquote> is wrapped with a <p>, move it inside the <blockquote>.
 536         $pee = preg_replace('|<p><blockquote([^>]*)>|i', "<blockquote$1><p>", $pee);
 537         $pee = str_replace('</blockquote></p>', '</p></blockquote>', $pee);
 538
 539         // If an opening or closing block element tag is preceded by an opening <p> tag, remove it.
 540         $pee = preg_replace('!<p>\s*(</?' . $allblocks . '[^>]*>)!', "$1", $pee);
 541
 542         // If an opening or closing block element tag is followed by a closing <p> tag, remove it.
 543         $pee = preg_replace('!(</?' . $allblocks . '[^>]*>)\s*</p>!', "$1", $pee);
 544
 545         // Optionally insert line breaks.
 546         if ( $br ) {
 547                 // Replace newlines that shouldn't be touched with a placeholder.
 548                 $pee = preg_replace_callback('/<(script|style).*?<\/\\1>/s', '_autop_newline_preservation_helper', $pee);
 549
 550                 // Normalize <br>
 551                 $pee = str_replace( array( '<br>', '<br/>' ), '<br />', $pee );
 552
 553                 // Replace any new line characters that aren't preceded by a <br /> with a <br />.
 554                 $pee = preg_replace('|(?<!<br />)\s*\n|', "<br />\n", $pee);
 555
 556                 // Replace newline placeholders with newlines.
 557                 $pee = str_replace('<WPPreserveNewline />', "\n", $pee);
 558         }
 559
 560         // If a <br /> tag is after an opening or closing block tag, remove it.
 561         $pee = preg_replace('!(</?' . $allblocks . '[^>]*>)\s*<br />!', "$1", $pee);
 562
 563         // If a <br /> tag is before a subset of opening or closing block tags, remove it.
 564         $pee = preg_replace('!<br />(\s*</?(?:p|li|div|dl|dd|dt|th|pre|td|ul|ol)[^>]*>)!', '$1', $pee);
 565         $pee = preg_replace( "|\n</p>$|", '</p>', $pee );
 566
 567         // Replace placeholder <pre> tags with their original content.
 568         if ( !empty($pre_tags) )
 569                 $pee = str_replace(array_keys($pre_tags), array_values($pre_tags), $pee);
 570
 571         // Restore newlines in all elements.
 572         if ( false !== strpos( $pee, '<!-- wpnl -->' ) ) {
 573                 $pee = str_replace( array( ' <!-- wpnl --> ', '<!-- wpnl -->' ), "\n", $pee );
 574         }
 575
 576         return $pee;
 577 }
 578
 579 /**
 580  * Separate HTML elements and comments from the text.
 581  *
 582  * @since 4.2.4
 583  *
 584  * @param string $input The text which has to be formatted.
 585  * @return array The formatted text.
 586  */
 587 function wp_html_split( $input ) {
 588         return preg_split( get_html_split_regex(), $input, -1, PREG_SPLIT_DELIM_CAPTURE );
 589 }
 590
 591 /**
 592  * Retrieve the regular expression for an HTML element.
 593  *
 594  * @since 4.4.0
 595  *
 596  * @return string The regular expression
 597  */
 598 function get_html_split_regex() {
 599         static $regex;
 600
 601         if ( ! isset( $regex ) ) {
 602                 $comments =
 603                           '!'           // Start of comment, after the <.
 604                         . '(?:'         // Unroll the loop: Consume everything until --> is found.
 605                         .     '-(?!->)' // Dash not followed by end of comment.
 606                         .     '[^\-]*+' // Consume non-dashes.
 607                         . ')*+'         // Loop possessively.
 608                         . '(?:-->)?';   // End of comment. If not found, match all input.
 609
 610                 $cdata =
 611                           '!\[CDATA\['  // Start of comment, after the <.
 612                         . '[^\]]*+'     // Consume non-].
 613                         . '(?:'         // Unroll the loop: Consume everything until ]]> is found.
 614                         .     '](?!]>)' // One ] not followed by end of comment.
 615                         .     '[^\]]*+' // Consume non-].
 616                         . ')*+'         // Loop possessively.
 617                         . '(?:]]>)?';   // End of comment. If not found, match all input.
 618
 619                 $escaped =
 620                           '(?='           // Is the element escaped?
 621                         .    '!--'
 622                         . '|'
 623                         .    '!\[CDATA\['
 624                         . ')'
 625                         . '(?(?=!-)'      // If yes, which type?
 626                         .     $comments
 627                         . '|'
 628                         .     $cdata
 629                         . ')';
 630
 631                 $regex =
 632                           '/('              // Capture the entire match.
 633                         .     '<'           // Find start of element.
 634                         .     '(?'          // Conditional expression follows.
 635                         .         $escaped  // Find end of escaped element.
 636                         .     '|'           // ... else ...
 637                         .         '[^>]*>?' // Find end of normal element.
 638                         .     ')'
 639                         . ')/';
 640         }
 641
 642         return $regex;
 643 }
 644
 645 /**
 646  * Retrieve the combined regular expression for HTML and shortcodes.
 647  *
 648  * @access private
 649  * @ignore
 650  * @internal This function will be removed in 4.5.0 per Shortcode API Roadmap.
 651  * @since 4.4.0
 652  *
 653  * @param string $shortcode_regex The result from _get_wptexturize_shortcode_regex().  Optional.
 654  * @return string The regular expression
 655  */
 656 function _get_wptexturize_split_regex( $shortcode_regex = '' ) {
 657         static $html_regex;
 658
 659         if ( ! isset( $html_regex ) ) {
 660                 $comment_regex =
 661                           '!'           // Start of comment, after the <.
 662                         . '(?:'         // Unroll the loop: Consume everything until --> is found.
 663                         .     '-(?!->)' // Dash not followed by end of comment.
 664                         .     '[^\-]*+' // Consume non-dashes.
 665                         . ')*+'         // Loop possessively.
 666                         . '(?:-->)?';   // End of comment. If not found, match all input.
 667
 668                 $html_regex =                    // Needs replaced with wp_html_split() per Shortcode API Roadmap.
 669                           '<'                // Find start of element.
 670                         . '(?(?=!--)'        // Is this a comment?
 671                         .     $comment_regex // Find end of comment.
 672                         . '|'
 673                         .     '[^>]*>?'      // Find end of element. If not found, match all input.
 674                         . ')';
 675         }
 676
 677         if ( empty( $shortcode_regex ) ) {
 678                 $regex = '/(' . $html_regex . ')/';
 679         } else {
 680                 $regex = '/(' . $html_regex . '|' . $shortcode_regex . ')/';
 681         }
 682
 683         return $regex;
 684 }
 685
 686 /**
 687  * Retrieve the regular expression for shortcodes.
 688  *
 689  * @access private
 690  * @ignore
 691  * @internal This function will be removed in 4.5.0 per Shortcode API Roadmap.
 692  * @since 4.4.0
 693  *
 694  * @param array $tagnames List of shortcodes to find.
 695  * @return string The regular expression
 696  */
 697 function _get_wptexturize_shortcode_regex( $tagnames ) {
 698         $tagregexp = join( '|', array_map( 'preg_quote', $tagnames ) );
 699         $tagregexp = "(?:$tagregexp)(?=[\\s\\]\\/])"; // Excerpt of get_shortcode_regex().
 700         $regex =
 701                   '\['              // Find start of shortcode.
 702                 . '[\/\[]?'         // Shortcodes may begin with [/ or [[
 703                 . $tagregexp        // Only match registered shortcodes, because performance.
 704                 . '(?:'
 705                 .     '[^\[\]<>]+'  // Shortcodes do not contain other shortcodes. Quantifier critical.
 706                 . '|'
 707                 .     '<[^\[\]>]*>' // HTML elements permitted. Prevents matching ] before >.
 708                 . ')*+'             // Possessive critical.
 709                 . '\]'              // Find end of shortcode.
 710                 . '\]?';            // Shortcodes may end with ]]
 711
 712         return $regex;
 713 }
 714
 715 /**
 716  * Replace characters or phrases within HTML elements only.
 717  *
 718  * @since 4.2.3
 719  *
 720  * @param string $haystack The text which has to be formatted.
 721  * @param array $replace_pairs In the form array('from' => 'to', ...).
 722  * @return string The formatted text.
 723  */
 724 function wp_replace_in_html_tags( $haystack, $replace_pairs ) {
 725         // Find all elements.
 726         $textarr = wp_html_split( $haystack );
 727         $changed = false;
 728
 729         // Optimize when searching for one item.
 730         if ( 1 === count( $replace_pairs ) ) {
 731                 // Extract $needle and $replace.
 732                 foreach ( $replace_pairs as $needle => $replace );
 733
 734                 // Loop through delimiters (elements) only.
 735                 for ( $i = 1, $c = count( $textarr ); $i < $c; $i += 2 ) {
 736                         if ( false !== strpos( $textarr[$i], $needle ) ) {
 737                                 $textarr[$i] = str_replace( $needle, $replace, $textarr[$i] );
 738                                 $changed = true;
 739                         }
 740                 }
 741         } else {
 742                 // Extract all $needles.
 743                 $needles = array_keys( $replace_pairs );
 744
 745                 // Loop through delimiters (elements) only.
 746                 for ( $i = 1, $c = count( $textarr ); $i < $c; $i += 2 ) {
 747                         foreach ( $needles as $needle ) {
 748                                 if ( false !== strpos( $textarr[$i], $needle ) ) {
 749                                         $textarr[$i] = strtr( $textarr[$i], $replace_pairs );
 750                                         $changed = true;
 751                                         // After one strtr() break out of the foreach loop and look at next element.
 752                                         break;
 753                                 }
 754                         }
 755                 }
 756         }
 757
 758         if ( $changed ) {
 759                 $haystack = implode( $textarr );
 760         }
 761
 762         return $haystack;
 763 }
 764
 765 /**
 766  * Newline preservation help function for wpautop
 767  *
 768  * @since 3.1.0
 769  * @access private
 770  *
 771  * @param array $matches preg_replace_callback matches array
 772  * @return string
 773  */
 774 function _autop_newline_preservation_helper( $matches ) {
 775         return str_replace( "\n", "<WPPreserveNewline />", $matches[0] );
 776 }
 777
 778 /**
 779  * Don't auto-p wrap shortcodes that stand alone
 780  *
 781  * Ensures that shortcodes are not wrapped in `<p>...</p>`.
 782  *
 783  * @since 2.9.0
 784  *
 785  * @global array $shortcode_tags
 786  *
 787  * @param string $pee The content.
 788  * @return string The filtered content.
 789  */
 790 function shortcode_unautop( $pee ) {
 791         global $shortcode_tags;
 792
 793         if ( empty( $shortcode_tags ) || !is_array( $shortcode_tags ) ) {
 794                 return $pee;
 795         }
 796
 797         $tagregexp = join( '|', array_map( 'preg_quote', array_keys( $shortcode_tags ) ) );
 798         $spaces = wp_spaces_regexp();
 799
 800         $pattern =
 801                   '/'
 802                 . '<p>'                              // Opening paragraph
 803                 . '(?:' . $spaces . ')*+'            // Optional leading whitespace
 804                 . '('                                // 1: The shortcode
 805                 .     '\\['                          // Opening bracket
 806                 .     "($tagregexp)"                 // 2: Shortcode name
 807                 .     '(?![\\w-])'                   // Not followed by word character or hyphen
 808                                                      // Unroll the loop: Inside the opening shortcode tag
 809                 .     '[^\\]\\/]*'                   // Not a closing bracket or forward slash
 810                 .     '(?:'
 811                 .         '\\/(?!\\])'               // A forward slash not followed by a closing bracket
 812                 .         '[^\\]\\/]*'               // Not a closing bracket or forward slash
 813                 .     ')*?'
 814                 .     '(?:'
 815                 .         '\\/\\]'                   // Self closing tag and closing bracket
 816                 .     '|'
 817                 .         '\\]'                      // Closing bracket
 818                 .         '(?:'                      // Unroll the loop: Optionally, anything between the opening and closing shortcode tags
 819                 .             '[^\\[]*+'             // Not an opening bracket
 820                 .             '(?:'
 821                 .                 '\\[(?!\\/\\2\\])' // An opening bracket not followed by the closing shortcode tag
 822                 .                 '[^\\[]*+'         // Not an opening bracket
 823                 .             ')*+'
 824                 .             '\\[\\/\\2\\]'         // Closing shortcode tag
 825                 .         ')?'
 826                 .     ')'
 827                 . ')'
 828                 . '(?:' . $spaces . ')*+'            // optional trailing whitespace
 829                 . '<\\/p>'                           // closing paragraph
 830                 . '/';
 831
 832         return preg_replace( $pattern, '$1', $pee );
 833 }
 834
 835 /**
 836  * Checks to see if a string is utf8 encoded.
 837  *
 838  * NOTE: This function checks for 5-Byte sequences, UTF8
 839  *       has Bytes Sequences with a maximum length of 4.
 840  *
 841  * @author bmorel at ssi dot fr (modified)
 842  * @since 1.2.1
 843  *
 844  * @param string $str The string to be checked
 845  * @return bool True if $str fits a UTF-8 model, false otherwise.
 846  */
 847 function seems_utf8( $str ) {
 848         mbstring_binary_safe_encoding();
 849         $length = strlen($str);
 850         reset_mbstring_encoding();
 851         for ($i=0; $i < $length; $i++) {
 852                 $c = ord($str[$i]);
 853                 if ($c < 0x80) $n = 0; // 0bbbbbbb
 854                 elseif (($c & 0xE0) == 0xC0) $n=1; // 110bbbbb
 855                 elseif (($c & 0xF0) == 0xE0) $n=2; // 1110bbbb
 856                 elseif (($c & 0xF8) == 0xF0) $n=3; // 11110bbb
 857                 elseif (($c & 0xFC) == 0xF8) $n=4; // 111110bb
 858                 elseif (($c & 0xFE) == 0xFC) $n=5; // 1111110b
 859                 else return false; // Does not match any model
 860                 for ($j=0; $j<$n; $j++) { // n bytes matching 10bbbbbb follow ?
 861                         if ((++$i == $length) || ((ord($str[$i]) & 0xC0) != 0x80))
 862                                 return false;
 863                 }
 864         }
 865         return true;
 866 }
 867
 868 /**
 869  * Converts a number of special characters into their HTML entities.
 870  *
 871  * Specifically deals with: &, <, >, ", and '.
 872  *
 873  * $quote_style can be set to ENT_COMPAT to encode " to
 874  * &quot;, or ENT_QUOTES to do both. Default is ENT_NOQUOTES where no quotes are encoded.
 875  *
 876  * @since 1.2.2
 877  * @access private
 878  *
 879  * @staticvar string $_charset
 880  *
 881  * @param string     $string         The text which is to be encoded.
 882  * @param int|string $quote_style    Optional. Converts double quotes if set to ENT_COMPAT,
 883  *                                   both single and double if set to ENT_QUOTES or none if set to ENT_NOQUOTES.
 884  *                                   Also compatible with old values; converting single quotes if set to 'single',
 885  *                                   double if set to 'double' or both if otherwise set.
 886  *                                   Default is ENT_NOQUOTES.
 887  * @param string     $charset        Optional. The character encoding of the string. Default is false.
 888  * @param bool       $double_encode  Optional. Whether to encode existing html entities. Default is false.
 889  * @return string The encoded text with HTML entities.
 890  */
 891 function _wp_specialchars( $string, $quote_style = ENT_NOQUOTES, $charset = false, $double_encode = false ) {
 892         $string = (string) $string;
 893
 894         if ( 0 === strlen( $string ) )
 895                 return '';
 896
 897         // Don't bother if there are no specialchars - saves some processing
 898         if ( ! preg_match( '/[&<>"\']/', $string ) )
 899                 return $string;
 900
 901         // Account for the previous behaviour of the function when the $quote_style is not an accepted value
 902         if ( empty( $quote_style ) )
 903                 $quote_style = ENT_NOQUOTES;
 904         elseif ( ! in_array( $quote_style, array( 0, 2, 3, 'single', 'double' ), true ) )
 905                 $quote_style = ENT_QUOTES;
 906
 907         // Store the site charset as a static to avoid multiple calls to wp_load_alloptions()
 908         if ( ! $charset ) {
 909                 static $_charset = null;
 910                 if ( ! isset( $_charset ) ) {
 911                         $alloptions = wp_load_alloptions();
 912                         $_charset = isset( $alloptions['blog_charset'] ) ? $alloptions['blog_charset'] : '';
 913                 }
 914                 $charset = $_charset;
 915         }
 916
 917         if ( in_array( $charset, array( 'utf8', 'utf-8', 'UTF8' ) ) )
 918                 $charset = 'UTF-8';
 919
 920         $_quote_style = $quote_style;
 921
 922         if ( $quote_style === 'double' ) {
 923                 $quote_style = ENT_COMPAT;
 924                 $_quote_style = ENT_COMPAT;
 925         } elseif ( $quote_style === 'single' ) {
 926                 $quote_style = ENT_NOQUOTES;
 927         }
 928
 929         if ( ! $double_encode ) {
 930                 // Guarantee every &entity; is valid, convert &garbage; into &amp;garbage;
 931                 // This is required for PHP < 5.4.0 because ENT_HTML401 flag is unavailable.
 932                 $string = wp_kses_normalize_entities( $string );
 933         }
 934
 935         $string = @htmlspecialchars( $string, $quote_style, $charset, $double_encode );
 936
 937         // Backwards compatibility
 938         if ( 'single' === $_quote_style )
 939                 $string = str_replace( "'", '&#039;', $string );
 940
 941         return $string;
 942 }
 943
 944 /**
 945  * Converts a number of HTML entities into their special characters.
 946  *
 947  * Specifically deals with: &, <, >, ", and '.
 948  *
 949  * $quote_style can be set to ENT_COMPAT to decode " entities,
 950  * or ENT_QUOTES to do both " and '. Default is ENT_NOQUOTES where no quotes are decoded.
 951  *
 952  * @since 2.8.0
 953  *
 954  * @param string     $string The text which is to be decoded.
 955  * @param string|int $quote_style Optional. Converts double quotes if set to ENT_COMPAT,
 956  *                                both single and double if set to ENT_QUOTES or
 957  *                                none if set to ENT_NOQUOTES.
 958  *                                Also compatible with old _wp_specialchars() values;
 959  *                                converting single quotes if set to 'single',
 960  *                                double if set to 'double' or both if otherwise set.
 961  *                                Default is ENT_NOQUOTES.
 962  * @return string The decoded text without HTML entities.
 963  */
 964 function wp_specialchars_decode( $string, $quote_style = ENT_NOQUOTES ) {
 965         $string = (string) $string;
 966
 967         if ( 0 === strlen( $string ) ) {
 968                 return '';
 969         }
 970
 971         // Don't bother if there are no entities - saves a lot of processing
 972         if ( strpos( $string, '&' ) === false ) {
 973                 return $string;
 974         }
 975
 976         // Match the previous behaviour of _wp_specialchars() when the $quote_style is not an accepted value
 977         if ( empty( $quote_style ) ) {
 978                 $quote_style = ENT_NOQUOTES;
 979         } elseif ( !in_array( $quote_style, array( 0, 2, 3, 'single', 'double' ), true ) ) {
 980                 $quote_style = ENT_QUOTES;
 981         }
 982
 983         // More complete than get_html_translation_table( HTML_SPECIALCHARS )
 984         $single = array( '&#039;'  => '\'', '&#x27;' => '\'' );
 985         $single_preg = array( '/&#0*39;/'  => '&#039;', '/&#x0*27;/i' => '&#x27;' );
 986         $double = array( '&quot;' => '"', '&#034;'  => '"', '&#x22;' => '"' );
 987         $double_preg = array( '/&#0*34;/'  => '&#034;', '/&#x0*22;/i' => '&#x22;' );
 988         $others = array( '&lt;'   => '<', '&#060;'  => '<', '&gt;'   => '>', '&#062;'  => '>', '&amp;'  => '&', '&#038;'  => '&', '&#x26;' => '&' );
 989         $others_preg = array( '/&#0*60;/'  => '&#060;', '/&#0*62;/'  => '&#062;', '/&#0*38;/'  => '&#038;', '/&#x0*26;/i' => '&#x26;' );
 990
 991         if ( $quote_style === ENT_QUOTES ) {
 992                 $translation = array_merge( $single, $double, $others );
 993                 $translation_preg = array_merge( $single_preg, $double_preg, $others_preg );
 994         } elseif ( $quote_style === ENT_COMPAT || $quote_style === 'double' ) {
 995                 $translation = array_merge( $double, $others );
 996                 $translation_preg = array_merge( $double_preg, $others_preg );
 997         } elseif ( $quote_style === 'single' ) {
 998                 $translation = array_merge( $single, $others );
 999                 $translation_preg = array_merge( $single_preg, $others_preg );
1000         } elseif ( $quote_style === ENT_NOQUOTES ) {
1001                 $translation = $others;
1002                 $translation_preg = $others_preg;
1003         }
1004
1005         // Remove zero padding on numeric entities
1006         $string = preg_replace( array_keys( $translation_preg ), array_values( $translation_preg ), $string );
1007
1008         // Replace characters according to translation table
1009         return strtr( $string, $translation );
1010 }
1011
1012 /**
1013  * Checks for invalid UTF8 in a string.
1014  *
1015  * @since 2.8.0
1016  *
1017  * @staticvar bool $is_utf8
1018  * @staticvar bool $utf8_pcre
1019  *
1020  * @param string  $string The text which is to be checked.
1021  * @param bool    $strip Optional. Whether to attempt to strip out invalid UTF8. Default is false.
1022  * @return string The checked text.
1023  */
1024 function wp_check_invalid_utf8( $string, $strip = false ) {
1025         $string = (string) $string;
1026
1027         if ( 0 === strlen( $string ) ) {
1028                 return '';
1029         }
1030
1031         // Store the site charset as a static to avoid multiple calls to get_option()
1032         static $is_utf8 = null;
1033         if ( ! isset( $is_utf8 ) ) {
1034                 $is_utf8 = in_array( get_option( 'blog_charset' ), array( 'utf8', 'utf-8', 'UTF8', 'UTF-8' ) );
1035         }
1036         if ( ! $is_utf8 ) {
1037                 return $string;
1038         }
1039
1040         // Check for support for utf8 in the installed PCRE library once and store the result in a static
1041         static $utf8_pcre = null;
1042         if ( ! isset( $utf8_pcre ) ) {
1043                 $utf8_pcre = @preg_match( '/^./u', 'a' );
1044         }
1045         // We can't demand utf8 in the PCRE installation, so just return the string in those cases
1046         if ( !$utf8_pcre ) {
1047                 return $string;
1048         }
1049
1050         // preg_match fails when it encounters invalid UTF8 in $string
1051         if ( 1 === @preg_match( '/^./us', $string ) ) {
1052                 return $string;
1053         }
1054
1055         // Attempt to strip the bad chars if requested (not recommended)
1056         if ( $strip && function_exists( 'iconv' ) ) {
1057                 return iconv( 'utf-8', 'utf-8', $string );
1058         }
1059
1060         return '';
1061 }
1062
1063 /**
1064  * Encode the Unicode values to be used in the URI.
1065  *
1066  * @since 1.5.0
1067  *
1068  * @param string $utf8_string
1069  * @param int    $length Max  length of the string
1070  * @return string String with Unicode encoded for URI.
1071  */
1072 function utf8_uri_encode( $utf8_string, $length = 0 ) {
1073         $unicode = '';
1074         $values = array();
1075         $num_octets = 1;
1076         $unicode_length = 0;
1077
1078         mbstring_binary_safe_encoding();
1079         $string_length = strlen( $utf8_string );
1080         reset_mbstring_encoding();
1081
1082         for ($i = 0; $i < $string_length; $i++ ) {
1083
1084                 $value = ord( $utf8_string[ $i ] );
1085
1086                 if ( $value < 128 ) {
1087                         if ( $length && ( $unicode_length >= $length ) )
1088                                 break;
1089                         $unicode .= chr($value);
1090                         $unicode_length++;
1091                 } else {
1092                         if ( count( $values ) == 0 ) {
1093                                 if ( $value < 224 ) {
1094                                         $num_octets = 2;
1095                                 } elseif ( $value < 240 ) {
1096                                         $num_octets = 3;
1097                                 } else {
1098                                         $num_octets = 4;
1099                                 }
1100                         }
1101
1102                         $values[] = $value;
1103
1104                         if ( $length && ( $unicode_length + ($num_octets * 3) ) > $length )
1105                                 break;
1106                         if ( count( $values ) == $num_octets ) {
1107                                 for ( $j = 0; $j < $num_octets; $j++ ) {
1108                                         $unicode .= '%' . dechex( $values[ $j ] );
1109                                 }
1110
1111                                 $unicode_length += $num_octets * 3;
1112
1113                                 $values = array();
1114                                 $num_octets = 1;
1115                         }
1116                 }
1117         }
1118
1119         return $unicode;
1120 }
1121
1122 /**
1123  * Converts all accent characters to ASCII characters.
1124  *
1125  * If there are no accent characters, then the string given is just returned.
1126  *
1127  * @since 1.2.1
1128  *
1129  * @param string $string Text that might have accent characters
1130  * @return string Filtered string with replaced "nice" characters.
1131  */
1132 function remove_accents( $string ) {
1133         if ( !preg_match('/[\x80-\xff]/', $string) )
1134                 return $string;
1135
1136         if (seems_utf8($string)) {
1137                 $chars = array(
1138                 // Decompositions for Latin-1 Supplement
1139                 chr(194).chr(170) => 'a', chr(194).chr(186) => 'o',
1140                 chr(195).chr(128) => 'A', chr(195).chr(129) => 'A',
1141                 chr(195).chr(130) => 'A', chr(195).chr(131) => 'A',
1142                 chr(195).chr(132) => 'A', chr(195).chr(133) => 'A',
1143                 chr(195).chr(134) => 'AE',chr(195).chr(135) => 'C',
1144                 chr(195).chr(136) => 'E', chr(195).chr(137) => 'E',
1145                 chr(195).chr(138) => 'E', chr(195).chr(139) => 'E',
1146                 chr(195).chr(140) => 'I', chr(195).chr(141) => 'I',
1147                 chr(195).chr(142) => 'I', chr(195).chr(143) => 'I',
1148                 chr(195).chr(144) => 'D', chr(195).chr(145) => 'N',
1149                 chr(195).chr(146) => 'O', chr(195).chr(147) => 'O',
1150                 chr(195).chr(148) => 'O', chr(195).chr(149) => 'O',
1151                 chr(195).chr(150) => 'O', chr(195).chr(153) => 'U',
1152                 chr(195).chr(154) => 'U', chr(195).chr(155) => 'U',
1153                 chr(195).chr(156) => 'U', chr(195).chr(157) => 'Y',
1154                 chr(195).chr(158) => 'TH',chr(195).chr(159) => 's',
1155                 chr(195).chr(160) => 'a', chr(195).chr(161) => 'a',
1156                 chr(195).chr(162) => 'a', chr(195).chr(163) => 'a',
1157                 chr(195).chr(164) => 'a', chr(195).chr(165) => 'a',
1158                 chr(195).chr(166) => 'ae',chr(195).chr(167) => 'c',
1159                 chr(195).chr(168) => 'e', chr(195).chr(169) => 'e',
1160                 chr(195).chr(170) => 'e', chr(195).chr(171) => 'e',
1161                 chr(195).chr(172) => 'i', chr(195).chr(173) => 'i',
1162                 chr(195).chr(174) => 'i', chr(195).chr(175) => 'i',
1163                 chr(195).chr(176) => 'd', chr(195).chr(177) => 'n',
1164                 chr(195).chr(178) => 'o', chr(195).chr(179) => 'o',
1165                 chr(195).chr(180) => 'o', chr(195).chr(181) => 'o',
1166                 chr(195).chr(182) => 'o', chr(195).chr(184) => 'o',
1167                 chr(195).chr(185) => 'u', chr(195).chr(186) => 'u',
1168                 chr(195).chr(187) => 'u', chr(195).chr(188) => 'u',
1169                 chr(195).chr(189) => 'y', chr(195).chr(190) => 'th',
1170                 chr(195).chr(191) => 'y', chr(195).chr(152) => 'O',
1171                 // Decompositions for Latin Extended-A
1172                 chr(196).chr(128) => 'A', chr(196).chr(129) => 'a',
1173                 chr(196).chr(130) => 'A', chr(196).chr(131) => 'a',
1174                 chr(196).chr(132) => 'A', chr(196).chr(133) => 'a',
1175                 chr(196).chr(134) => 'C', chr(196).chr(135) => 'c',
1176                 chr(196).chr(136) => 'C', chr(196).chr(137) => 'c',
1177                 chr(196).chr(138) => 'C', chr(196).chr(139) => 'c',
1178                 chr(196).chr(140) => 'C', chr(196).chr(141) => 'c',
1179                 chr(196).chr(142) => 'D', chr(196).chr(143) => 'd',
1180                 chr(196).chr(144) => 'D', chr(196).chr(145) => 'd',
1181                 chr(196).chr(146) => 'E', chr(196).chr(147) => 'e',
1182                 chr(196).chr(148) => 'E', chr(196).chr(149) => 'e',
1183                 chr(196).chr(150) => 'E', chr(196).chr(151) => 'e',
1184                 chr(196).chr(152) => 'E', chr(196).chr(153) => 'e',
1185                 chr(196).chr(154) => 'E', chr(196).chr(155) => 'e',
1186                 chr(196).chr(156) => 'G', chr(196).chr(157) => 'g',
1187                 chr(196).chr(158) => 'G', chr(196).chr(159) => 'g',
1188                 chr(196).chr(160) => 'G', chr(196).chr(161) => 'g',
1189                 chr(196).chr(162) => 'G', chr(196).chr(163) => 'g',
1190                 chr(196).chr(164) => 'H', chr(196).chr(165) => 'h',
1191                 chr(196).chr(166) => 'H', chr(196).chr(167) => 'h',
1192                 chr(196).chr(168) => 'I', chr(196).chr(169) => 'i',
1193                 chr(196).chr(170) => 'I', chr(196).chr(171) => 'i',
1194                 chr(196).chr(172) => 'I', chr(196).chr(173) => 'i',
1195                 chr(196).chr(174) => 'I', chr(196).chr(175) => 'i',
1196                 chr(196).chr(176) => 'I', chr(196).chr(177) => 'i',
1197                 chr(196).chr(178) => 'IJ',chr(196).chr(179) => 'ij',
1198                 chr(196).chr(180) => 'J', chr(196).chr(181) => 'j',
1199                 chr(196).chr(182) => 'K', chr(196).chr(183) => 'k',
1200                 chr(196).chr(184) => 'k', chr(196).chr(185) => 'L',
1201                 chr(196).chr(186) => 'l', chr(196).chr(187) => 'L',
1202                 chr(196).chr(188) => 'l', chr(196).chr(189) => 'L',
1203                 chr(196).chr(190) => 'l', chr(196).chr(191) => 'L',
1204                 chr(197).chr(128) => 'l', chr(197).chr(129) => 'L',
1205                 chr(197).chr(130) => 'l', chr(197).chr(131) => 'N',
1206                 chr(197).chr(132) => 'n', chr(197).chr(133) => 'N',
1207                 chr(197).chr(134) => 'n', chr(197).chr(135) => 'N',
1208                 chr(197).chr(136) => 'n', chr(197).chr(137) => 'N',
1209                 chr(197).chr(138) => 'n', chr(197).chr(139) => 'N',
1210                 chr(197).chr(140) => 'O', chr(197).chr(141) => 'o',
1211                 chr(197).chr(142) => 'O', chr(197).chr(143) => 'o',
1212                 chr(197).chr(144) => 'O', chr(197).chr(145) => 'o',
1213                 chr(197).chr(146) => 'OE',chr(197).chr(147) => 'oe',
1214                 chr(197).chr(148) => 'R',chr(197).chr(149) => 'r',
1215                 chr(197).chr(150) => 'R',chr(197).chr(151) => 'r',
1216                 chr(197).chr(152) => 'R',chr(197).chr(153) => 'r',
1217                 chr(197).chr(154) => 'S',chr(197).chr(155) => 's',
1218                 chr(197).chr(156) => 'S',chr(197).chr(157) => 's',
1219                 chr(197).chr(158) => 'S',chr(197).chr(159) => 's',
1220                 chr(197).chr(160) => 'S', chr(197).chr(161) => 's',
1221                 chr(197).chr(162) => 'T', chr(197).chr(163) => 't',
1222                 chr(197).chr(164) => 'T', chr(197).chr(165) => 't',
1223                 chr(197).chr(166) => 'T', chr(197).chr(167) => 't',
1224                 chr(197).chr(168) => 'U', chr(197).chr(169) => 'u',
1225                 chr(197).chr(170) => 'U', chr(197).chr(171) => 'u',
1226                 chr(197).chr(172) => 'U', chr(197).chr(173) => 'u',
1227                 chr(197).chr(174) => 'U', chr(197).chr(175) => 'u',
1228                 chr(197).chr(176) => 'U', chr(197).chr(177) => 'u',
1229                 chr(197).chr(178) => 'U', chr(197).chr(179) => 'u',
1230                 chr(197).chr(180) => 'W', chr(197).chr(181) => 'w',
1231                 chr(197).chr(182) => 'Y', chr(197).chr(183) => 'y',
1232                 chr(197).chr(184) => 'Y', chr(197).chr(185) => 'Z',
1233                 chr(197).chr(186) => 'z', chr(197).chr(187) => 'Z',
1234                 chr(197).chr(188) => 'z', chr(197).chr(189) => 'Z',
1235                 chr(197).chr(190) => 'z', chr(197).chr(191) => 's',
1236                 // Decompositions for Latin Extended-B
1237                 chr(200).chr(152) => 'S', chr(200).chr(153) => 's',
1238                 chr(200).chr(154) => 'T', chr(200).chr(155) => 't',
1239                 // Euro Sign
1240                 chr(226).chr(130).chr(172) => 'E',
1241                 // GBP (Pound) Sign
1242                 chr(194).chr(163) => '',
1243                 // Vowels with diacritic (Vietnamese)
1244                 // unmarked
1245                 chr(198).chr(160) => 'O', chr(198).chr(161) => 'o',
1246                 chr(198).chr(175) => 'U', chr(198).chr(176) => 'u',
1247                 // grave accent
1248                 chr(225).chr(186).chr(166) => 'A', chr(225).chr(186).chr(167) => 'a',
1249                 chr(225).chr(186).chr(176) => 'A', chr(225).chr(186).chr(177) => 'a',
1250                 chr(225).chr(187).chr(128) => 'E', chr(225).chr(187).chr(129) => 'e',
1251                 chr(225).chr(187).chr(146) => 'O', chr(225).chr(187).chr(147) => 'o',
1252                 chr(225).chr(187).chr(156) => 'O', chr(225).chr(187).chr(157) => 'o',
1253                 chr(225).chr(187).chr(170) => 'U', chr(225).chr(187).chr(171) => 'u',
1254                 chr(225).chr(187).chr(178) => 'Y', chr(225).chr(187).chr(179) => 'y',
1255                 // hook
1256                 chr(225).chr(186).chr(162) => 'A', chr(225).chr(186).chr(163) => 'a',
1257                 chr(225).chr(186).chr(168) => 'A', chr(225).chr(186).chr(169) => 'a',
1258                 chr(225).chr(186).chr(178) => 'A', chr(225).chr(186).chr(179) => 'a',
1259                 chr(225).chr(186).chr(186) => 'E', chr(225).chr(186).chr(187) => 'e',
1260                 chr(225).chr(187).chr(130) => 'E', chr(225).chr(187).chr(131) => 'e',
1261                 chr(225).chr(187).chr(136) => 'I', chr(225).chr(187).chr(137) => 'i',
1262                 chr(225).chr(187).chr(142) => 'O', chr(225).chr(187).chr(143) => 'o',
1263                 chr(225).chr(187).chr(148) => 'O', chr(225).chr(187).chr(149) => 'o',
1264                 chr(225).chr(187).chr(158) => 'O', chr(225).chr(187).chr(159) => 'o',
1265                 chr(225).chr(187).chr(166) => 'U', chr(225).chr(187).chr(167) => 'u',
1266                 chr(225).chr(187).chr(172) => 'U', chr(225).chr(187).chr(173) => 'u',
1267                 chr(225).chr(187).chr(182) => 'Y', chr(225).chr(187).chr(183) => 'y',
1268                 // tilde
1269                 chr(225).chr(186).chr(170) => 'A', chr(225).chr(186).chr(171) => 'a',
1270                 chr(225).chr(186).chr(180) => 'A', chr(225).chr(186).chr(181) => 'a',
1271                 chr(225).chr(186).chr(188) => 'E', chr(225).chr(186).chr(189) => 'e',
1272                 chr(225).chr(187).chr(132) => 'E', chr(225).chr(187).chr(133) => 'e',
1273                 chr(225).chr(187).chr(150) => 'O', chr(225).chr(187).chr(151) => 'o',
1274                 chr(225).chr(187).chr(160) => 'O', chr(225).chr(187).chr(161) => 'o',
1275                 chr(225).chr(187).chr(174) => 'U', chr(225).chr(187).chr(175) => 'u',
1276                 chr(225).chr(187).chr(184) => 'Y', chr(225).chr(187).chr(185) => 'y',
1277                 // acute accent
1278                 chr(225).chr(186).chr(164) => 'A', chr(225).chr(186).chr(165) => 'a',
1279                 chr(225).chr(186).chr(174) => 'A', chr(225).chr(186).chr(175) => 'a',
1280                 chr(225).chr(186).chr(190) => 'E', chr(225).chr(186).chr(191) => 'e',
1281                 chr(225).chr(187).chr(144) => 'O', chr(225).chr(187).chr(145) => 'o',
1282                 chr(225).chr(187).chr(154) => 'O', chr(225).chr(187).chr(155) => 'o',
1283                 chr(225).chr(187).chr(168) => 'U', chr(225).chr(187).chr(169) => 'u',
1284                 // dot below
1285                 chr(225).chr(186).chr(160) => 'A', chr(225).chr(186).chr(161) => 'a',
1286                 chr(225).chr(186).chr(172) => 'A', chr(225).chr(186).chr(173) => 'a',
1287                 chr(225).chr(186).chr(182) => 'A', chr(225).chr(186).chr(183) => 'a',
1288                 chr(225).chr(186).chr(184) => 'E', chr(225).chr(186).chr(185) => 'e',
1289                 chr(225).chr(187).chr(134) => 'E', chr(225).chr(187).chr(135) => 'e',
1290                 chr(225).chr(187).chr(138) => 'I', chr(225).chr(187).chr(139) => 'i',
1291                 chr(225).chr(187).chr(140) => 'O', chr(225).chr(187).chr(141) => 'o',
1292                 chr(225).chr(187).chr(152) => 'O', chr(225).chr(187).chr(153) => 'o',
1293                 chr(225).chr(187).chr(162) => 'O', chr(225).chr(187).chr(163) => 'o',
1294                 chr(225).chr(187).chr(164) => 'U', chr(225).chr(187).chr(165) => 'u',
1295                 chr(225).chr(187).chr(176) => 'U', chr(225).chr(187).chr(177) => 'u',
1296                 chr(225).chr(187).chr(180) => 'Y', chr(225).chr(187).chr(181) => 'y',
1297                 // Vowels with diacritic (Chinese, Hanyu Pinyin)
1298                 chr(201).chr(145) => 'a',
1299                 // macron
1300                 chr(199).chr(149) => 'U', chr(199).chr(150) => 'u',
1301                 // acute accent
1302                 chr(199).chr(151) => 'U', chr(199).chr(152) => 'u',
1303                 // caron
1304                 chr(199).chr(141) => 'A', chr(199).chr(142) => 'a',
1305                 chr(199).chr(143) => 'I', chr(199).chr(144) => 'i',
1306                 chr(199).chr(145) => 'O', chr(199).chr(146) => 'o',
1307                 chr(199).chr(147) => 'U', chr(199).chr(148) => 'u',
1308                 chr(199).chr(153) => 'U', chr(199).chr(154) => 'u',
1309                 // grave accent
1310                 chr(199).chr(155) => 'U', chr(199).chr(156) => 'u',
1311                 );
1312
1313                 // Used for locale-specific rules
1314                 $locale = get_locale();
1315
1316                 if ( 'de_DE' == $locale || 'de_DE_formal' == $locale ) {
1317                         $chars[ chr(195).chr(132) ] = 'Ae';
1318                         $chars[ chr(195).chr(164) ] = 'ae';
1319                         $chars[ chr(195).chr(150) ] = 'Oe';
1320                         $chars[ chr(195).chr(182) ] = 'oe';
1321                         $chars[ chr(195).chr(156) ] = 'Ue';
1322                         $chars[ chr(195).chr(188) ] = 'ue';
1323                         $chars[ chr(195).chr(159) ] = 'ss';
1324                 } elseif ( 'da_DK' === $locale ) {
1325                         $chars[ chr(195).chr(134) ] = 'Ae';
1326                         $chars[ chr(195).chr(166) ] = 'ae';
1327                         $chars[ chr(195).chr(152) ] = 'Oe';
1328                         $chars[ chr(195).chr(184) ] = 'oe';
1329                         $chars[ chr(195).chr(133) ] = 'Aa';
1330                         $chars[ chr(195).chr(165) ] = 'aa';
1331                 }
1332
1333                 $string = strtr($string, $chars);
1334         } else {
1335                 $chars = array();
1336                 // Assume ISO-8859-1 if not UTF-8
1337                 $chars['in'] = chr(128).chr(131).chr(138).chr(142).chr(154).chr(158)
1338                         .chr(159).chr(162).chr(165).chr(181).chr(192).chr(193).chr(194)
1339                         .chr(195).chr(196).chr(197).chr(199).chr(200).chr(201).chr(202)
1340                         .chr(203).chr(204).chr(205).chr(206).chr(207).chr(209).chr(210)
1341                         .chr(211).chr(212).chr(213).chr(214).chr(216).chr(217).chr(218)
1342                         .chr(219).chr(220).chr(221).chr(224).chr(225).chr(226).chr(227)
1343                         .chr(228).chr(229).chr(231).chr(232).chr(233).chr(234).chr(235)
1344                         .chr(236).chr(237).chr(238).chr(239).chr(241).chr(242).chr(243)
1345                         .chr(244).chr(245).chr(246).chr(248).chr(249).chr(250).chr(251)
1346                         .chr(252).chr(253).chr(255);
1347
1348                 $chars['out'] = "EfSZszYcYuAAAAAACEEEEIIIINOOOOOOUUUUYaaaaaaceeeeiiiinoooooouuuuyy";
1349
1350                 $string = strtr($string, $chars['in'], $chars['out']);
1351                 $double_chars = array();
1352                 $double_chars['in'] = array(chr(140), chr(156), chr(198), chr(208), chr(222), chr(223), chr(230), chr(240), chr(254));
1353                 $double_chars['out'] = array('OE', 'oe', 'AE', 'DH', 'TH', 'ss', 'ae', 'dh', 'th');
1354                 $string = str_replace($double_chars['in'], $double_chars['out'], $string);
1355         }
1356
1357         return $string;
1358 }
1359
1360 /**
1361  * Sanitizes a filename, replacing whitespace with dashes.
1362  *
1363  * Removes special characters that are illegal in filenames on certain
1364  * operating systems and special characters requiring special escaping
1365  * to manipulate at the command line. Replaces spaces and consecutive
1366  * dashes with a single dash. Trims period, dash and underscore from beginning
1367  * and end of filename.
1368  *
1369  * @since 2.1.0
1370  *
1371  * @param string $filename The filename to be sanitized
1372  * @return string The sanitized filename
1373  */
1374 function sanitize_file_name( $filename ) {
1375         $filename_raw = $filename;
1376         $special_chars = array("?", "[", "]", "/", "\\", "=", "<", ">", ":", ";", ",", "'", "\"", "&", "$", "#", "*", "(", ")", "|", "~", "`", "!", "{", "}", "%", "+", chr(0));
1377         /**
1378          * Filter the list of characters to remove from a filename.
1379          *
1380          * @since 2.8.0
1381          *
1382          * @param array  $special_chars Characters to remove.
1383          * @param string $filename_raw  Filename as it was passed into sanitize_file_name().
1384          */
1385         $special_chars = apply_filters( 'sanitize_file_name_chars', $special_chars, $filename_raw );
1386         $filename = preg_replace( "#\x{00a0}#siu", ' ', $filename );
1387         $filename = str_replace( $special_chars, '', $filename );
1388         $filename = str_replace( array( '%20', '+' ), '-', $filename );
1389         $filename = preg_replace( '/[\r\n\t -]+/', '-', $filename );
1390         $filename = trim( $filename, '.-_' );
1391
1392         // Split the filename into a base and extension[s]
1393         $parts = explode('.', $filename);
1394
1395         // Return if only one extension
1396         if ( count( $parts ) <= 2 ) {
1397                 /**
1398                  * Filter a sanitized filename string.
1399                  *
1400                  * @since 2.8.0
1401                  *
1402                  * @param string $filename     Sanitized filename.
1403                  * @param string $filename_raw The filename prior to sanitization.
1404                  */
1405                 return apply_filters( 'sanitize_file_name', $filename, $filename_raw );
1406         }
1407
1408         // Process multiple extensions
1409         $filename = array_shift($parts);
1410         $extension = array_pop($parts);
1411         $mimes = get_allowed_mime_types();
1412
1413         /*
1414          * Loop over any intermediate extensions. Postfix them with a trailing underscore
1415          * if they are a 2 - 5 character long alpha string not in the extension whitelist.
1416          */
1417         foreach ( (array) $parts as $part) {
1418                 $filename .= '.' . $part;
1419
1420                 if ( preg_match("/^[a-zA-Z]{2,5}\d?$/", $part) ) {
1421                         $allowed = false;
1422                         foreach ( $mimes as $ext_preg => $mime_match ) {
1423                                 $ext_preg = '!^(' . $ext_preg . ')$!i';
1424                                 if ( preg_match( $ext_preg, $part ) ) {
1425                                         $allowed = true;
1426                                         break;
1427                                 }
1428                         }
1429                         if ( !$allowed )
1430                                 $filename .= '_';
1431                 }
1432         }
1433         $filename .= '.' . $extension;
1434         /** This filter is documented in wp-includes/formatting.php */
1435         return apply_filters('sanitize_file_name', $filename, $filename_raw);
1436 }
1437
1438 /**
1439  * Sanitizes a username, stripping out unsafe characters.
1440  *
1441  * Removes tags, octets, entities, and if strict is enabled, will only keep
1442  * alphanumeric, _, space, ., -, @. After sanitizing, it passes the username,
1443  * raw username (the username in the parameter), and the value of $strict as
1444  * parameters for the 'sanitize_user' filter.
1445  *
1446  * @since 2.0.0
1447  *
1448  * @param string $username The username to be sanitized.
1449  * @param bool   $strict   If set limits $username to specific characters. Default false.
1450  * @return string The sanitized username, after passing through filters.
1451  */
1452 function sanitize_user( $username, $strict = false ) {
1453         $raw_username = $username;
1454         $username = wp_strip_all_tags( $username );
1455         $username = remove_accents( $username );
1456         // Kill octets
1457         $username = preg_replace( '|%([a-fA-F0-9][a-fA-F0-9])|', '', $username );
1458         $username = preg_replace( '/&.+?;/', '', $username ); // Kill entities
1459
1460         // If strict, reduce to ASCII for max portability.
1461         if ( $strict )
1462                 $username = preg_replace( '|[^a-z0-9 _.\-@]|i', '', $username );
1463
1464         $username = trim( $username );
1465         // Consolidate contiguous whitespace
1466         $username = preg_replace( '|\s+|', ' ', $username );
1467
1468         /**
1469          * Filter a sanitized username string.
1470          *
1471          * @since 2.0.1
1472          *
1473          * @param string $username     Sanitized username.
1474          * @param string $raw_username The username prior to sanitization.
1475          * @param bool   $strict       Whether to limit the sanitization to specific characters. Default false.
1476          */
1477         return apply_filters( 'sanitize_user', $username, $raw_username, $strict );
1478 }
1479
1480 /**
1481  * Sanitizes a string key.
1482  *
1483  * Keys are used as internal identifiers. Lowercase alphanumeric characters, dashes and underscores are allowed.
1484  *
1485  * @since 3.0.0
1486  *
1487  * @param string $key String key
1488  * @return string Sanitized key
1489  */
1490 function sanitize_key( $key ) {
1491         $raw_key = $key;
1492         $key = strtolower( $key );
1493         $key = preg_replace( '/[^a-z0-9_\-]/', '', $key );
1494
1495         /**
1496          * Filter a sanitized key string.
1497          *
1498          * @since 3.0.0
1499          *
1500          * @param string $key     Sanitized key.
1501          * @param string $raw_key The key prior to sanitization.
1502          */
1503         return apply_filters( 'sanitize_key', $key, $raw_key );
1504 }
1505
1506 /**
1507  * Sanitizes a title, or returns a fallback title.
1508  *
1509  * Specifically, HTML and PHP tags are stripped. Further actions can be added
1510  * via the plugin API. If $title is empty and $fallback_title is set, the latter
1511  * will be used.
1512  *
1513  * @since 1.0.0
1514  *
1515  * @param string $title          The string to be sanitized.
1516  * @param string $fallback_title Optional. A title to use if $title is empty.
1517  * @param string $context        Optional. The operation for which the string is sanitized
1518  * @return string The sanitized string.
1519  */
1520 function sanitize_title( $title, $fallback_title = '', $context = 'save' ) {
1521         $raw_title = $title;
1522
1523         if ( 'save' == $context )
1524                 $title = remove_accents($title);
1525
1526         /**
1527          * Filter a sanitized title string.
1528          *
1529          * @since 1.2.0
1530          *
1531          * @param string $title     Sanitized title.
1532          * @param string $raw_title The title prior to sanitization.
1533          * @param string $context   The context for which the title is being sanitized.
1534          */
1535         $title = apply_filters( 'sanitize_title', $title, $raw_title, $context );
1536
1537         if ( '' === $title || false === $title )
1538                 $title = $fallback_title;
1539
1540         return $title;
1541 }
1542
1543 /**
1544  * Sanitizes a title with the 'query' context.
1545  *
1546  * Used for querying the database for a value from URL.
1547  *
1548  * @since 3.1.0
1549  *
1550  * @param string $title The string to be sanitized.
1551  * @return string The sanitized string.
1552  */
1553 function sanitize_title_for_query( $title ) {
1554         return sanitize_title( $title, '', 'query' );
1555 }
1556
1557 /**
1558  * Sanitizes a title, replacing whitespace and a few other characters with dashes.
1559  *
1560  * Limits the output to alphanumeric characters, underscore (_) and dash (-).
1561  * Whitespace becomes a dash.
1562  *
1563  * @since 1.2.0
1564  *
1565  * @param string $title     The title to be sanitized.
1566  * @param string $raw_title Optional. Not used.
1567  * @param string $context   Optional. The operation for which the string is sanitized.
1568  * @return string The sanitized title.
1569  */
1570 function sanitize_title_with_dashes( $title, $raw_title = '', $context = 'display' ) {
1571         $title = strip_tags($title);
1572         // Preserve escaped octets.
1573         $title = preg_replace('|%([a-fA-F0-9][a-fA-F0-9])|', '---$1---', $title);
1574         // Remove percent signs that are not part of an octet.
1575         $title = str_replace('%', '', $title);
1576         // Restore octets.
1577         $title = preg_replace('|---([a-fA-F0-9][a-fA-F0-9])---|', '%$1', $title);
1578
1579         if (seems_utf8($title)) {
1580                 if (function_exists('mb_strtolower')) {
1581                         $title = mb_strtolower($title, 'UTF-8');
1582                 }
1583                 $title = utf8_uri_encode($title, 200);
1584         }
1585
1586         $title = strtolower($title);
1587
1588         if ( 'save' == $context ) {
1589                 // Convert nbsp, ndash and mdash to hyphens
1590                 $title = str_replace( array( '%c2%a0', '%e2%80%93', '%e2%80%94' ), '-', $title );
1591                 // Convert nbsp, ndash and mdash HTML entities to hyphens
1592                 $title = str_replace( array( '&nbsp;', '&#160;', '&ndash;', '&#8211;', '&mdash;', '&#8212;' ), '-', $title );
1593
1594                 // Strip these characters entirely
1595                 $title = str_replace( array(
1596                         // iexcl and iquest
1597                         '%c2%a1', '%c2%bf',
1598                         // angle quotes
1599                         '%c2%ab', '%c2%bb', '%e2%80%b9', '%e2%80%ba',
1600                         // curly quotes
1601                         '%e2%80%98', '%e2%80%99', '%e2%80%9c', '%e2%80%9d',
1602                         '%e2%80%9a', '%e2%80%9b', '%e2%80%9e', '%e2%80%9f',
1603                         // copy, reg, deg, hellip and trade
1604                         '%c2%a9', '%c2%ae', '%c2%b0', '%e2%80%a6', '%e2%84%a2',
1605                         // acute accents
1606                         '%c2%b4', '%cb%8a', '%cc%81', '%cd%81',
1607                         // grave accent, macron, caron
1608                         '%cc%80', '%cc%84', '%cc%8c',
1609                 ), '', $title );
1610
1611                 // Convert times to x
1612                 $title = str_replace( '%c3%97', 'x', $title );
1613         }
1614
1615         $title = preg_replace('/&.+?;/', '', $title); // kill entities
1616         $title = str_replace('.', '-', $title);
1617
1618         $title = preg_replace('/[^%a-z0-9 _-]/', '', $title);
1619         $title = preg_replace('/\s+/', '-', $title);
1620         $title = preg_replace('|-+|', '-', $title);
1621         $title = trim($title, '-');
1622
1623         return $title;
1624 }
1625
1626 /**
1627  * Ensures a string is a valid SQL 'order by' clause.
1628  *
1629  * Accepts one or more columns, with or without a sort order (ASC / DESC).
1630  * e.g. 'column_1', 'column_1, column_2', 'column_1 ASC, column_2 DESC' etc.
1631  *
1632  * Also accepts 'RAND()'.
1633  *
1634  * @since 2.5.1
1635  *
1636  * @param string $orderby Order by clause to be validated.
1637  * @return string|false Returns $orderby if valid, false otherwise.
1638  */
1639 function sanitize_sql_orderby( $orderby ) {
1640         if ( preg_match( '/^\s*(([a-z0-9_]+|`[a-z0-9_]+`)(\s+(ASC|DESC))?\s*(,\s*(?=[a-z0-9_`])|$))+$/i', $orderby ) || preg_match( '/^\s*RAND\(\s*\)\s*$/i', $orderby ) ) {
1641                 return $orderby;
1642         }
1643         return false;
1644 }
1645
1646 /**
1647  * Sanitizes an HTML classname to ensure it only contains valid characters.
1648  *
1649  * Strips the string down to A-Z,a-z,0-9,_,-. If this results in an empty
1650  * string then it will return the alternative value supplied.
1651  *
1652  * @todo Expand to support the full range of CDATA that a class attribute can contain.
1653  *
1654  * @since 2.8.0
1655  *
1656  * @param string $class    The classname to be sanitized
1657  * @param string $fallback Optional. The value to return if the sanitization ends up as an empty string.
1658  *      Defaults to an empty string.
1659  * @return string The sanitized value
1660  */
1661 function sanitize_html_class( $class, $fallback = '' ) {
1662         //Strip out any % encoded octets
1663         $sanitized = preg_replace( '|%[a-fA-F0-9][a-fA-F0-9]|', '', $class );
1664
1665         //Limit to A-Z,a-z,0-9,_,-
1666         $sanitized = preg_replace( '/[^A-Za-z0-9_-]/', '', $sanitized );
1667
1668         if ( '' == $sanitized && $fallback ) {
1669                 return sanitize_html_class( $fallback );
1670         }
1671         /**
1672          * Filter a sanitized HTML class string.
1673          *
1674          * @since 2.8.0
1675          *
1676          * @param string $sanitized The sanitized HTML class.
1677          * @param string $class     HTML class before sanitization.
1678          * @param string $fallback  The fallback string.
1679          */
1680         return apply_filters( 'sanitize_html_class', $sanitized, $class, $fallback );
1681 }
1682
1683 /**
1684  * Converts lone & characters into `&#038;` (a.k.a. `&amp;`)
1685  *
1686  * @since 0.71
1687  *
1688  * @param string $content    String of characters to be converted.
1689  * @param string $deprecated Not used.
1690  * @return string Converted string.
1691  */
1692 function convert_chars( $content, $deprecated = '' ) {
1693         if ( ! empty( $deprecated ) ) {
1694                 _deprecated_argument( __FUNCTION__, '0.71' );
1695         }
1696
1697         if ( strpos( $content, '&' ) !== false ) {
1698                 $content = preg_replace( '/&([^#])(?![a-z1-4]{1,8};)/i', '&#038;$1', $content );
1699         }
1700
1701         return $content;
1702 }
1703
1704 /**
1705  * Converts invalid Unicode references range to valid range.
1706  *
1707  * @since 4.3.0
1708  *
1709  * @param string $content String with entities that need converting.
1710  * @return string Converted string.
1711  */
1712 function convert_invalid_entities( $content ) {
1713         $wp_htmltranswinuni = array(
1714                 '&#128;' => '&#8364;', // the Euro sign
1715                 '&#129;' => '',
1716                 '&#130;' => '&#8218;', // these are Windows CP1252 specific characters
1717                 '&#131;' => '&#402;',  // they would look weird on non-Windows browsers
1718                 '&#132;' => '&#8222;',
1719                 '&#133;' => '&#8230;',
1720                 '&#134;' => '&#8224;',
1721                 '&#135;' => '&#8225;',
1722                 '&#136;' => '&#710;',
1723                 '&#137;' => '&#8240;',
1724                 '&#138;' => '&#352;',
1725                 '&#139;' => '&#8249;',
1726                 '&#140;' => '&#338;',
1727                 '&#141;' => '',
1728                 '&#142;' => '&#381;',
1729                 '&#143;' => '',
1730                 '&#144;' => '',
1731                 '&#145;' => '&#8216;',
1732                 '&#146;' => '&#8217;',
1733                 '&#147;' => '&#8220;',
1734                 '&#148;' => '&#8221;',
1735                 '&#149;' => '&#8226;',
1736                 '&#150;' => '&#8211;',
1737                 '&#151;' => '&#8212;',
1738                 '&#152;' => '&#732;',
1739                 '&#153;' => '&#8482;',
1740                 '&#154;' => '&#353;',
1741                 '&#155;' => '&#8250;',
1742                 '&#156;' => '&#339;',
1743                 '&#157;' => '',
1744                 '&#158;' => '&#382;',
1745                 '&#159;' => '&#376;'
1746         );
1747
1748         if ( strpos( $content, '&#1' ) !== false ) {
1749                 $content = strtr( $content, $wp_htmltranswinuni );
1750         }
1751
1752         return $content;
1753 }
1754
1755 /**
1756  * Balances tags if forced to, or if the 'use_balanceTags' option is set to true.
1757  *
1758  * @since 0.71
1759  *
1760  * @param string $text  Text to be balanced
1761  * @param bool   $force If true, forces balancing, ignoring the value of the option. Default false.
1762  * @return string Balanced text
1763  */
1764 function balanceTags( $text, $force = false ) {
1765         if ( $force || get_option('use_balanceTags') == 1 ) {
1766                 return force_balance_tags( $text );
1767         } else {
1768                 return $text;
1769         }
1770 }
1771
1772 /**
1773  * Balances tags of string using a modified stack.
1774  *
1775  * @since 2.0.4
1776  *
1777  * @author Leonard Lin <leonard@acm.org>
1778  * @license GPL
1779  * @copyright November 4, 2001
1780  * @version 1.1
1781  * @todo Make better - change loop condition to $text in 1.2
1782  * @internal Modified by Scott Reilly (coffee2code) 02 Aug 2004
1783  *              1.1  Fixed handling of append/stack pop order of end text
1784  *                       Added Cleaning Hooks
1785  *              1.0  First Version
1786  *
1787  * @param string $text Text to be balanced.
1788  * @return string Balanced text.
1789  */
1790 function force_balance_tags( $text ) {
1791         $tagstack = array();
1792         $stacksize = 0;
1793         $tagqueue = '';
1794         $newtext = '';
1795         // Known single-entity/self-closing tags
1796         $single_tags = array( 'area', 'base', 'basefont', 'br', 'col', 'command', 'embed', 'frame', 'hr', 'img', 'input', 'isindex', 'link', 'meta', 'param', 'source' );
1797         // Tags that can be immediately nested within themselves
1798         $nestable_tags = array( 'blockquote', 'div', 'object', 'q', 'span' );
1799
1800         // WP bug fix for comments - in case you REALLY meant to type '< !--'
1801         $text = str_replace('< !--', '<    !--', $text);
1802         // WP bug fix for LOVE <3 (and other situations with '<' before a number)
1803         $text = preg_replace('#<([0-9]{1})#', '&lt;$1', $text);
1804
1805         while ( preg_match("/<(\/?[\w:]*)\s*([^>]*)>/", $text, $regex) ) {
1806                 $newtext .= $tagqueue;
1807
1808                 $i = strpos($text, $regex[0]);
1809                 $l = strlen($regex[0]);
1810
1811                 // clear the shifter
1812                 $tagqueue = '';
1813                 // Pop or Push
1814                 if ( isset($regex[1][0]) && '/' == $regex[1][0] ) { // End Tag
1815                         $tag = strtolower(substr($regex[1],1));
1816                         // if too many closing tags
1817                         if ( $stacksize <= 0 ) {
1818                                 $tag = '';
1819                                 // or close to be safe $tag = '/' . $tag;
1820                         }
1821                         // if stacktop value = tag close value then pop
1822                         elseif ( $tagstack[$stacksize - 1] == $tag ) { // found closing tag
1823                                 $tag = '</' . $tag . '>'; // Close Tag
1824                                 // Pop
1825                                 array_pop( $tagstack );
1826                                 $stacksize--;
1827                         } else { // closing tag not at top, search for it
1828                                 for ( $j = $stacksize-1; $j >= 0; $j-- ) {
1829                                         if ( $tagstack[$j] == $tag ) {
1830                                         // add tag to tagqueue
1831                                                 for ( $k = $stacksize-1; $k >= $j; $k--) {
1832                                                         $tagqueue .= '</' . array_pop( $tagstack ) . '>';
1833                                                         $stacksize--;
1834                                                 }
1835                                                 break;
1836                                         }
1837                                 }
1838                                 $tag = '';
1839                         }
1840                 } else { // Begin Tag
1841                         $tag = strtolower($regex[1]);
1842
1843                         // Tag Cleaning
1844
1845                         // If it's an empty tag "< >", do nothing
1846                         if ( '' == $tag ) {
1847                                 // do nothing
1848                         }
1849                         // ElseIf it presents itself as a self-closing tag...
1850                         elseif ( substr( $regex[2], -1 ) == '/' ) {
1851                                 // ...but it isn't a known single-entity self-closing tag, then don't let it be treated as such and
1852                                 // immediately close it with a closing tag (the tag will encapsulate no text as a result)
1853                                 if ( ! in_array( $tag, $single_tags ) )
1854                                         $regex[2] = trim( substr( $regex[2], 0, -1 ) ) . "></$tag";
1855                         }
1856                         // ElseIf it's a known single-entity tag but it doesn't close itself, do so
1857                         elseif ( in_array($tag, $single_tags) ) {
1858                                 $regex[2] .= '/';
1859                         }
1860                         // Else it's not a single-entity tag
1861                         else {
1862                                 // If the top of the stack is the same as the tag we want to push, close previous tag
1863                                 if ( $stacksize > 0 && !in_array($tag, $nestable_tags) && $tagstack[$stacksize - 1] == $tag ) {
1864                                         $tagqueue = '</' . array_pop( $tagstack ) . '>';
1865                                         $stacksize--;
1866                                 }
1867                                 $stacksize = array_push( $tagstack, $tag );
1868                         }
1869
1870                         // Attributes
1871                         $attributes = $regex[2];
1872                         if ( ! empty( $attributes ) && $attributes[0] != '>' )
1873                                 $attributes = ' ' . $attributes;
1874
1875                         $tag = '<' . $tag . $attributes . '>';
1876                         //If already queuing a close tag, then put this tag on, too
1877                         if ( !empty($tagqueue) ) {
1878                                 $tagqueue .= $tag;
1879                                 $tag = '';
1880                         }
1881                 }
1882                 $newtext .= substr($text, 0, $i) . $tag;
1883                 $text = substr($text, $i + $l);
1884         }
1885
1886         // Clear Tag Queue
1887         $newtext .= $tagqueue;
1888
1889         // Add Remaining text
1890         $newtext .= $text;
1891
1892         // Empty Stack
1893         while( $x = array_pop($tagstack) )
1894                 $newtext .= '</' . $x . '>'; // Add remaining tags to close
1895
1896         // WP fix for the bug with HTML comments
1897         $newtext = str_replace("< !--","<!--",$newtext);
1898         $newtext = str_replace("<    !--","< !--",$newtext);
1899
1900         return $newtext;
1901 }
1902
1903 /**
1904  * Acts on text which is about to be edited.
1905  *
1906  * The $content is run through esc_textarea(), which uses htmlspecialchars()
1907  * to convert special characters to HTML entities. If $richedit is set to true,
1908  * it is simply a holder for the 'format_to_edit' filter.
1909  *
1910  * @since 0.71
1911  * @since 4.4.0 The `$richedit` parameter was renamed to `$rich_text` for clarity.
1912  *
1913  * @param string $content   The text about to be edited.
1914  * @param bool   $rich_text Optional. Whether `$content` should be considered rich text,
1915  *                          in which case it would not be passed through esc_textarea().
1916  *                          Default false.
1917  * @return string The text after the filter (and possibly htmlspecialchars()) has been run.
1918  */
1919 function format_to_edit( $content, $rich_text = false ) {
1920         /**
1921          * Filter the text to be formatted for editing.
1922          *
1923          * @since 1.2.0
1924          *
1925          * @param string $content The text, prior to formatting for editing.
1926          */
1927         $content = apply_filters( 'format_to_edit', $content );
1928         if ( ! $rich_text )
1929                 $content = esc_textarea( $content );
1930         return $content;
1931 }
1932
1933 /**
1934  * Add leading zeros when necessary.
1935  *
1936  * If you set the threshold to '4' and the number is '10', then you will get
1937  * back '0010'. If you set the threshold to '4' and the number is '5000', then you
1938  * will get back '5000'.
1939  *
1940  * Uses sprintf to append the amount of zeros based on the $threshold parameter
1941  * and the size of the number. If the number is large enough, then no zeros will
1942  * be appended.
1943  *
1944  * @since 0.71
1945  *
1946  * @param int $number     Number to append zeros to if not greater than threshold.
1947  * @param int $threshold  Digit places number needs to be to not have zeros added.
1948  * @return string Adds leading zeros to number if needed.
1949  */
1950 function zeroise( $number, $threshold ) {
1951         return sprintf( '%0' . $threshold . 's', $number );
1952 }
1953
1954 /**
1955  * Adds backslashes before letters and before a number at the start of a string.
1956  *
1957  * @since 0.71
1958  *
1959  * @param string $string Value to which backslashes will be added.
1960  * @return string String with backslashes inserted.
1961  */
1962 function backslashit( $string ) {
1963         if ( isset( $string[0] ) && $string[0] >= '0' && $string[0] <= '9' )
1964                 $string = '\\\\' . $string;
1965         return addcslashes( $string, 'A..Za..z' );
1966 }
1967
1968 /**
1969  * Appends a trailing slash.
1970  *
1971  * Will remove trailing forward and backslashes if it exists already before adding
1972  * a trailing forward slash. This prevents double slashing a string or path.
1973  *
1974  * The primary use of this is for paths and thus should be used for paths. It is
1975  * not restricted to paths and offers no specific path support.
1976  *
1977  * @since 1.2.0
1978  *
1979  * @param string $string What to add the trailing slash to.
1980  * @return string String with trailing slash added.
1981  */
1982 function trailingslashit( $string ) {
1983         return untrailingslashit( $string ) . '/';
1984 }
1985
1986 /**
1987  * Removes trailing forward slashes and backslashes if they exist.
1988  *
1989  * The primary use of this is for paths and thus should be used for paths. It is
1990  * not restricted to paths and offers no specific path support.
1991  *
1992  * @since 2.2.0
1993  *
1994  * @param string $string What to remove the trailing slashes from.
1995  * @return string String without the trailing slashes.
1996  */
1997 function untrailingslashit( $string ) {
1998         return rtrim( $string, '/\\' );
1999 }
2000
2001 /**
2002  * Adds slashes to escape strings.
2003  *
2004  * Slashes will first be removed if magic_quotes_gpc is set, see {@link
2005  * http://www.php.net/magic_quotes} for more details.
2006  *
2007  * @since 0.71
2008  *
2009  * @param string $gpc The string returned from HTTP request data.
2010  * @return string Returns a string escaped with slashes.
2011  */
2012 function addslashes_gpc($gpc) {
2013         if ( get_magic_quotes_gpc() )
2014                 $gpc = stripslashes($gpc);
2015
2016         return wp_slash($gpc);
2017 }
2018
2019 /**
2020  * Navigates through an array, object, or scalar, and removes slashes from the values.
2021  *
2022  * @since 2.0.0
2023  *
2024  * @param mixed $value The value to be stripped.
2025  * @return mixed Stripped value.
2026  */
2027 function stripslashes_deep( $value ) {
2028         return map_deep( $value, 'stripslashes_from_strings_only' );
2029 }
2030
2031 /**
2032  * Callback function for `stripslashes_deep()` which strips slashes from strings.
2033  *
2034  * @since 4.4.0
2035  *
2036  * @param mixed $value The array or string to be stripped.
2037  * @return mixed $value The stripped value.
2038  */
2039 function stripslashes_from_strings_only( $value ) {
2040         return is_string( $value ) ? stripslashes( $value ) : $value;
2041 }
2042
2043 /**
2044  * Navigates through an array, object, or scalar, and encodes the values to be used in a URL.
2045  *
2046  * @since 2.2.0
2047  *
2048  * @param mixed $value The array or string to be encoded.
2049  * @return mixed $value The encoded value.
2050  */
2051 function urlencode_deep( $value ) {
2052         return map_deep( $value, 'urlencode' );
2053 }
2054
2055 /**
2056  * Navigates through an array, object, or scalar, and raw-encodes the values to be used in a URL.
2057  *
2058  * @since 3.4.0
2059  *
2060  * @param mixed $value The array or string to be encoded.
2061  * @return mixed $value The encoded value.
2062  */
2063 function rawurlencode_deep( $value ) {
2064         return map_deep( $value, 'rawurlencode' );
2065 }
2066
2067 /**
2068  * Navigates through an array, object, or scalar, and decodes URL-encoded values
2069  *
2070  * @since 4.4.0
2071  *
2072  * @param mixed $value The array or string to be decoded.
2073  * @return mixed $value The decoded value.
2074  */
2075 function urldecode_deep( $value ) {
2076         return map_deep( $value, 'urldecode' );
2077 }
2078
2079 /**
2080  * Converts email addresses characters to HTML entities to block spam bots.
2081  *
2082  * @since 0.71
2083  *
2084  * @param string $email_address Email address.
2085  * @param int    $hex_encoding  Optional. Set to 1 to enable hex encoding.
2086  * @return string Converted email address.
2087  */
2088 function antispambot( $email_address, $hex_encoding = 0 ) {
2089         $email_no_spam_address = '';
2090         for ( $i = 0, $len = strlen( $email_address ); $i < $len; $i++ ) {
2091                 $j = rand( 0, 1 + $hex_encoding );
2092                 if ( $j == 0 ) {
2093                         $email_no_spam_address .= '&#' . ord( $email_address[$i] ) . ';';
2094                 } elseif ( $j == 1 ) {
2095                         $email_no_spam_address .= $email_address[$i];
2096                 } elseif ( $j == 2 ) {
2097                         $email_no_spam_address .= '%' . zeroise( dechex( ord( $email_address[$i] ) ), 2 );
2098                 }
2099         }
2100
2101         return str_replace( '@', '&#64;', $email_no_spam_address );
2102 }
2103
2104 /**
2105  * Callback to convert URI match to HTML A element.
2106  *
2107  * This function was backported from 2.5.0 to 2.3.2. Regex callback for {@link
2108  * make_clickable()}.
2109  *
2110  * @since 2.3.2
2111  * @access private
2112  *
2113  * @param array $matches Single Regex Match.
2114  * @return string HTML A element with URI address.
2115  */
2116 function _make_url_clickable_cb( $matches ) {
2117         $url = $matches[2];
2118
2119         if ( ')' == $matches[3] && strpos( $url, '(' ) ) {
2120                 // If the trailing character is a closing parethesis, and the URL has an opening parenthesis in it, add the closing parenthesis to the URL.
2121                 // Then we can let the parenthesis balancer do its thing below.
2122                 $url .= $matches[3];
2123                 $suffix = '';
2124         } else {
2125                 $suffix = $matches[3];
2126         }
2127
2128         // Include parentheses in the URL only if paired
2129         while ( substr_count( $url, '(' ) < substr_count( $url, ')' ) ) {
2130                 $suffix = strrchr( $url, ')' ) . $suffix;
2131                 $url = substr( $url, 0, strrpos( $url, ')' ) );
2132         }
2133
2134         $url = esc_url($url);
2135         if ( empty($url) )
2136                 return $matches[0];
2137
2138         return $matches[1] . "<a href=\"$url\" rel=\"nofollow\">$url</a>" . $suffix;
2139 }
2140
2141 /**
2142  * Callback to convert URL match to HTML A element.
2143  *
2144  * This function was backported from 2.5.0 to 2.3.2. Regex callback for {@link
2145  * make_clickable()}.
2146  *
2147  * @since 2.3.2
2148  * @access private
2149  *
2150  * @param array $matches Single Regex Match.
2151  * @return string HTML A element with URL address.
2152  */
2153 function _make_web_ftp_clickable_cb( $matches ) {
2154         $ret = '';
2155         $dest = $matches[2];
2156         $dest = 'http://' . $dest;
2157
2158         // removed trailing [.,;:)] from URL
2159         if ( in_array( substr($dest, -1), array('.', ',', ';', ':', ')') ) === true ) {
2160                 $ret = substr($dest, -1);
2161                 $dest = substr($dest, 0, strlen($dest)-1);
2162         }
2163
2164         $dest = esc_url($dest);
2165         if ( empty($dest) )
2166                 return $matches[0];
2167
2168         return $matches[1] . "<a href=\"$dest\" rel=\"nofollow\">$dest</a>$ret";
2169 }
2170
2171 /**
2172  * Callback to convert email address match to HTML A element.
2173  *
2174  * This function was backported from 2.5.0 to 2.3.2. Regex callback for {@link
2175  * make_clickable()}.
2176  *
2177  * @since 2.3.2
2178  * @access private
2179  *
2180  * @param array $matches Single Regex Match.
2181  * @return string HTML A element with email address.
2182  */
2183 function _make_email_clickable_cb( $matches ) {
2184         $email = $matches[2] . '@' . $matches[3];
2185         return $matches[1] . "<a href=\"mailto:$email\">$email</a>";
2186 }
2187
2188 /**
2189  * Convert plaintext URI to HTML links.
2190  *
2191  * Converts URI, www and ftp, and email addresses. Finishes by fixing links
2192  * within links.
2193  *
2194  * @since 0.71
2195  *
2196  * @param string $text Content to convert URIs.
2197  * @return string Content with converted URIs.
2198  */
2199 function make_clickable( $text ) {
2200         $r = '';
2201         $textarr = preg_split( '/(<[^<>]+>)/', $text, -1, PREG_SPLIT_DELIM_CAPTURE ); // split out HTML tags
2202         $nested_code_pre = 0; // Keep track of how many levels link is nested inside <pre> or <code>
2203         foreach ( $textarr as $piece ) {
2204
2205                 if ( preg_match( '|^<code[\s>]|i', $piece ) || preg_match( '|^<pre[\s>]|i', $piece ) || preg_match( '|^<script[\s>]|i', $piece ) || preg_match( '|^<style[\s>]|i', $piece ) )
2206                         $nested_code_pre++;
2207                 elseif ( $nested_code_pre && ( '</code>' === strtolower( $piece ) || '</pre>' === strtolower( $piece ) || '</script>' === strtolower( $piece ) || '</style>' === strtolower( $piece ) ) )
2208                         $nested_code_pre--;
2209
2210                 if ( $nested_code_pre || empty( $piece ) || ( $piece[0] === '<' && ! preg_match( '|^<\s*[\w]{1,20}+://|', $piece ) ) ) {
2211                         $r .= $piece;
2212                         continue;
2213                 }
2214
2215                 // Long strings might contain expensive edge cases ...
2216                 if ( 10000 < strlen( $piece ) ) {
2217                         // ... break it up
2218                         foreach ( _split_str_by_whitespace( $piece, 2100 ) as $chunk ) { // 2100: Extra room for scheme and leading and trailing paretheses
2219                                 if ( 2101 < strlen( $chunk ) ) {
2220                                         $r .= $chunk; // Too big, no whitespace: bail.
2221                                 } else {
2222                                         $r .= make_clickable( $chunk );
2223                                 }
2224                         }
2225                 } else {
2226                         $ret = " $piece "; // Pad with whitespace to simplify the regexes
2227
2228                         $url_clickable = '~
2229                                 ([\\s(<.,;:!?])                                        # 1: Leading whitespace, or punctuation
2230                                 (                                                      # 2: URL
2231                                         [\\w]{1,20}+://                                # Scheme and hier-part prefix
2232                                         (?=\S{1,2000}\s)                               # Limit to URLs less than about 2000 characters long
2233                                         [\\w\\x80-\\xff#%\\~/@\\[\\]*(+=&$-]*+         # Non-punctuation URL character
2234                                         (?:                                            # Unroll the Loop: Only allow puctuation URL character if followed by a non-punctuation URL character
2235                                                 [\'.,;:!?)]                            # Punctuation URL character
2236                                                 [\\w\\x80-\\xff#%\\~/@\\[\\]*(+=&$-]++ # Non-punctuation URL character
2237                                         )*
2238                                 )
2239                                 (\)?)                                                  # 3: Trailing closing parenthesis (for parethesis balancing post processing)
2240                         ~xS'; // The regex is a non-anchored pattern and does not have a single fixed starting character.
2241                               // Tell PCRE to spend more time optimizing since, when used on a page load, it will probably be used several times.
2242
2243                         $ret = preg_replace_callback( $url_clickable, '_make_url_clickable_cb', $ret );
2244
2245                         $ret = preg_replace_callback( '#([\s>])((www|ftp)\.[\w\\x80-\\xff\#$%&~/.\-;:=,?@\[\]+]+)#is', '_make_web_ftp_clickable_cb', $ret );
2246                         $ret = preg_replace_callback( '#([\s>])([.0-9a-z_+-]+)@(([0-9a-z-]+\.)+[0-9a-z]{2,})#i', '_make_email_clickable_cb', $ret );
2247
2248                         $ret = substr( $ret, 1, -1 ); // Remove our whitespace padding.
2249                         $r .= $ret;
2250                 }
2251         }
2252
2253         // Cleanup of accidental links within links
2254         return preg_replace( '#(<a([ \r\n\t]+[^>]+?>|>))<a [^>]+?>([^>]+?)</a></a>#i', "$1$3</a>", $r );
2255 }
2256
2257 /**
2258  * Breaks a string into chunks by splitting at whitespace characters.
2259  * The length of each returned chunk is as close to the specified length goal as possible,
2260  * with the caveat that each chunk includes its trailing delimiter.
2261  * Chunks longer than the goal are guaranteed to not have any inner whitespace.
2262  *
2263  * Joining the returned chunks with empty delimiters reconstructs the input string losslessly.
2264  *
2265  * Input string must have no null characters (or eventual transformations on output chunks must not care about null characters)
2266  *
2267  *     _split_str_by_whitespace( "1234 67890 1234 67890a cd 1234   890 123456789 1234567890a    45678   1 3 5 7 90 ", 10 ) ==
2268  *     array (
2269  *         0 => '1234 67890 ',  // 11 characters: Perfect split
2270  *         1 => '1234 ',        //  5 characters: '1234 67890a' was too long
2271  *         2 => '67890a cd ',   // 10 characters: '67890a cd 1234' was too long
2272  *         3 => '1234   890 ',  // 11 characters: Perfect split
2273  *         4 => '123456789 ',   // 10 characters: '123456789 1234567890a' was too long
2274  *         5 => '1234567890a ', // 12 characters: Too long, but no inner whitespace on which to split
2275  *         6 => '   45678   ',  // 11 characters: Perfect split
2276  *         7 => '1 3 5 7 90 ',  // 11 characters: End of $string
2277  *     );
2278  *
2279  * @since 3.4.0
2280  * @access private
2281  *
2282  * @param string $string The string to split.
2283  * @param int    $goal   The desired chunk length.
2284  * @return array Numeric array of chunks.
2285  */
2286 function _split_str_by_whitespace( $string, $goal ) {
2287         $chunks = array();
2288
2289         $string_nullspace = strtr( $string, "\r\n\t\v\f ", "\000\000\000\000\000\000" );
2290
2291         while ( $goal < strlen( $string_nullspace ) ) {
2292                 $pos = strrpos( substr( $string_nullspace, 0, $goal + 1 ), "\000" );
2293
2294                 if ( false === $pos ) {
2295                         $pos = strpos( $string_nullspace, "\000", $goal + 1 );
2296                         if ( false === $pos ) {
2297                                 break;
2298                         }
2299                 }
2300
2301                 $chunks[] = substr( $string, 0, $pos + 1 );
2302                 $string = substr( $string, $pos + 1 );
2303                 $string_nullspace = substr( $string_nullspace, $pos + 1 );
2304         }
2305
2306         if ( $string ) {
2307                 $chunks[] = $string;
2308         }
2309
2310         return $chunks;
2311 }
2312
2313 /**
2314  * Adds rel nofollow string to all HTML A elements in content.
2315  *
2316  * @since 1.5.0
2317  *
2318  * @param string $text Content that may contain HTML A elements.
2319  * @return string Converted content.
2320  */
2321 function wp_rel_nofollow( $text ) {
2322         // This is a pre save filter, so text is already escaped.
2323         $text = stripslashes($text);
2324         $text = preg_replace_callback('|<a (.+?)>|i', 'wp_rel_nofollow_callback', $text);
2325         return wp_slash( $text );
2326 }
2327
2328 /**
2329  * Callback to add rel=nofollow string to HTML A element.
2330  *
2331  * Will remove already existing rel="nofollow" and rel='nofollow' from the
2332  * string to prevent from invalidating (X)HTML.
2333  *
2334  * @since 2.3.0
2335  *
2336  * @param array $matches Single Match
2337  * @return string HTML A Element with rel nofollow.
2338  */
2339 function wp_rel_nofollow_callback( $matches ) {
2340         $text = $matches[1];
2341         $atts = shortcode_parse_atts( $matches[1] );
2342         $rel  = 'nofollow';
2343
2344         if ( preg_match( '%href=["\'](' . preg_quote( set_url_scheme( home_url(), 'http' ) ) . ')%i', $text ) ||
2345              preg_match( '%href=["\'](' . preg_quote( set_url_scheme( home_url(), 'https' ) ) . ')%i', $text )
2346         ) {
2347                 return "<a $text>";
2348         }
2349
2350         if ( ! empty( $atts['rel'] ) ) {
2351                 $parts = array_map( 'trim', explode( ' ', $atts['rel'] ) );
2352                 if ( false === array_search( 'nofollow', $parts ) ) {
2353                         $parts[] = 'nofollow';
2354                 }
2355                 $rel = implode( ' ', $parts );
2356                 unset( $atts['rel'] );
2357
2358                 $html = '';
2359                 foreach ( $atts as $name => $value ) {
2360                         $html .= "{$name}=\"$value\" ";
2361                 }
2362                 $text = trim( $html );
2363         }
2364         return "<a $text rel=\"$rel\">";
2365 }
2366
2367 /**
2368  * Convert one smiley code to the icon graphic file equivalent.
2369  *
2370  * Callback handler for {@link convert_smilies()}.
2371  * Looks up one smiley code in the $wpsmiliestrans global array and returns an
2372  * `<img>` string for that smiley.
2373  *
2374  * @since 2.8.0
2375  *
2376  * @global array $wpsmiliestrans
2377  *
2378  * @param array $matches Single match. Smiley code to convert to image.
2379  * @return string Image string for smiley.
2380  */
2381 function translate_smiley( $matches ) {
2382         global $wpsmiliestrans;
2383
2384         if ( count( $matches ) == 0 )
2385                 return '';
2386
2387         $smiley = trim( reset( $matches ) );
2388         $img = $wpsmiliestrans[ $smiley ];
2389
2390         $matches = array();
2391         $ext = preg_match( '/\.([^.]+)$/', $img, $matches ) ? strtolower( $matches[1] ) : false;
2392         $image_exts = array( 'jpg', 'jpeg', 'jpe', 'gif', 'png' );
2393
2394         // Don't convert smilies that aren't images - they're probably emoji.
2395         if ( ! in_array( $ext, $image_exts ) ) {
2396                 return $img;
2397         }
2398
2399         /**
2400          * Filter the Smiley image URL before it's used in the image element.
2401          *
2402          * @since 2.9.0
2403          *
2404          * @param string $smiley_url URL for the smiley image.
2405          * @param string $img        Filename for the smiley image.
2406          * @param string $site_url   Site URL, as returned by site_url().
2407          */
2408         $src_url = apply_filters( 'smilies_src', includes_url( "images/smilies/$img" ), $img, site_url() );
2409
2410         return sprintf( '<img src="%s" alt="%s" class="wp-smiley" style="height: 1em; max-height: 1em;" />', esc_url( $src_url ), esc_attr( $smiley ) );
2411 }
2412
2413 /**
2414  * Convert text equivalent of smilies to images.
2415  *
2416  * Will only convert smilies if the option 'use_smilies' is true and the global
2417  * used in the function isn't empty.
2418  *
2419  * @since 0.71
2420  *
2421  * @global string|array $wp_smiliessearch
2422  *
2423  * @param string $text Content to convert smilies from text.
2424  * @return string Converted content with text smilies replaced with images.
2425  */
2426 function convert_smilies( $text ) {
2427         global $wp_smiliessearch;
2428         $output = '';
2429         if ( get_option( 'use_smilies' ) && ! empty( $wp_smiliessearch ) ) {
2430                 // HTML loop taken from texturize function, could possible be consolidated
2431                 $textarr = preg_split( '/(<.*>)/U', $text, -1, PREG_SPLIT_DELIM_CAPTURE ); // capture the tags as well as in between
2432                 $stop = count( $textarr );// loop stuff
2433
2434                 // Ignore proessing of specific tags
2435                 $tags_to_ignore = 'code|pre|style|script|textarea';
2436                 $ignore_block_element = '';
2437
2438                 for ( $i = 0; $i < $stop; $i++ ) {
2439                         $content = $textarr[$i];
2440
2441                         // If we're in an ignore block, wait until we find its closing tag
2442                         if ( '' == $ignore_block_element && preg_match( '/^<(' . $tags_to_ignore . ')>/', $content, $matches ) )  {
2443                                 $ignore_block_element = $matches[1];
2444                         }
2445
2446                         // If it's not a tag and not in ignore block
2447                         if ( '' ==  $ignore_block_element && strlen( $content ) > 0 && '<' != $content[0] ) {
2448                                 $content = preg_replace_callback( $wp_smiliessearch, 'translate_smiley', $content );
2449                         }
2450
2451                         // did we exit ignore block
2452                         if ( '' != $ignore_block_element && '</' . $ignore_block_element . '>' == $content )  {
2453                                 $ignore_block_element = '';
2454                         }
2455
2456                         $output .= $content;
2457                 }
2458         } else {
2459                 // return default text.
2460                 $output = $text;
2461         }
2462         return $output;
2463 }
2464
2465 /**
2466  * Verifies that an email is valid.
2467  *
2468  * Does not grok i18n domains. Not RFC compliant.
2469  *
2470  * @since 0.71
2471  *
2472  * @param string $email      Email address to verify.
2473  * @param bool   $deprecated Deprecated.
2474  * @return string|bool Either false or the valid email address.
2475  */
2476 function is_email( $email, $deprecated = false ) {
2477         if ( ! empty( $deprecated ) )
2478                 _deprecated_argument( __FUNCTION__, '3.0' );
2479
2480         // Test for the minimum length the email can be
2481         if ( strlen( $email ) < 3 ) {
2482                 /**
2483                  * Filter whether an email address is valid.
2484                  *
2485                  * This filter is evaluated under several different contexts, such as 'email_too_short',
2486                  * 'email_no_at', 'local_invalid_chars', 'domain_period_sequence', 'domain_period_limits',
2487                  * 'domain_no_periods', 'sub_hyphen_limits', 'sub_invalid_chars', or no specific context.
2488                  *
2489                  * @since 2.8.0
2490                  *
2491                  * @param bool   $is_email Whether the email address has passed the is_email() checks. Default false.
2492                  * @param string $email    The email address being checked.
2493                  * @param string $context  Context under which the email was tested.
2494                  */
2495                 return apply_filters( 'is_email', false, $email, 'email_too_short' );
2496         }
2497
2498         // Test for an @ character after the first position
2499         if ( strpos( $email, '@', 1 ) === false ) {
2500                 /** This filter is documented in wp-includes/formatting.php */
2501                 return apply_filters( 'is_email', false, $email, 'email_no_at' );
2502         }
2503
2504         // Split out the local and domain parts
2505         list( $local, $domain ) = explode( '@', $email, 2 );
2506
2507         // LOCAL PART
2508         // Test for invalid characters
2509         if ( !preg_match( '/^[a-zA-Z0-9!#$%&\'*+\/=?^_`{|}~\.-]+$/', $local ) ) {
2510                 /** This filter is documented in wp-includes/formatting.php */
2511                 return apply_filters( 'is_email', false, $email, 'local_invalid_chars' );
2512         }
2513
2514         // DOMAIN PART
2515         // Test for sequences of periods
2516         if ( preg_match( '/\.{2,}/', $domain ) ) {
2517                 /** This filter is documented in wp-includes/formatting.php */
2518                 return apply_filters( 'is_email', false, $email, 'domain_period_sequence' );
2519         }
2520
2521         // Test for leading and trailing periods and whitespace
2522         if ( trim( $domain, " \t\n\r\0\x0B." ) !== $domain ) {
2523                 /** This filter is documented in wp-includes/formatting.php */
2524                 return apply_filters( 'is_email', false, $email, 'domain_period_limits' );
2525         }
2526
2527         // Split the domain into subs
2528         $subs = explode( '.', $domain );
2529
2530         // Assume the domain will have at least two subs
2531         if ( 2 > count( $subs ) ) {
2532                 /** This filter is documented in wp-includes/formatting.php */
2533                 return apply_filters( 'is_email', false, $email, 'domain_no_periods' );
2534         }
2535
2536         // Loop through each sub
2537         foreach ( $subs as $sub ) {
2538                 // Test for leading and trailing hyphens and whitespace
2539                 if ( trim( $sub, " \t\n\r\0\x0B-" ) !== $sub ) {
2540                         /** This filter is documented in wp-includes/formatting.php */
2541                         return apply_filters( 'is_email', false, $email, 'sub_hyphen_limits' );
2542                 }
2543
2544                 // Test for invalid characters
2545                 if ( !preg_match('/^[a-z0-9-]+$/i', $sub ) ) {
2546                         /** This filter is documented in wp-includes/formatting.php */
2547                         return apply_filters( 'is_email', false, $email, 'sub_invalid_chars' );
2548                 }
2549         }
2550
2551         // Congratulations your email made it!
2552         /** This filter is documented in wp-includes/formatting.php */
2553         return apply_filters( 'is_email', $email, $email, null );
2554 }
2555
2556 /**
2557  * Convert to ASCII from email subjects.
2558  *
2559  * @since 1.2.0
2560  *
2561  * @param string $string Subject line
2562  * @return string Converted string to ASCII
2563  */
2564 function wp_iso_descrambler( $string ) {
2565         /* this may only work with iso-8859-1, I'm afraid */
2566         if (!preg_match('#\=\?(.+)\?Q\?(.+)\?\=#i', $string, $matches)) {
2567                 return $string;
2568         } else {
2569                 $subject = str_replace('_', ' ', $matches[2]);
2570                 return preg_replace_callback( '#\=([0-9a-f]{2})#i', '_wp_iso_convert', $subject );
2571         }
2572 }
2573
2574 /**
2575  * Helper function to convert hex encoded chars to ASCII
2576  *
2577  * @since 3.1.0
2578  * @access private
2579  *
2580  * @param array $match The preg_replace_callback matches array
2581  * @return string Converted chars
2582  */
2583 function _wp_iso_convert( $match ) {
2584         return chr( hexdec( strtolower( $match[1] ) ) );
2585 }
2586
2587 /**
2588  * Returns a date in the GMT equivalent.
2589  *
2590  * Requires and returns a date in the Y-m-d H:i:s format. If there is a
2591  * timezone_string available, the date is assumed to be in that timezone,
2592  * otherwise it simply subtracts the value of the 'gmt_offset' option. Return
2593  * format can be overridden using the $format parameter.
2594  *
2595  * @since 1.2.0
2596  *
2597  * @param string $string The date to be converted.
2598  * @param string $format The format string for the returned date (default is Y-m-d H:i:s)
2599  * @return string GMT version of the date provided.
2600  */
2601 function get_gmt_from_date( $string, $format = 'Y-m-d H:i:s' ) {
2602         $tz = get_option( 'timezone_string' );
2603         if ( $tz ) {
2604                 $datetime = date_create( $string, new DateTimeZone( $tz ) );
2605                 if ( ! $datetime ) {
2606                         return gmdate( $format, 0 );
2607                 }
2608                 $datetime->setTimezone( new DateTimeZone( 'UTC' ) );
2609                 $string_gmt = $datetime->format( $format );
2610         } else {
2611                 if ( ! preg_match( '#([0-9]{1,4})-([0-9]{1,2})-([0-9]{1,2}) ([0-9]{1,2}):([0-9]{1,2}):([0-9]{1,2})#', $string, $matches ) ) {
2612                         $datetime = strtotime( $string );
2613                         if ( false === $datetime ) {
2614                                 return gmdate( $format, 0 );
2615                         }
2616                         return gmdate( $format, $datetime );
2617                 }
2618                 $string_time = gmmktime( $matches[4], $matches[5], $matches[6], $matches[2], $matches[3], $matches[1] );
2619                 $string_gmt = gmdate( $format, $string_time - get_option( 'gmt_offset' ) * HOUR_IN_SECONDS );
2620         }
2621         return $string_gmt;
2622 }
2623
2624 /**
2625  * Converts a GMT date into the correct format for the blog.
2626  *
2627  * Requires and returns a date in the Y-m-d H:i:s format. If there is a
2628  * timezone_string available, the returned date is in that timezone, otherwise
2629  * it simply adds the value of gmt_offset. Return format can be overridden
2630  * using the $format parameter
2631  *
2632  * @since 1.2.0
2633  *
2634  * @param string $string The date to be converted.
2635  * @param string $format The format string for the returned date (default is Y-m-d H:i:s)
2636  * @return string Formatted date relative to the timezone / GMT offset.
2637  */
2638 function get_date_from_gmt( $string, $format = 'Y-m-d H:i:s' ) {
2639         $tz = get_option( 'timezone_string' );
2640         if ( $tz ) {
2641                 $datetime = date_create( $string, new DateTimeZone( 'UTC' ) );
2642                 if ( ! $datetime )
2643                         return date( $format, 0 );
2644                 $datetime->setTimezone( new DateTimeZone( $tz ) );
2645                 $string_localtime = $datetime->format( $format );
2646         } else {
2647                 if ( ! preg_match('#([0-9]{1,4})-([0-9]{1,2})-([0-9]{1,2}) ([0-9]{1,2}):([0-9]{1,2}):([0-9]{1,2})#', $string, $matches) )
2648                         return date( $format, 0 );
2649                 $string_time = gmmktime( $matches[4], $matches[5], $matches[6], $matches[2], $matches[3], $matches[1] );
2650                 $string_localtime = gmdate( $format, $string_time + get_option( 'gmt_offset' ) * HOUR_IN_SECONDS );
2651         }
2652         return $string_localtime;
2653 }
2654
2655 /**
2656  * Computes an offset in seconds from an iso8601 timezone.
2657  *
2658  * @since 1.5.0
2659  *
2660  * @param string $timezone Either 'Z' for 0 offset or '±hhmm'.
2661  * @return int|float The offset in seconds.
2662  */
2663 function iso8601_timezone_to_offset( $timezone ) {
2664         // $timezone is either 'Z' or '[+|-]hhmm'
2665         if ($timezone == 'Z') {
2666                 $offset = 0;
2667         } else {
2668                 $sign    = (substr($timezone, 0, 1) == '+') ? 1 : -1;
2669                 $hours   = intval(substr($timezone, 1, 2));
2670                 $minutes = intval(substr($timezone, 3, 4)) / 60;
2671                 $offset  = $sign * HOUR_IN_SECONDS * ($hours + $minutes);
2672         }
2673         return $offset;
2674 }
2675
2676 /**
2677  * Converts an iso8601 date to MySQL DateTime format used by post_date[_gmt].
2678  *
2679  * @since 1.5.0
2680  *
2681  * @param string $date_string Date and time in ISO 8601 format {@link http://en.wikipedia.org/wiki/ISO_8601}.
2682  * @param string $timezone    Optional. If set to GMT returns the time minus gmt_offset. Default is 'user'.
2683  * @return string The date and time in MySQL DateTime format - Y-m-d H:i:s.
2684  */
2685 function iso8601_to_datetime( $date_string, $timezone = 'user' ) {
2686         $timezone = strtolower($timezone);
2687
2688         if ($timezone == 'gmt') {
2689
2690                 preg_match('#([0-9]{4})([0-9]{2})([0-9]{2})T([0-9]{2}):([0-9]{2}):([0-9]{2})(Z|[\+|\-][0-9]{2,4}){0,1}#', $date_string, $date_bits);
2691
2692                 if (!empty($date_bits[7])) { // we have a timezone, so let's compute an offset
2693                         $offset = iso8601_timezone_to_offset($date_bits[7]);
2694                 } else { // we don't have a timezone, so we assume user local timezone (not server's!)
2695                         $offset = HOUR_IN_SECONDS * get_option('gmt_offset');
2696                 }
2697
2698                 $timestamp = gmmktime($date_bits[4], $date_bits[5], $date_bits[6], $date_bits[2], $date_bits[3], $date_bits[1]);
2699                 $timestamp -= $offset;
2700
2701                 return gmdate('Y-m-d H:i:s', $timestamp);
2702
2703         } elseif ($timezone == 'user') {
2704                 return preg_replace('#([0-9]{4})([0-9]{2})([0-9]{2})T([0-9]{2}):([0-9]{2}):([0-9]{2})(Z|[\+|\-][0-9]{2,4}){0,1}#', '$1-$2-$3 $4:$5:$6', $date_string);
2705         }
2706 }
2707
2708 /**
2709  * Strips out all characters that are not allowable in an email.
2710  *
2711  * @since 1.5.0
2712  *
2713  * @param string $email Email address to filter.
2714  * @return string Filtered email address.
2715  */
2716 function sanitize_email( $email ) {
2717         // Test for the minimum length the email can be
2718         if ( strlen( $email ) < 3 ) {
2719                 /**
2720                  * Filter a sanitized email address.
2721                  *
2722                  * This filter is evaluated under several contexts, including 'email_too_short',
2723                  * 'email_no_at', 'local_invalid_chars', 'domain_period_sequence', 'domain_period_limits',
2724                  * 'domain_no_periods', 'domain_no_valid_subs', or no context.
2725                  *
2726                  * @since 2.8.0
2727                  *
2728                  * @param string $email   The sanitized email address.
2729                  * @param string $email   The email address, as provided to sanitize_email().
2730                  * @param string $message A message to pass to the user.
2731                  */
2732                 return apply_filters( 'sanitize_email', '', $email, 'email_too_short' );
2733         }
2734
2735         // Test for an @ character after the first position
2736         if ( strpos( $email, '@', 1 ) === false ) {
2737                 /** This filter is documented in wp-includes/formatting.php */
2738                 return apply_filters( 'sanitize_email', '', $email, 'email_no_at' );
2739         }
2740
2741         // Split out the local and domain parts
2742         list( $local, $domain ) = explode( '@', $email, 2 );
2743
2744         // LOCAL PART
2745         // Test for invalid characters
2746         $local = preg_replace( '/[^a-zA-Z0-9!#$%&\'*+\/=?^_`{|}~\.-]/', '', $local );
2747         if ( '' === $local ) {
2748                 /** This filter is documented in wp-includes/formatting.php */
2749                 return apply_filters( 'sanitize_email', '', $email, 'local_invalid_chars' );
2750         }
2751
2752         // DOMAIN PART
2753         // Test for sequences of periods
2754         $domain = preg_replace( '/\.{2,}/', '', $domain );
2755         if ( '' === $domain ) {
2756                 /** This filter is documented in wp-includes/formatting.php */
2757                 return apply_filters( 'sanitize_email', '', $email, 'domain_period_sequence' );
2758         }
2759
2760         // Test for leading and trailing periods and whitespace
2761         $domain = trim( $domain, " \t\n\r\0\x0B." );
2762         if ( '' === $domain ) {
2763                 /** This filter is documented in wp-includes/formatting.php */
2764                 return apply_filters( 'sanitize_email', '', $email, 'domain_period_limits' );
2765         }
2766
2767         // Split the domain into subs
2768         $subs = explode( '.', $domain );
2769
2770         // Assume the domain will have at least two subs
2771         if ( 2 > count( $subs ) ) {
2772                 /** This filter is documented in wp-includes/formatting.php */
2773                 return apply_filters( 'sanitize_email', '', $email, 'domain_no_periods' );
2774         }
2775
2776         // Create an array that will contain valid subs
2777         $new_subs = array();
2778
2779         // Loop through each sub
2780         foreach ( $subs as $sub ) {
2781                 // Test for leading and trailing hyphens
2782                 $sub = trim( $sub, " \t\n\r\0\x0B-" );
2783
2784                 // Test for invalid characters
2785                 $sub = preg_replace( '/[^a-z0-9-]+/i', '', $sub );
2786
2787                 // If there's anything left, add it to the valid subs
2788                 if ( '' !== $sub ) {
2789                         $new_subs[] = $sub;
2790                 }
2791         }
2792
2793         // If there aren't 2 or more valid subs
2794         if ( 2 > count( $new_subs ) ) {
2795                 /** This filter is documented in wp-includes/formatting.php */
2796                 return apply_filters( 'sanitize_email', '', $email, 'domain_no_valid_subs' );
2797         }
2798
2799         // Join valid subs into the new domain
2800         $domain = join( '.', $new_subs );
2801
2802         // Put the email back together
2803         $email = $local . '@' . $domain;
2804
2805         // Congratulations your email made it!
2806         /** This filter is documented in wp-includes/formatting.php */
2807         return apply_filters( 'sanitize_email', $email, $email, null );
2808 }
2809
2810 /**
2811  * Determines the difference between two timestamps.
2812  *
2813  * The difference is returned in a human readable format such as "1 hour",
2814  * "5 mins", "2 days".
2815  *
2816  * @since 1.5.0
2817  *
2818  * @param int $from Unix timestamp from which the difference begins.
2819  * @param int $to   Optional. Unix timestamp to end the time difference. Default becomes time() if not set.
2820  * @return string Human readable time difference.
2821  */
2822 function human_time_diff( $from, $to = '' ) {
2823         if ( empty( $to ) ) {
2824                 $to = time();
2825         }
2826
2827         $diff = (int) abs( $to - $from );
2828
2829         if ( $diff < HOUR_IN_SECONDS ) {
2830                 $mins = round( $diff / MINUTE_IN_SECONDS );
2831                 if ( $mins <= 1 )
2832                         $mins = 1;
2833                 /* translators: min=minute */
2834                 $since = sprintf( _n( '%s min', '%s mins', $mins ), $mins );
2835         } elseif ( $diff < DAY_IN_SECONDS && $diff >= HOUR_IN_SECONDS ) {
2836                 $hours = round( $diff / HOUR_IN_SECONDS );
2837                 if ( $hours <= 1 )
2838                         $hours = 1;
2839                 $since = sprintf( _n( '%s hour', '%s hours', $hours ), $hours );
2840         } elseif ( $diff < WEEK_IN_SECONDS && $diff >= DAY_IN_SECONDS ) {
2841                 $days = round( $diff / DAY_IN_SECONDS );
2842                 if ( $days <= 1 )
2843                         $days = 1;
2844                 $since = sprintf( _n( '%s day', '%s days', $days ), $days );
2845         } elseif ( $diff < MONTH_IN_SECONDS && $diff >= WEEK_IN_SECONDS ) {
2846                 $weeks = round( $diff / WEEK_IN_SECONDS );
2847                 if ( $weeks <= 1 )
2848                         $weeks = 1;
2849                 $since = sprintf( _n( '%s week', '%s weeks', $weeks ), $weeks );
2850         } elseif ( $diff < YEAR_IN_SECONDS && $diff >= MONTH_IN_SECONDS ) {
2851                 $months = round( $diff / MONTH_IN_SECONDS );
2852                 if ( $months <= 1 )
2853                         $months = 1;
2854                 $since = sprintf( _n( '%s month', '%s months', $months ), $months );
2855         } elseif ( $diff >= YEAR_IN_SECONDS ) {
2856                 $years = round( $diff / YEAR_IN_SECONDS );
2857                 if ( $years <= 1 )
2858                         $years = 1;
2859                 $since = sprintf( _n( '%s year', '%s years', $years ), $years );
2860         }
2861
2862         /**
2863          * Filter the human readable difference between two timestamps.
2864          *
2865          * @since 4.0.0
2866          *
2867          * @param string $since The difference in human readable text.
2868          * @param int    $diff  The difference in seconds.
2869          * @param int    $from  Unix timestamp from which the difference begins.
2870          * @param int    $to    Unix timestamp to end the time difference.
2871          */
2872         return apply_filters( 'human_time_diff', $since, $diff, $from, $to );
2873 }
2874
2875 /**
2876  * Generates an excerpt from the content, if needed.
2877  *
2878  * The excerpt word amount will be 55 words and if the amount is greater than
2879  * that, then the string ' [&hellip;]' will be appended to the excerpt. If the string
2880  * is less than 55 words, then the content will be returned as is.
2881  *
2882  * The 55 word limit can be modified by plugins/themes using the excerpt_length filter
2883  * The ' [&hellip;]' string can be modified by plugins/themes using the excerpt_more filter
2884  *
2885  * @since 1.5.0
2886  *
2887  * @param string $text Optional. The excerpt. If set to empty, an excerpt is generated.
2888  * @return string The excerpt.
2889  */
2890 function wp_trim_excerpt( $text = '' ) {
2891         $raw_excerpt = $text;
2892         if ( '' == $text ) {
2893                 $text = get_the_content('');
2894
2895                 $text = strip_shortcodes( $text );
2896
2897                 /** This filter is documented in wp-includes/post-template.php */
2898                 $text = apply_filters( 'the_content', $text );
2899                 $text = str_replace(']]>', ']]&gt;', $text);
2900
2901                 /**
2902                  * Filter the number of words in an excerpt.
2903                  *
2904                  * @since 2.7.0
2905                  *
2906                  * @param int $number The number of words. Default 55.
2907                  */
2908                 $excerpt_length = apply_filters( 'excerpt_length', 55 );
2909                 /**
2910                  * Filter the string in the "more" link displayed after a trimmed excerpt.
2911                  *
2912                  * @since 2.9.0
2913                  *
2914                  * @param string $more_string The string shown within the more link.
2915                  */
2916                 $excerpt_more = apply_filters( 'excerpt_more', ' ' . '[&hellip;]' );
2917                 $text = wp_trim_words( $text, $excerpt_length, $excerpt_more );
2918         }
2919         /**
2920          * Filter the trimmed excerpt string.
2921          *
2922          * @since 2.8.0
2923          *
2924          * @param string $text        The trimmed text.
2925          * @param string $raw_excerpt The text prior to trimming.
2926          */
2927         return apply_filters( 'wp_trim_excerpt', $text, $raw_excerpt );
2928 }
2929
2930 /**
2931  * Trims text to a certain number of words.
2932  *
2933  * This function is localized. For languages that count 'words' by the individual
2934  * character (such as East Asian languages), the $num_words argument will apply
2935  * to the number of individual characters.
2936  *
2937  * @since 3.3.0
2938  *
2939  * @param string $text      Text to trim.
2940  * @param int    $num_words Number of words. Default 55.
2941  * @param string $more      Optional. What to append if $text needs to be trimmed. Default '&hellip;'.
2942  * @return string Trimmed text.
2943  */
2944 function wp_trim_words( $text, $num_words = 55, $more = null ) {
2945         if ( null === $more ) {
2946                 $more = __( '&hellip;' );
2947         }
2948
2949         $original_text = $text;
2950         $text = wp_strip_all_tags( $text );
2951
2952         /*
2953          * translators: If your word count is based on single characters (e.g. East Asian characters),
2954          * enter 'characters_excluding_spaces' or 'characters_including_spaces'. Otherwise, enter 'words'.
2955          * Do not translate into your own language.
2956          */
2957         if ( strpos( _x( 'words', 'Word count type. Do not translate!' ), 'characters' ) === 0 && preg_match( '/^utf\-?8$/i', get_option( 'blog_charset' ) ) ) {
2958                 $text = trim( preg_replace( "/[\n\r\t ]+/", ' ', $text ), ' ' );
2959                 preg_match_all( '/./u', $text, $words_array );
2960                 $words_array = array_slice( $words_array[0], 0, $num_words + 1 );
2961                 $sep = '';
2962         } else {
2963                 $words_array = preg_split( "/[\n\r\t ]+/", $text, $num_words + 1, PREG_SPLIT_NO_EMPTY );
2964                 $sep = ' ';
2965         }
2966
2967         if ( count( $words_array ) > $num_words ) {
2968                 array_pop( $words_array );
2969                 $text = implode( $sep, $words_array );
2970                 $text = $text . $more;
2971         } else {
2972                 $text = implode( $sep, $words_array );
2973         }
2974
2975         /**
2976          * Filter the text content after words have been trimmed.
2977          *
2978          * @since 3.3.0
2979          *
2980          * @param string $text          The trimmed text.
2981          * @param int    $num_words     The number of words to trim the text to. Default 5.
2982          * @param string $more          An optional string to append to the end of the trimmed text, e.g. &hellip;.
2983          * @param string $original_text The text before it was trimmed.
2984          */
2985         return apply_filters( 'wp_trim_words', $text, $num_words, $more, $original_text );
2986 }
2987
2988 /**
2989  * Converts named entities into numbered entities.
2990  *
2991  * @since 1.5.1
2992  *
2993  * @param string $text The text within which entities will be converted.
2994  * @return string Text with converted entities.
2995  */
2996 function ent2ncr( $text ) {
2997
2998         /**
2999          * Filter text before named entities are converted into numbered entities.
3000          *
3001          * A non-null string must be returned for the filter to be evaluated.
3002          *
3003          * @since 3.3.0
3004          *
3005          * @param null   $converted_text The text to be converted. Default null.
3006          * @param string $text           The text prior to entity conversion.
3007          */
3008         $filtered = apply_filters( 'pre_ent2ncr', null, $text );
3009         if ( null !== $filtered )
3010                 return $filtered;
3011
3012         $to_ncr = array(
3013                 '&quot;' => '&#34;',
3014                 '&amp;' => '&#38;',
3015                 '&lt;' => '&#60;',
3016                 '&gt;' => '&#62;',
3017                 '|' => '&#124;',
3018                 '&nbsp;' => '&#160;',
3019                 '&iexcl;' => '&#161;',
3020                 '&cent;' => '&#162;',
3021                 '&pound;' => '&#163;',
3022                 '&curren;' => '&#164;',
3023                 '&yen;' => '&#165;',
3024                 '&brvbar;' => '&#166;',
3025                 '&brkbar;' => '&#166;',
3026                 '&sect;' => '&#167;',
3027                 '&uml;' => '&#168;',
3028                 '&die;' => '&#168;',
3029                 '&copy;' => '&#169;',
3030                 '&ordf;' => '&#170;',
3031                 '&laquo;' => '&#171;',
3032                 '&not;' => '&#172;',
3033                 '&shy;' => '&#173;',
3034                 '&reg;' => '&#174;',
3035                 '&macr;' => '&#175;',
3036                 '&hibar;' => '&#175;',
3037                 '&deg;' => '&#176;',
3038                 '&plusmn;' => '&#177;',
3039                 '&sup2;' => '&#178;',
3040                 '&sup3;' => '&#179;',
3041                 '&acute;' => '&#180;',
3042                 '&micro;' => '&#181;',
3043                 '&para;' => '&#182;',
3044                 '&middot;' => '&#183;',
3045                 '&cedil;' => '&#184;',
3046                 '&sup1;' => '&#185;',
3047                 '&ordm;' => '&#186;',
3048                 '&raquo;' => '&#187;',
3049                 '&frac14;' => '&#188;',
3050                 '&frac12;' => '&#189;',
3051                 '&frac34;' => '&#190;',
3052                 '&iquest;' => '&#191;',
3053                 '&Agrave;' => '&#192;',
3054                 '&Aacute;' => '&#193;',
3055                 '&Acirc;' => '&#194;',
3056                 '&Atilde;' => '&#195;',
3057                 '&Auml;' => '&#196;',
3058                 '&Aring;' => '&#197;',
3059                 '&AElig;' => '&#198;',
3060                 '&Ccedil;' => '&#199;',
3061                 '&Egrave;' => '&#200;',
3062                 '&Eacute;' => '&#201;',
3063                 '&Ecirc;' => '&#202;',
3064                 '&Euml;' => '&#203;',
3065                 '&Igrave;' => '&#204;',
3066                 '&Iacute;' => '&#205;',
3067                 '&Icirc;' => '&#206;',
3068                 '&Iuml;' => '&#207;',
3069                 '&ETH;' => '&#208;',
3070                 '&Ntilde;' => '&#209;',
3071                 '&Ograve;' => '&#210;',
3072                 '&Oacute;' => '&#211;',
3073                 '&Ocirc;' => '&#212;',
3074                 '&Otilde;' => '&#213;',
3075                 '&Ouml;' => '&#214;',
3076                 '&times;' => '&#215;',
3077                 '&Oslash;' => '&#216;',
3078                 '&Ugrave;' => '&#217;',
3079                 '&Uacute;' => '&#218;',
3080                 '&Ucirc;' => '&#219;',
3081                 '&Uuml;' => '&#220;',
3082                 '&Yacute;' => '&#221;',
3083                 '&THORN;' => '&#222;',
3084                 '&szlig;' => '&#223;',
3085                 '&agrave;' => '&#224;',
3086                 '&aacute;' => '&#225;',
3087                 '&acirc;' => '&#226;',
3088                 '&atilde;' => '&#227;',
3089                 '&auml;' => '&#228;',
3090                 '&aring;' => '&#229;',
3091                 '&aelig;' => '&#230;',
3092                 '&ccedil;' => '&#231;',
3093                 '&egrave;' => '&#232;',
3094                 '&eacute;' => '&#233;',
3095                 '&ecirc;' => '&#234;',
3096                 '&euml;' => '&#235;',
3097                 '&igrave;' => '&#236;',
3098                 '&iacute;' => '&#237;',
3099                 '&icirc;' => '&#238;',
3100                 '&iuml;' => '&#239;',
3101                 '&eth;' => '&#240;',
3102                 '&ntilde;' => '&#241;',
3103                 '&ograve;' => '&#242;',
3104                 '&oacute;' => '&#243;',
3105                 '&ocirc;' => '&#244;',
3106                 '&otilde;' => '&#245;',
3107                 '&ouml;' => '&#246;',
3108                 '&divide;' => '&#247;',
3109                 '&oslash;' => '&#248;',
3110                 '&ugrave;' => '&#249;',
3111                 '&uacute;' => '&#250;',
3112                 '&ucirc;' => '&#251;',
3113                 '&uuml;' => '&#252;',
3114                 '&yacute;' => '&#253;',
3115                 '&thorn;' => '&#254;',
3116                 '&yuml;' => '&#255;',
3117                 '&OElig;' => '&#338;',
3118                 '&oelig;' => '&#339;',
3119                 '&Scaron;' => '&#352;',
3120                 '&scaron;' => '&#353;',
3121                 '&Yuml;' => '&#376;',
3122                 '&fnof;' => '&#402;',
3123                 '&circ;' => '&#710;',
3124                 '&tilde;' => '&#732;',
3125                 '&Alpha;' => '&#913;',
3126                 '&Beta;' => '&#914;',
3127                 '&Gamma;' => '&#915;',
3128                 '&Delta;' => '&#916;',
3129                 '&Epsilon;' => '&#917;',
3130                 '&Zeta;' => '&#918;',
3131                 '&Eta;' => '&#919;',
3132                 '&Theta;' => '&#920;',
3133                 '&Iota;' => '&#921;',
3134                 '&Kappa;' => '&#922;',
3135                 '&Lambda;' => '&#923;',
3136                 '&Mu;' => '&#924;',
3137                 '&Nu;' => '&#925;',
3138                 '&Xi;' => '&#926;',
3139                 '&Omicron;' => '&#927;',
3140                 '&Pi;' => '&#928;',
3141                 '&Rho;' => '&#929;',
3142                 '&Sigma;' => '&#931;',
3143                 '&Tau;' => '&#932;',
3144                 '&Upsilon;' => '&#933;',
3145                 '&Phi;' => '&#934;',
3146                 '&Chi;' => '&#935;',
3147                 '&Psi;' => '&#936;',
3148                 '&Omega;' => '&#937;',
3149                 '&alpha;' => '&#945;',
3150                 '&beta;' => '&#946;',
3151                 '&gamma;' => '&#947;',
3152                 '&delta;' => '&#948;',
3153                 '&epsilon;' => '&#949;',
3154                 '&zeta;' => '&#950;',
3155                 '&eta;' => '&#951;',
3156                 '&theta;' => '&#952;',
3157                 '&iota;' => '&#953;',
3158                 '&kappa;' => '&#954;',
3159                 '&lambda;' => '&#955;',
3160                 '&mu;' => '&#956;',
3161                 '&nu;' => '&#957;',
3162                 '&xi;' => '&#958;',
3163                 '&omicron;' => '&#959;',
3164                 '&pi;' => '&#960;',
3165                 '&rho;' => '&#961;',
3166                 '&sigmaf;' => '&#962;',
3167                 '&sigma;' => '&#963;',
3168                 '&tau;' => '&#964;',
3169                 '&upsilon;' => '&#965;',
3170                 '&phi;' => '&#966;',
3171                 '&chi;' => '&#967;',
3172                 '&psi;' => '&#968;',
3173                 '&omega;' => '&#969;',
3174                 '&thetasym;' => '&#977;',
3175                 '&upsih;' => '&#978;',
3176                 '&piv;' => '&#982;',
3177                 '&ensp;' => '&#8194;',
3178                 '&emsp;' => '&#8195;',
3179                 '&thinsp;' => '&#8201;',
3180                 '&zwnj;' => '&#8204;',
3181                 '&zwj;' => '&#8205;',
3182                 '&lrm;' => '&#8206;',
3183                 '&rlm;' => '&#8207;',
3184                 '&ndash;' => '&#8211;',
3185                 '&mdash;' => '&#8212;',
3186                 '&lsquo;' => '&#8216;',
3187                 '&rsquo;' => '&#8217;',
3188                 '&sbquo;' => '&#8218;',
3189                 '&ldquo;' => '&#8220;',
3190                 '&rdquo;' => '&#8221;',
3191                 '&bdquo;' => '&#8222;',
3192                 '&dagger;' => '&#8224;',
3193                 '&Dagger;' => '&#8225;',
3194                 '&bull;' => '&#8226;',
3195                 '&hellip;' => '&#8230;',
3196                 '&permil;' => '&#8240;',
3197                 '&prime;' => '&#8242;',
3198                 '&Prime;' => '&#8243;',
3199                 '&lsaquo;' => '&#8249;',
3200                 '&rsaquo;' => '&#8250;',
3201                 '&oline;' => '&#8254;',
3202                 '&frasl;' => '&#8260;',
3203                 '&euro;' => '&#8364;',
3204                 '&image;' => '&#8465;',
3205                 '&weierp;' => '&#8472;',
3206                 '&real;' => '&#8476;',
3207                 '&trade;' => '&#8482;',
3208                 '&alefsym;' => '&#8501;',
3209                 '&crarr;' => '&#8629;',
3210                 '&lArr;' => '&#8656;',
3211                 '&uArr;' => '&#8657;',
3212                 '&rArr;' => '&#8658;',
3213                 '&dArr;' => '&#8659;',
3214                 '&hArr;' => '&#8660;',
3215                 '&forall;' => '&#8704;',
3216                 '&part;' => '&#8706;',
3217                 '&exist;' => '&#8707;',
3218                 '&empty;' => '&#8709;',
3219                 '&nabla;' => '&#8711;',
3220                 '&isin;' => '&#8712;',
3221                 '&notin;' => '&#8713;',
3222                 '&ni;' => '&#8715;',
3223                 '&prod;' => '&#8719;',
3224                 '&sum;' => '&#8721;',
3225                 '&minus;' => '&#8722;',
3226                 '&lowast;' => '&#8727;',
3227                 '&radic;' => '&#8730;',
3228                 '&prop;' => '&#8733;',
3229                 '&infin;' => '&#8734;',
3230                 '&ang;' => '&#8736;',
3231                 '&and;' => '&#8743;',
3232                 '&or;' => '&#8744;',
3233                 '&cap;' => '&#8745;',
3234                 '&cup;' => '&#8746;',
3235                 '&int;' => '&#8747;',
3236                 '&there4;' => '&#8756;',
3237                 '&sim;' => '&#8764;',
3238                 '&cong;' => '&#8773;',
3239                 '&asymp;' => '&#8776;',
3240                 '&ne;' => '&#8800;',
3241                 '&equiv;' => '&#8801;',
3242                 '&le;' => '&#8804;',
3243                 '&ge;' => '&#8805;',
3244                 '&sub;' => '&#8834;',
3245                 '&sup;' => '&#8835;',
3246                 '&nsub;' => '&#8836;',
3247                 '&sube;' => '&#8838;',
3248                 '&supe;' => '&#8839;',
3249                 '&oplus;' => '&#8853;',
3250                 '&otimes;' => '&#8855;',
3251                 '&perp;' => '&#8869;',
3252                 '&sdot;' => '&#8901;',
3253                 '&lceil;' => '&#8968;',
3254                 '&rceil;' => '&#8969;',
3255                 '&lfloor;' => '&#8970;',
3256                 '&rfloor;' => '&#8971;',
3257                 '&lang;' => '&#9001;',
3258                 '&rang;' => '&#9002;',
3259                 '&larr;' => '&#8592;',
3260                 '&uarr;' => '&#8593;',
3261                 '&rarr;' => '&#8594;',
3262                 '&darr;' => '&#8595;',
3263                 '&harr;' => '&#8596;',
3264                 '&loz;' => '&#9674;',
3265                 '&spades;' => '&#9824;',
3266                 '&clubs;' => '&#9827;',
3267                 '&hearts;' => '&#9829;',
3268                 '&diams;' => '&#9830;'
3269         );
3270
3271         return str_replace( array_keys($to_ncr), array_values($to_ncr), $text );
3272 }
3273
3274 /**
3275  * Formats text for the editor.
3276  *
3277  * Generally the browsers treat everything inside a textarea as text, but
3278  * it is still a good idea to HTML entity encode `<`, `>` and `&` in the content.
3279  *
3280  * The filter {@see 'format_for_editor'} is applied here. If `$text` is empty the
3281  * filter will be applied to an empty string.
3282  *
3283  * @since 4.3.0
3284  *
3285  * @see _WP_Editors::editor()
3286  *
3287  * @param string $text           The text to be formatted.
3288  * @param string $default_editor The default editor for the current user.
3289  *                               It is usually either 'html' or 'tinymce'.
3290  * @return string The formatted text after filter is applied.
3291  */
3292 function format_for_editor( $text, $default_editor = null ) {
3293         if ( $text ) {
3294                 $text = htmlspecialchars( $text, ENT_NOQUOTES, get_option( 'blog_charset' ) );
3295         }
3296
3297         /**
3298          * Filter the text after it is formatted for the editor.
3299          *
3300          * @since 4.3.0
3301          *
3302          * @param string $text           The formatted text.
3303          * @param string $default_editor The default editor for the current user.
3304          *                               It is usually either 'html' or 'tinymce'.
3305          */
3306         return apply_filters( 'format_for_editor', $text, $default_editor );
3307 }
3308
3309 /**
3310  * Perform a deep string replace operation to ensure the values in $search are no longer present
3311  *
3312  * Repeats the replacement operation until it no longer replaces anything so as to remove "nested" values
3313  * e.g. $subject = '%0%0%0DDD', $search ='%0D', $result ='' rather than the '%0%0DD' that
3314  * str_replace would return
3315  *
3316  * @since 2.8.1
3317  * @access private
3318  *
3319  * @param string|array $search  The value being searched for, otherwise known as the needle.
3320  *                              An array may be used to designate multiple needles.
3321  * @param string       $subject The string being searched and replaced on, otherwise known as the haystack.
3322  * @return string The string with the replaced svalues.
3323  */
3324 function _deep_replace( $search, $subject ) {
3325         $subject = (string) $subject;
3326
3327         $count = 1;
3328         while ( $count ) {
3329                 $subject = str_replace( $search, '', $subject, $count );
3330         }
3331
3332         return $subject;
3333 }
3334
3335 /**
3336  * Escapes data for use in a MySQL query.
3337  *
3338  * Usually you should prepare queries using wpdb::prepare().
3339  * Sometimes, spot-escaping is required or useful. One example
3340  * is preparing an array for use in an IN clause.
3341  *
3342  * @since 2.8.0
3343  *
3344  * @global wpdb $wpdb WordPress database abstraction object.
3345  *
3346  * @param string|array $data Unescaped data
3347  * @return string|array Escaped data
3348  */
3349 function esc_sql( $data ) {
3350         global $wpdb;
3351         return $wpdb->_escape( $data );
3352 }
3353
3354 /**
3355  * Checks and cleans a URL.
3356  *
3357  * A number of characters are removed from the URL. If the URL is for displaying
3358  * (the default behaviour) ampersands are also replaced. The 'clean_url' filter
3359  * is applied to the returned cleaned URL.
3360  *
3361  * @since 2.8.0
3362  *
3363  * @param string $url       The URL to be cleaned.
3364  * @param array  $protocols Optional. An array of acceptable protocols.
3365  *                                  Defaults to return value of wp_allowed_protocols()
3366  * @param string $_context  Private. Use esc_url_raw() for database usage.
3367  * @return string The cleaned $url after the 'clean_url' filter is applied.
3368  */
3369 function esc_url( $url, $protocols = null, $_context = 'display' ) {
3370         $original_url = $url;
3371
3372         if ( '' == $url )
3373                 return $url;
3374
3375         $url = str_replace( ' ', '%20', $url );
3376         $url = preg_replace('|[^a-z0-9-~+_.?#=!&;,/:%@$\|*\'()\[\]\\x80-\\xff]|i', '', $url);
3377
3378         if ( '' === $url ) {
3379                 return $url;
3380         }
3381
3382         if ( 0 !== stripos( $url, 'mailto:' ) ) {
3383                 $strip = array('%0d', '%0a', '%0D', '%0A');
3384                 $url = _deep_replace($strip, $url);
3385         }
3386
3387         $url = str_replace(';//', '://', $url);
3388         /* If the URL doesn't appear to contain a scheme, we
3389          * presume it needs http:// prepended (unless a relative
3390          * link starting with /, # or ? or a php file).
3391          */
3392         if ( strpos($url, ':') === false && ! in_array( $url[0], array( '/', '#', '?' ) ) &&
3393                 ! preg_match('/^[a-z0-9-]+?\.php/i', $url) )
3394                 $url = 'http://' . $url;
3395
3396         // Replace ampersands and single quotes only when displaying.
3397         if ( 'display' == $_context ) {
3398                 $url = wp_kses_normalize_entities( $url );
3399                 $url = str_replace( '&amp;', '&#038;', $url );
3400                 $url = str_replace( "'", '&#039;', $url );
3401         }
3402
3403         if ( ( false !== strpos( $url, '[' ) ) || ( false !== strpos( $url, ']' ) ) ) {
3404
3405                 $parsed = wp_parse_url( $url );
3406                 $front  = '';
3407
3408                 if ( isset( $parsed['scheme'] ) ) {
3409                         $front .= $parsed['scheme'] . '://';
3410                 } elseif ( '/' === $url[0] ) {
3411                         $front .= '//';
3412                 }
3413
3414                 if ( isset( $parsed['user'] ) ) {
3415                         $front .= $parsed['user'];
3416                 }
3417
3418                 if ( isset( $parsed['pass'] ) ) {
3419                         $front .= ':' . $parsed['pass'];
3420                 }
3421
3422                 if ( isset( $parsed['user'] ) || isset( $parsed['pass'] ) ) {
3423                         $front .= '@';
3424                 }
3425
3426                 if ( isset( $parsed['host'] ) ) {
3427                         $front .= $parsed['host'];
3428                 }
3429
3430                 if ( isset( $parsed['port'] ) ) {
3431                         $front .= ':' . $parsed['port'];
3432                 }
3433
3434                 $end_dirty = str_replace( $front, '', $url );
3435                 $end_clean = str_replace( array( '[', ']' ), array( '%5B', '%5D' ), $end_dirty );
3436                 $url       = str_replace( $end_dirty, $end_clean, $url );
3437
3438         }
3439
3440         if ( '/' === $url[0] ) {
3441                 $good_protocol_url = $url;
3442         } else {
3443                 if ( ! is_array( $protocols ) )
3444                         $protocols = wp_allowed_protocols();
3445                 $good_protocol_url = wp_kses_bad_protocol( $url, $protocols );
3446                 if ( strtolower( $good_protocol_url ) != strtolower( $url ) )
3447                         return '';
3448         }
3449
3450         /**
3451          * Filter a string cleaned and escaped for output as a URL.
3452          *
3453          * @since 2.3.0
3454          *
3455          * @param string $good_protocol_url The cleaned URL to be returned.
3456          * @param string $original_url      The URL prior to cleaning.
3457          * @param string $_context          If 'display', replace ampersands and single quotes only.
3458          */
3459         return apply_filters( 'clean_url', $good_protocol_url, $original_url, $_context );
3460 }
3461
3462 /**
3463  * Performs esc_url() for database usage.
3464  *
3465  * @since 2.8.0
3466  *
3467  * @param string $url       The URL to be cleaned.
3468  * @param array  $protocols An array of acceptable protocols.
3469  * @return string The cleaned URL.
3470  */
3471 function esc_url_raw( $url, $protocols = null ) {
3472         return esc_url( $url, $protocols, 'db' );
3473 }
3474
3475 /**
3476  * Convert entities, while preserving already-encoded entities.
3477  *
3478  * @link http://www.php.net/htmlentities Borrowed from the PHP Manual user notes.
3479  *
3480  * @since 1.2.2
3481  *
3482  * @param string $myHTML The text to be converted.
3483  * @return string Converted text.
3484  */
3485 function htmlentities2( $myHTML ) {
3486         $translation_table = get_html_translation_table( HTML_ENTITIES, ENT_QUOTES );
3487         $translation_table[chr(38)] = '&';
3488         return preg_replace( "/&(?![A-Za-z]{0,4}\w{2,3};|#[0-9]{2,3};)/", "&amp;", strtr($myHTML, $translation_table) );
3489 }
3490
3491 /**
3492  * Escape single quotes, htmlspecialchar " < > &, and fix line endings.
3493  *
3494  * Escapes text strings for echoing in JS. It is intended to be used for inline JS
3495  * (in a tag attribute, for example onclick="..."). Note that the strings have to
3496  * be in single quotes. The filter 'js_escape' is also applied here.
3497  *
3498  * @since 2.8.0
3499  *
3500  * @param string $text The text to be escaped.
3501  * @return string Escaped text.
3502  */
3503 function esc_js( $text ) {
3504         $safe_text = wp_check_invalid_utf8( $text );
3505         $safe_text = _wp_specialchars( $safe_text, ENT_COMPAT );
3506         $safe_text = preg_replace( '/&#(x)?0*(?(1)27|39);?/i', "'", stripslashes( $safe_text ) );
3507         $safe_text = str_replace( "\r", '', $safe_text );
3508         $safe_text = str_replace( "\n", '\\n', addslashes( $safe_text ) );
3509         /**
3510          * Filter a string cleaned and escaped for output in JavaScript.
3511          *
3512          * Text passed to esc_js() is stripped of invalid or special characters,
3513          * and properly slashed for output.
3514          *
3515          * @since 2.0.6
3516          *
3517          * @param string $safe_text The text after it has been escaped.
3518          * @param string $text      The text prior to being escaped.
3519          */
3520         return apply_filters( 'js_escape', $safe_text, $text );
3521 }
3522
3523 /**
3524  * Escaping for HTML blocks.
3525  *
3526  * @since 2.8.0
3527  *
3528  * @param string $text
3529  * @return string
3530  */
3531 function esc_html( $text ) {
3532         $safe_text = wp_check_invalid_utf8( $text );
3533         $safe_text = _wp_specialchars( $safe_text, ENT_QUOTES );
3534         /**
3535          * Filter a string cleaned and escaped for output in HTML.
3536          *
3537          * Text passed to esc_html() is stripped of invalid or special characters
3538          * before output.
3539          *
3540          * @since 2.8.0
3541          *
3542          * @param string $safe_text The text after it has been escaped.
3543          * @param string $text      The text prior to being escaped.
3544          */
3545         return apply_filters( 'esc_html', $safe_text, $text );
3546 }
3547
3548 /**
3549  * Escaping for HTML attributes.
3550  *
3551  * @since 2.8.0
3552  *
3553  * @param string $text
3554  * @return string
3555  */
3556 function esc_attr( $text ) {
3557         $safe_text = wp_check_invalid_utf8( $text );
3558         $safe_text = _wp_specialchars( $safe_text, ENT_QUOTES );
3559         /**
3560          * Filter a string cleaned and escaped for output in an HTML attribute.
3561          *
3562          * Text passed to esc_attr() is stripped of invalid or special characters
3563          * before output.
3564          *
3565          * @since 2.0.6
3566          *
3567          * @param string $safe_text The text after it has been escaped.
3568          * @param string $text      The text prior to being escaped.
3569          */
3570         return apply_filters( 'attribute_escape', $safe_text, $text );
3571 }
3572
3573 /**
3574  * Escaping for textarea values.
3575  *
3576  * @since 3.1.0
3577  *
3578  * @param string $text
3579  * @return string
3580  */
3581 function esc_textarea( $text ) {
3582         $safe_text = htmlspecialchars( $text, ENT_QUOTES, get_option( 'blog_charset' ) );
3583         /**
3584          * Filter a string cleaned and escaped for output in a textarea element.
3585          *
3586          * @since 3.1.0
3587          *
3588          * @param string $safe_text The text after it has been escaped.
3589          * @param string $text      The text prior to being escaped.
3590          */
3591         return apply_filters( 'esc_textarea', $safe_text, $text );
3592 }
3593
3594 /**
3595  * Escape an HTML tag name.
3596  *
3597  * @since 2.5.0
3598  *
3599  * @param string $tag_name
3600  * @return string
3601  */
3602 function tag_escape( $tag_name ) {
3603         $safe_tag = strtolower( preg_replace('/[^a-zA-Z0-9_:]/', '', $tag_name) );
3604         /**
3605          * Filter a string cleaned and escaped for output as an HTML tag.
3606          *
3607          * @since 2.8.0
3608          *
3609          * @param string $safe_tag The tag name after it has been escaped.
3610          * @param string $tag_name The text before it was escaped.
3611          */
3612         return apply_filters( 'tag_escape', $safe_tag, $tag_name );
3613 }
3614
3615 /**
3616  * Convert full URL paths to absolute paths.
3617  *
3618  * Removes the http or https protocols and the domain. Keeps the path '/' at the
3619  * beginning, so it isn't a true relative link, but from the web root base.
3620  *
3621  * @since 2.1.0
3622  * @since 4.1.0 Support was added for relative URLs.
3623  *
3624  * @param string $link Full URL path.
3625  * @return string Absolute path.
3626  */
3627 function wp_make_link_relative( $link ) {
3628         return preg_replace( '|^(https?:)?//[^/]+(/?.*)|i', '$2', $link );
3629 }
3630
3631 /**
3632  * Sanitises various option values based on the nature of the option.
3633  *
3634  * This is basically a switch statement which will pass $value through a number
3635  * of functions depending on the $option.
3636  *
3637  * @since 2.0.5
3638  *
3639  * @global wpdb $wpdb WordPress database abstraction object.
3640  *
3641  * @param string $option The name of the option.
3642  * @param string $value  The unsanitised value.
3643  * @return string Sanitized value.
3644  */
3645 function sanitize_option( $option, $value ) {
3646         global $wpdb;
3647
3648         $original_value = $value;
3649         $error = '';
3650
3651         switch ( $option ) {
3652                 case 'admin_email' :
3653                 case 'new_admin_email' :
3654                         $value = $wpdb->strip_invalid_text_for_column( $wpdb->options, 'option_value', $value );
3655                         if ( is_wp_error( $value ) ) {
3656                                 $error = $value->get_error_message();
3657                         } else {
3658                                 $value = sanitize_email( $value );
3659                                 if ( ! is_email( $value ) ) {
3660                                         $error = __( 'The email address entered did not appear to be a valid email address. Please enter a valid email address.' );
3661                                 }
3662                         }
3663                         break;
3664
3665                 case 'thumbnail_size_w':
3666                 case 'thumbnail_size_h':
3667                 case 'medium_size_w':
3668                 case 'medium_size_h':
3669                 case 'medium_large_size_w':
3670                 case 'medium_large_size_h':
3671                 case 'large_size_w':
3672                 case 'large_size_h':
3673                 case 'mailserver_port':
3674                 case 'comment_max_links':
3675                 case 'page_on_front':
3676                 case 'page_for_posts':
3677                 case 'rss_excerpt_length':
3678                 case 'default_category':
3679                 case 'default_email_category':
3680                 case 'default_link_category':
3681                 case 'close_comments_days_old':
3682                 case 'comments_per_page':
3683                 case 'thread_comments_depth':
3684                 case 'users_can_register':
3685                 case 'start_of_week':
3686                 case 'site_icon':
3687                         $value = absint( $value );
3688                         break;
3689
3690                 case 'posts_per_page':
3691                 case 'posts_per_rss':
3692                         $value = (int) $value;
3693                         if ( empty($value) )
3694                                 $value = 1;
3695                         if ( $value < -1 )
3696                                 $value = abs($value);
3697                         break;
3698
3699                 case 'default_ping_status':
3700                 case 'default_comment_status':
3701                         // Options that if not there have 0 value but need to be something like "closed"
3702                         if ( $value == '0' || $value == '')
3703                                 $value = 'closed';
3704                         break;
3705
3706                 case 'blogdescription':
3707                 case 'blogname':
3708                         $value = $wpdb->strip_invalid_text_for_column( $wpdb->options, 'option_value', $value );
3709                         if ( is_wp_error( $value ) ) {
3710                                 $error = $value->get_error_message();
3711                         } else {
3712                                 $value = esc_html( $value );
3713                         }
3714                         break;
3715
3716                 case 'blog_charset':
3717                         $value = preg_replace('/[^a-zA-Z0-9_-]/', '', $value); // strips slashes
3718                         break;
3719
3720                 case 'blog_public':
3721                         // This is the value if the settings checkbox is not checked on POST. Don't rely on this.
3722                         if ( null === $value )
3723                                 $value = 1;
3724                         else
3725                                 $value = intval( $value );
3726                         break;
3727
3728                 case 'date_format':
3729                 case 'time_format':
3730                 case 'mailserver_url':
3731                 case 'mailserver_login':
3732                 case 'mailserver_pass':
3733                 case 'upload_path':
3734                         $value = $wpdb->strip_invalid_text_for_column( $wpdb->options, 'option_value', $value );
3735                         if ( is_wp_error( $value ) ) {
3736                                 $error = $value->get_error_message();
3737                         } else {
3738                                 $value = strip_tags( $value );
3739                                 $value = wp_kses_data( $value );
3740                         }
3741                         break;
3742
3743                 case 'ping_sites':
3744                         $value = explode( "\n", $value );
3745                         $value = array_filter( array_map( 'trim', $value ) );
3746                         $value = array_filter( array_map( 'esc_url_raw', $value ) );
3747                         $value = implode( "\n", $value );
3748                         break;
3749
3750                 case 'gmt_offset':
3751                         $value = preg_replace('/[^0-9:.-]/', '', $value); // strips slashes
3752                         break;
3753
3754                 case 'siteurl':
3755                         $value = $wpdb->strip_invalid_text_for_column( $wpdb->options, 'option_value', $value );
3756                         if ( is_wp_error( $value ) ) {
3757                                 $error = $value->get_error_message();
3758                         } else {
3759                                 if ( preg_match( '#http(s?)://(.+)#i', $value ) ) {
3760                                         $value = esc_url_raw( $value );
3761                                 } else {
3762                                         $error = __( 'The WordPress address you entered did not appear to be a valid URL. Please enter a valid URL.' );
3763                                 }
3764                         }
3765                         break;
3766
3767                 case 'home':
3768                         $value = $wpdb->strip_invalid_text_for_column( $wpdb->options, 'option_value', $value );
3769                         if ( is_wp_error( $value ) ) {
3770                                 $error = $value->get_error_message();
3771                         } else {
3772                                 if ( preg_match( '#http(s?)://(.+)#i', $value ) ) {
3773                                         $value = esc_url_raw( $value );
3774                                 } else {
3775                                         $error = __( 'The Site address you entered did not appear to be a valid URL. Please enter a valid URL.' );
3776                                 }
3777                         }
3778                         break;
3779
3780                 case 'WPLANG':
3781                         $allowed = get_available_languages();
3782                         if ( ! is_multisite() && defined( 'WPLANG' ) && '' !== WPLANG && 'en_US' !== WPLANG ) {
3783                                 $allowed[] = WPLANG;
3784                         }
3785                         if ( ! in_array( $value, $allowed ) && ! empty( $value ) ) {
3786                                 $value = get_option( $option );
3787                         }
3788                         break;
3789
3790                 case 'illegal_names':
3791                         $value = $wpdb->strip_invalid_text_for_column( $wpdb->options, 'option_value', $value );
3792                         if ( is_wp_error( $value ) ) {
3793                                 $error = $value->get_error_message();
3794                         } else {
3795                                 if ( ! is_array( $value ) )
3796                                         $value = explode( ' ', $value );
3797
3798                                 $value = array_values( array_filter( array_map( 'trim', $value ) ) );
3799
3800                                 if ( ! $value )
3801                                         $value = '';
3802                         }
3803                         break;
3804
3805                 case 'limited_email_domains':
3806                 case 'banned_email_domains':
3807                         $value = $wpdb->strip_invalid_text_for_column( $wpdb->options, 'option_value', $value );
3808                         if ( is_wp_error( $value ) ) {
3809                                 $error = $value->get_error_message();
3810                         } else {
3811                                 if ( ! is_array( $value ) )
3812                                         $value = explode( "\n", $value );
3813
3814                                 $domains = array_values( array_filter( array_map( 'trim', $value ) ) );
3815                                 $value = array();
3816
3817                                 foreach ( $domains as $domain ) {
3818                                         if ( ! preg_match( '/(--|\.\.)/', $domain ) && preg_match( '|^([a-zA-Z0-9-\.])+$|', $domain ) ) {
3819                                                 $value[] = $domain;
3820                                         }
3821                                 }
3822                                 if ( ! $value )
3823                                         $value = '';
3824                         }
3825                         break;
3826
3827                 case 'timezone_string':
3828                         $allowed_zones = timezone_identifiers_list();
3829                         if ( ! in_array( $value, $allowed_zones ) && ! empty( $value ) ) {
3830                                 $error = __( 'The timezone you have entered is not valid. Please select a valid timezone.' );
3831                         }
3832                         break;
3833
3834                 case 'permalink_structure':
3835                 case 'category_base':
3836                 case 'tag_base':
3837                         $value = $wpdb->strip_invalid_text_for_column( $wpdb->options, 'option_value', $value );
3838                         if ( is_wp_error( $value ) ) {
3839                                 $error = $value->get_error_message();
3840                         } else {
3841                                 $value = esc_url_raw( $value );
3842                                 $value = str_replace( 'http://', '', $value );
3843                         }
3844                         break;
3845
3846                 case 'default_role' :
3847                         if ( ! get_role( $value ) && get_role( 'subscriber' ) )
3848                                 $value = 'subscriber';
3849                         break;
3850
3851                 case 'moderation_keys':
3852                 case 'blacklist_keys':
3853                         $value = $wpdb->strip_invalid_text_for_column( $wpdb->options, 'option_value', $value );
3854                         if ( is_wp_error( $value ) ) {
3855                                 $error = $value->get_error_message();
3856                         } else {
3857                                 $value = explode( "\n", $value );
3858                                 $value = array_filter( array_map( 'trim', $value ) );
3859                                 $value = array_unique( $value );
3860                                 $value = implode( "\n", $value );
3861                         }
3862                         break;
3863         }
3864
3865         if ( ! empty( $error ) ) {
3866                 $value = get_option( $option );
3867                 if ( function_exists( 'add_settings_error' ) ) {
3868                         add_settings_error( $option, "invalid_{$option}", $error );
3869                 }
3870         }
3871
3872         /**
3873          * Filter an option value following sanitization.
3874          *
3875          * @since 2.3.0
3876          * @since 4.3.0 Added the `$original_value` parameter.
3877          *
3878          * @param string $value          The sanitized option value.
3879          * @param string $option         The option name.
3880          * @param string $original_value The original value passed to the function.
3881          */
3882         return apply_filters( "sanitize_option_{$option}", $value, $option, $original_value );
3883 }
3884
3885 /**
3886  * Maps a function to all non-iterable elements of an array or an object.
3887  *
3888  * This is similar to `array_walk_recursive()` but acts upon objects too.
3889  *
3890  * @since 4.4.0
3891  *
3892  * @param mixed    $value    The array, object, or scalar.
3893  * @param callable $callback The function to map onto $value.
3894  * @return mixed The value with the callback applied to all non-arrays and non-objects inside it.
3895  */
3896 function map_deep( $value, $callback ) {
3897         if ( is_array( $value ) ) {
3898                 foreach ( $value as $index => $item ) {
3899                         $value[ $index ] = map_deep( $item, $callback );
3900                 }
3901         } elseif ( is_object( $value ) ) {
3902                 $object_vars = get_object_vars( $value );
3903                 foreach ( $object_vars as $property_name => $property_value ) {
3904                         $value->$property_name = map_deep( $property_value, $callback );
3905                 }
3906         } else {
3907                 $value = call_user_func( $callback, $value );
3908         }
3909
3910         return $value;
3911 }
3912
3913 /**
3914  * Parses a string into variables to be stored in an array.
3915  *
3916  * Uses {@link http://www.php.net/parse_str parse_str()} and stripslashes if
3917  * {@link http://www.php.net/magic_quotes magic_quotes_gpc} is on.
3918  *
3919  * @since 2.2.1
3920  *
3921  * @param string $string The string to be parsed.
3922  * @param array  $array  Variables will be stored in this array.
3923  */
3924 function wp_parse_str( $string, &$array ) {
3925         parse_str( $string, $array );
3926         if ( get_magic_quotes_gpc() )
3927                 $array = stripslashes_deep( $array );
3928         /**
3929          * Filter the array of variables derived from a parsed string.
3930          *
3931          * @since 2.3.0
3932          *
3933          * @param array $array The array populated with variables.
3934          */
3935         $array = apply_filters( 'wp_parse_str', $array );
3936 }
3937
3938 /**
3939  * Convert lone less than signs.
3940  *
3941  * KSES already converts lone greater than signs.
3942  *
3943  * @since 2.3.0
3944  *
3945  * @param string $text Text to be converted.
3946  * @return string Converted text.
3947  */
3948 function wp_pre_kses_less_than( $text ) {
3949         return preg_replace_callback('%<[^>]*?((?=<)|>|$)%', 'wp_pre_kses_less_than_callback', $text);
3950 }
3951
3952 /**
3953  * Callback function used by preg_replace.
3954  *
3955  * @since 2.3.0
3956  *
3957  * @param array $matches Populated by matches to preg_replace.
3958  * @return string The text returned after esc_html if needed.
3959  */
3960 function wp_pre_kses_less_than_callback( $matches ) {
3961         if ( false === strpos($matches[0], '>') )
3962                 return esc_html($matches[0]);
3963         return $matches[0];
3964 }
3965
3966 /**
3967  * WordPress implementation of PHP sprintf() with filters.
3968  *
3969  * @since 2.5.0
3970  * @link http://www.php.net/sprintf
3971  *
3972  * @param string $pattern   The string which formatted args are inserted.
3973  * @param mixed  $args ,... Arguments to be formatted into the $pattern string.
3974  * @return string The formatted string.
3975  */
3976 function wp_sprintf( $pattern ) {
3977         $args = func_get_args();
3978         $len = strlen($pattern);
3979         $start = 0;
3980         $result = '';
3981         $arg_index = 0;
3982         while ( $len > $start ) {
3983                 // Last character: append and break
3984                 if ( strlen($pattern) - 1 == $start ) {
3985                         $result .= substr($pattern, -1);
3986                         break;
3987                 }
3988
3989                 // Literal %: append and continue
3990                 if ( substr($pattern, $start, 2) == '%%' ) {
3991                         $start += 2;
3992                         $result .= '%';
3993                         continue;
3994                 }
3995
3996                 // Get fragment before next %
3997                 $end = strpos($pattern, '%', $start + 1);
3998                 if ( false === $end )
3999                         $end = $len;
4000                 $fragment = substr($pattern, $start, $end - $start);
4001
4002                 // Fragment has a specifier
4003                 if ( $pattern[$start] == '%' ) {
4004                         // Find numbered arguments or take the next one in order
4005                         if ( preg_match('/^%(\d+)\$/', $fragment, $matches) ) {
4006                                 $arg = isset($args[$matches[1]]) ? $args[$matches[1]] : '';
4007                                 $fragment = str_replace("%{$matches[1]}$", '%', $fragment);
4008                         } else {
4009                                 ++$arg_index;
4010                                 $arg = isset($args[$arg_index]) ? $args[$arg_index] : '';
4011                         }
4012
4013                         /**
4014                          * Filter a fragment from the pattern passed to wp_sprintf().
4015                          *
4016                          * If the fragment is unchanged, then sprintf() will be run on the fragment.
4017                          *
4018                          * @since 2.5.0
4019                          *
4020                          * @param string $fragment A fragment from the pattern.
4021                          * @param string $arg      The argument.
4022                          */
4023                         $_fragment = apply_filters( 'wp_sprintf', $fragment, $arg );
4024                         if ( $_fragment != $fragment )
4025                                 $fragment = $_fragment;
4026                         else
4027                                 $fragment = sprintf($fragment, strval($arg) );
4028                 }
4029
4030                 // Append to result and move to next fragment
4031                 $result .= $fragment;
4032                 $start = $end;
4033         }
4034         return $result;
4035 }
4036
4037 /**
4038  * Localize list items before the rest of the content.
4039  *
4040  * The '%l' must be at the first characters can then contain the rest of the
4041  * content. The list items will have ', ', ', and', and ' and ' added depending
4042  * on the amount of list items in the $args parameter.
4043  *
4044  * @since 2.5.0
4045  *
4046  * @param string $pattern Content containing '%l' at the beginning.
4047  * @param array  $args    List items to prepend to the content and replace '%l'.
4048  * @return string Localized list items and rest of the content.
4049  */
4050 function wp_sprintf_l( $pattern, $args ) {
4051         // Not a match
4052         if ( substr($pattern, 0, 2) != '%l' )
4053                 return $pattern;
4054
4055         // Nothing to work with
4056         if ( empty($args) )
4057                 return '';
4058
4059         /**
4060          * Filter the translated delimiters used by wp_sprintf_l().
4061          * Placeholders (%s) are included to assist translators and then
4062          * removed before the array of strings reaches the filter.
4063          *
4064          * Please note: Ampersands and entities should be avoided here.
4065          *
4066          * @since 2.5.0
4067          *
4068          * @param array $delimiters An array of translated delimiters.
4069          */
4070         $l = apply_filters( 'wp_sprintf_l', array(
4071                 /* translators: used to join items in a list with more than 2 items */
4072                 'between'          => sprintf( __('%s, %s'), '', '' ),
4073                 /* translators: used to join last two items in a list with more than 2 times */
4074                 'between_last_two' => sprintf( __('%s, and %s'), '', '' ),
4075                 /* translators: used to join items in a list with only 2 items */
4076                 'between_only_two' => sprintf( __('%s and %s'), '', '' ),
4077         ) );
4078
4079         $args = (array) $args;
4080         $result = array_shift($args);
4081         if ( count($args) == 1 )
4082                 $result .= $l['between_only_two'] . array_shift($args);
4083         // Loop when more than two args
4084         $i = count($args);
4085         while ( $i ) {
4086                 $arg = array_shift($args);
4087                 $i--;
4088                 if ( 0 == $i )
4089                         $result .= $l['between_last_two'] . $arg;
4090                 else
4091                         $result .= $l['between'] . $arg;
4092         }
4093         return $result . substr($pattern, 2);
4094 }
4095
4096 /**
4097  * Safely extracts not more than the first $count characters from html string.
4098  *
4099  * UTF-8, tags and entities safe prefix extraction. Entities inside will *NOT*
4100  * be counted as one character. For example &amp; will be counted as 4, &lt; as
4101  * 3, etc.
4102  *
4103  * @since 2.5.0
4104  *
4105  * @param string $str   String to get the excerpt from.
4106  * @param int    $count Maximum number of characters to take.
4107  * @param string $more  Optional. What to append if $str needs to be trimmed. Defaults to empty string.
4108  * @return string The excerpt.
4109  */
4110 function wp_html_excerpt( $str, $count, $more = null ) {
4111         if ( null === $more )
4112                 $more = '';
4113         $str = wp_strip_all_tags( $str, true );
4114         $excerpt = mb_substr( $str, 0, $count );
4115         // remove part of an entity at the end
4116         $excerpt = preg_replace( '/&[^;\s]{0,6}$/', '', $excerpt );
4117         if ( $str != $excerpt )
4118                 $excerpt = trim( $excerpt ) . $more;
4119         return $excerpt;
4120 }
4121
4122 /**
4123  * Add a Base url to relative links in passed content.
4124  *
4125  * By default it supports the 'src' and 'href' attributes. However this can be
4126  * changed via the 3rd param.
4127  *
4128  * @since 2.7.0
4129  *
4130  * @global string $_links_add_base
4131  *
4132  * @param string $content String to search for links in.
4133  * @param string $base    The base URL to prefix to links.
4134  * @param array  $attrs   The attributes which should be processed.
4135  * @return string The processed content.
4136  */
4137 function links_add_base_url( $content, $base, $attrs = array('src', 'href') ) {
4138         global $_links_add_base;
4139         $_links_add_base = $base;
4140         $attrs = implode('|', (array)$attrs);
4141         return preg_replace_callback( "!($attrs)=(['\"])(.+?)\\2!i", '_links_add_base', $content );
4142 }
4143
4144 /**
4145  * Callback to add a base url to relative links in passed content.
4146  *
4147  * @since 2.7.0
4148  * @access private
4149  *
4150  * @global string $_links_add_base
4151  *
4152  * @param string $m The matched link.
4153  * @return string The processed link.
4154  */
4155 function _links_add_base( $m ) {
4156         global $_links_add_base;
4157         //1 = attribute name  2 = quotation mark  3 = URL
4158         return $m[1] . '=' . $m[2] .
4159                 ( preg_match( '#^(\w{1,20}):#', $m[3], $protocol ) && in_array( $protocol[1], wp_allowed_protocols() ) ?
4160                         $m[3] :
4161                         WP_Http::make_absolute_url( $m[3], $_links_add_base )
4162                 )
4163                 . $m[2];
4164 }
4165
4166 /**
4167  * Adds a Target attribute to all links in passed content.
4168  *
4169  * This function by default only applies to `<a>` tags, however this can be
4170  * modified by the 3rd param.
4171  *
4172  * *NOTE:* Any current target attributed will be stripped and replaced.
4173  *
4174  * @since 2.7.0
4175  *
4176  * @global string $_links_add_target
4177  *
4178  * @param string $content String to search for links in.
4179  * @param string $target  The Target to add to the links.
4180  * @param array  $tags    An array of tags to apply to.
4181  * @return string The processed content.
4182  */
4183 function links_add_target( $content, $target = '_blank', $tags = array('a') ) {
4184         global $_links_add_target;
4185         $_links_add_target = $target;
4186         $tags = implode('|', (array)$tags);
4187         return preg_replace_callback( "!<($tags)([^>]*)>!i", '_links_add_target', $content );
4188 }
4189
4190 /**
4191  * Callback to add a target attribute to all links in passed content.
4192  *
4193  * @since 2.7.0
4194  * @access private
4195  *
4196  * @global string $_links_add_target
4197  *
4198  * @param string $m The matched link.
4199  * @return string The processed link.
4200  */
4201 function _links_add_target( $m ) {
4202         global $_links_add_target;
4203         $tag = $m[1];
4204         $link = preg_replace('|( target=([\'"])(.*?)\2)|i', '', $m[2]);
4205         return '<' . $tag . $link . ' target="' . esc_attr( $_links_add_target ) . '">';
4206 }
4207
4208 /**
4209  * Normalize EOL characters and strip duplicate whitespace.
4210  *
4211  * @since 2.7.0
4212  *
4213  * @param string $str The string to normalize.
4214  * @return string The normalized string.
4215  */
4216 function normalize_whitespace( $str ) {
4217         $str  = trim( $str );
4218         $str  = str_replace( "\r", "\n", $str );
4219         $str  = preg_replace( array( '/\n+/', '/[ \t]+/' ), array( "\n", ' ' ), $str );
4220         return $str;
4221 }
4222
4223 /**
4224  * Properly strip all HTML tags including script and style
4225  *
4226  * This differs from strip_tags() because it removes the contents of
4227  * the `<script>` and `<style>` tags. E.g. `strip_tags( '<script>something</script>' )`
4228  * will return 'something'. wp_strip_all_tags will return ''
4229  *
4230  * @since 2.9.0
4231  *
4232  * @param string $string        String containing HTML tags
4233  * @param bool   $remove_breaks Optional. Whether to remove left over line breaks and white space chars
4234  * @return string The processed string.
4235  */
4236 function wp_strip_all_tags($string, $remove_breaks = false) {
4237         $string = preg_replace( '@<(script|style)[^>]*?>.*?</\\1>@si', '', $string );
4238         $string = strip_tags($string);
4239
4240         if ( $remove_breaks )
4241                 $string = preg_replace('/[\r\n\t ]+/', ' ', $string);
4242
4243         return trim( $string );
4244 }
4245
4246 /**
4247  * Sanitize a string from user input or from the db
4248  *
4249  * check for invalid UTF-8,
4250  * Convert single < characters to entity,
4251  * strip all tags,
4252  * remove line breaks, tabs and extra white space,
4253  * strip octets.
4254  *
4255  * @since 2.9.0
4256  *
4257  * @param string $str
4258  * @return string
4259  */
4260 function sanitize_text_field( $str ) {
4261         $filtered = wp_check_invalid_utf8( $str );
4262
4263         if ( strpos($filtered, '<') !== false ) {
4264                 $filtered = wp_pre_kses_less_than( $filtered );
4265                 // This will strip extra whitespace for us.
4266                 $filtered = wp_strip_all_tags( $filtered, true );
4267         } else {
4268                 $filtered = trim( preg_replace('/[\r\n\t ]+/', ' ', $filtered) );
4269         }
4270
4271         $found = false;
4272         while ( preg_match('/%[a-f0-9]{2}/i', $filtered, $match) ) {
4273                 $filtered = str_replace($match[0], '', $filtered);
4274                 $found = true;
4275         }
4276
4277         if ( $found ) {
4278                 // Strip out the whitespace that may now exist after removing the octets.
4279                 $filtered = trim( preg_replace('/ +/', ' ', $filtered) );
4280         }
4281
4282         /**
4283          * Filter a sanitized text field string.
4284          *
4285          * @since 2.9.0
4286          *
4287          * @param string $filtered The sanitized string.
4288          * @param string $str      The string prior to being sanitized.
4289          */
4290         return apply_filters( 'sanitize_text_field', $filtered, $str );
4291 }
4292
4293 /**
4294  * i18n friendly version of basename()
4295  *
4296  * @since 3.1.0
4297  *
4298  * @param string $path   A path.
4299  * @param string $suffix If the filename ends in suffix this will also be cut off.
4300  * @return string
4301  */
4302 function wp_basename( $path, $suffix = '' ) {
4303         return urldecode( basename( str_replace( array( '%2F', '%5C' ), '/', urlencode( $path ) ), $suffix ) );
4304 }
4305
4306 /**
4307  * Forever eliminate "Wordpress" from the planet (or at least the little bit we can influence).
4308  *
4309  * Violating our coding standards for a good function name.
4310  *
4311  * @since 3.0.0
4312  *
4313  * @staticvar string|false $dblq
4314  *
4315  * @param string $text The text to be modified.
4316  * @return string The modified text.
4317  */
4318 function capital_P_dangit( $text ) {
4319         // Simple replacement for titles
4320         $current_filter = current_filter();
4321         if ( 'the_title' === $current_filter || 'wp_title' === $current_filter )
4322                 return str_replace( 'Wordpress', 'WordPress', $text );
4323         // Still here? Use the more judicious replacement
4324         static $dblq = false;
4325         if ( false === $dblq ) {
4326                 $dblq = _x( '&#8220;', 'opening curly double quote' );
4327         }
4328         return str_replace(
4329                 array( ' Wordpress', '&#8216;Wordpress', $dblq . 'Wordpress', '>Wordpress', '(Wordpress' ),
4330                 array( ' WordPress', '&#8216;WordPress', $dblq . 'WordPress', '>WordPress', '(WordPress' ),
4331         $text );
4332 }
4333
4334 /**
4335  * Sanitize a mime type
4336  *
4337  * @since 3.1.3
4338  *
4339  * @param string $mime_type Mime type
4340  * @return string Sanitized mime type
4341  */
4342 function sanitize_mime_type( $mime_type ) {
4343         $sani_mime_type = preg_replace( '/[^-+*.a-zA-Z0-9\/]/', '', $mime_type );
4344         /**
4345          * Filter a mime type following sanitization.
4346          *
4347          * @since 3.1.3
4348          *
4349          * @param string $sani_mime_type The sanitized mime type.
4350          * @param string $mime_type      The mime type prior to sanitization.
4351          */
4352         return apply_filters( 'sanitize_mime_type', $sani_mime_type, $mime_type );
4353 }
4354
4355 /**
4356  * Sanitize space or carriage return separated URLs that are used to send trackbacks.
4357  *
4358  * @since 3.4.0
4359  *
4360  * @param string $to_ping Space or carriage return separated URLs
4361  * @return string URLs starting with the http or https protocol, separated by a carriage return.
4362  */
4363 function sanitize_trackback_urls( $to_ping ) {
4364         $urls_to_ping = preg_split( '/[\r\n\t ]/', trim( $to_ping ), -1, PREG_SPLIT_NO_EMPTY );
4365         foreach ( $urls_to_ping as $k => $url ) {
4366                 if ( !preg_match( '#^https?://.#i', $url ) )
4367                         unset( $urls_to_ping[$k] );
4368         }
4369         $urls_to_ping = array_map( 'esc_url_raw', $urls_to_ping );
4370         $urls_to_ping = implode( "\n", $urls_to_ping );
4371         /**
4372          * Filter a list of trackback URLs following sanitization.
4373          *
4374          * The string returned here consists of a space or carriage return-delimited list
4375          * of trackback URLs.
4376          *
4377          * @since 3.4.0
4378          *
4379          * @param string $urls_to_ping Sanitized space or carriage return separated URLs.
4380          * @param string $to_ping      Space or carriage return separated URLs before sanitization.
4381          */
4382         return apply_filters( 'sanitize_trackback_urls', $urls_to_ping, $to_ping );
4383 }
4384
4385 /**
4386  * Add slashes to a string or array of strings.
4387  *
4388  * This should be used when preparing data for core API that expects slashed data.
4389  * This should not be used to escape data going directly into an SQL query.
4390  *
4391  * @since 3.6.0
4392  *
4393  * @param string|array $value String or array of strings to slash.
4394  * @return string|array Slashed $value
4395  */
4396 function wp_slash( $value ) {
4397         if ( is_array( $value ) ) {
4398                 foreach ( $value as $k => $v ) {
4399                         if ( is_array( $v ) ) {
4400                                 $value[$k] = wp_slash( $v );
4401                         } else {
4402                                 $value[$k] = addslashes( $v );
4403                         }
4404                 }
4405         } else {
4406                 $value = addslashes( $value );
4407         }
4408
4409         return $value;
4410 }
4411
4412 /**
4413  * Remove slashes from a string or array of strings.
4414  *
4415  * This should be used to remove slashes from data passed to core API that
4416  * expects data to be unslashed.
4417  *
4418  * @since 3.6.0
4419  *
4420  * @param string|array $value String or array of strings to unslash.
4421  * @return string|array Unslashed $value
4422  */
4423 function wp_unslash( $value ) {
4424         return stripslashes_deep( $value );
4425 }
4426
4427 /**
4428  * Extract and return the first URL from passed content.
4429  *
4430  * @since 3.6.0
4431  *
4432  * @param string $content A string which might contain a URL.
4433  * @return string|false The found URL.
4434  */
4435 function get_url_in_content( $content ) {
4436         if ( empty( $content ) ) {
4437                 return false;
4438         }
4439
4440         if ( preg_match( '/<a\s[^>]*?href=([\'"])(.+?)\1/is', $content, $matches ) ) {
4441                 return esc_url_raw( $matches[2] );
4442         }
4443
4444         return false;
4445 }
4446
4447 /**
4448  * Returns the regexp for common whitespace characters.
4449  *
4450  * By default, spaces include new lines, tabs, nbsp entities, and the UTF-8 nbsp.
4451  * This is designed to replace the PCRE \s sequence.  In ticket #22692, that
4452  * sequence was found to be unreliable due to random inclusion of the A0 byte.
4453  *
4454  * @since 4.0.0
4455  *
4456  * @staticvar string $spaces
4457  *
4458  * @return string The spaces regexp.
4459  */
4460 function wp_spaces_regexp() {
4461         static $spaces = '';
4462
4463         if ( empty( $spaces ) ) {
4464                 /**
4465                  * Filter the regexp for common whitespace characters.
4466                  *
4467                  * This string is substituted for the \s sequence as needed in regular
4468                  * expressions. For websites not written in English, different characters
4469                  * may represent whitespace. For websites not encoded in UTF-8, the 0xC2 0xA0
4470                  * sequence may not be in use.
4471                  *
4472                  * @since 4.0.0
4473                  *
4474                  * @param string $spaces Regexp pattern for matching common whitespace characters.
4475                  */
4476                 $spaces = apply_filters( 'wp_spaces_regexp', '[\r\n\t ]|\xC2\xA0|&nbsp;' );
4477         }
4478
4479         return $spaces;
4480 }
4481
4482 /**
4483  * Print the important emoji-related styles.
4484  *
4485  * @since 4.2.0
4486  *
4487  * @staticvar bool $printed
4488  */
4489 function print_emoji_styles() {
4490         static $printed = false;
4491
4492         if ( $printed ) {
4493                 return;
4494         }
4495
4496         $printed = true;
4497 ?>
4498 <style type="text/css">
4499 img.wp-smiley,
4500 img.emoji {
4501         display: inline !important;
4502         border: none !important;
4503         box-shadow: none !important;
4504         height: 1em !important;
4505         width: 1em !important;
4506         margin: 0 .07em !important;
4507         vertical-align: -0.1em !important;
4508         background: none !important;
4509         padding: 0 !important;
4510 }
4511 </style>
4512 <?php
4513 }
4514
4515 /**
4516  *
4517  * @global string $wp_version
4518  * @staticvar bool $printed
4519  */
4520 function print_emoji_detection_script() {
4521         global $wp_version;
4522         static $printed = false;
4523
4524         if ( $printed ) {
4525                 return;
4526         }
4527
4528         $printed = true;
4529
4530         $settings = array(
4531                 /**
4532                  * Filter the URL where emoji images are hosted.
4533                  *
4534                  * @since 4.2.0
4535                  *
4536                  * @param string The emoji base URL.
4537                  */
4538                 'baseUrl' => apply_filters( 'emoji_url', 'https://s.w.org/images/core/emoji/72x72/' ),
4539
4540                 /**
4541                  * Filter the extension of the emoji files.
4542                  *
4543                  * @since 4.2.0
4544                  *
4545                  * @param string The emoji extension. Default .png.
4546                  */
4547                 'ext' => apply_filters( 'emoji_ext', '.png' ),
4548         );
4549
4550         $version = 'ver=' . $wp_version;
4551
4552         if ( SCRIPT_DEBUG ) {
4553                 $settings['source'] = array(
4554                         /** This filter is documented in wp-includes/class.wp-scripts.php */
4555                         'wpemoji' => apply_filters( 'script_loader_src', includes_url( "js/wp-emoji.js?$version" ), 'wpemoji' ),
4556                         /** This filter is documented in wp-includes/class.wp-scripts.php */
4557                         'twemoji' => apply_filters( 'script_loader_src', includes_url( "js/twemoji.js?$version" ), 'twemoji' ),
4558                 );
4559
4560                 ?>
4561                 <script type="text/javascript">
4562                         window._wpemojiSettings = <?php echo wp_json_encode( $settings ); ?>;
4563                         <?php readfile( ABSPATH . WPINC . "/js/wp-emoji-loader.js" ); ?>
4564                 </script>
4565                 <?php
4566         } else {
4567                 $settings['source'] = array(
4568                         /** This filter is documented in wp-includes/class.wp-scripts.php */
4569                         'concatemoji' => apply_filters( 'script_loader_src', includes_url( "js/wp-emoji-release.min.js?$version" ), 'concatemoji' ),
4570                 );
4571
4572                 /*
4573                  * If you're looking at a src version of this file, you'll see an "include"
4574                  * statement below. This is used by the `grunt build` process to directly
4575                  * include a minified version of wp-emoji-loader.js, instead of using the
4576                  * readfile() method from above.
4577                  *
4578                  * If you're looking at a build version of this file, you'll see a string of
4579                  * minified JavaScript. If you need to debug it, please turn on SCRIPT_DEBUG
4580                  * and edit wp-emoji-loader.js directly.
4581                  */
4582                 ?>
4583                 <script type="text/javascript">
4584                         window._wpemojiSettings = <?php echo wp_json_encode( $settings ); ?>;
4585                         !function(a,b,c){function d(a){var c,d,e,f=b.createElement("canvas"),g=f.getContext&&f.getContext("2d"),h=String.fromCharCode;if(!g||!g.fillText)return!1;switch(g.textBaseline="top",g.font="600 32px Arial",a){case"flag":return g.fillText(h(55356,56806,55356,56826),0,0),f.toDataURL().length>3e3;case"diversity":return g.fillText(h(55356,57221),0,0),c=g.getImageData(16,16,1,1).data,d=c[0]+","+c[1]+","+c[2]+","+c[3],g.fillText(h(55356,57221,55356,57343),0,0),c=g.getImageData(16,16,1,1).data,e=c[0]+","+c[1]+","+c[2]+","+c[3],d!==e;case"simple":return g.fillText(h(55357,56835),0,0),0!==g.getImageData(16,16,1,1).data[0];case"unicode8":return g.fillText(h(55356,57135),0,0),0!==g.getImageData(16,16,1,1).data[0]}return!1}function e(a){var c=b.createElement("script");c.src=a,c.type="text/javascript",b.getElementsByTagName("head")[0].appendChild(c)}var f,g,h,i;for(i=Array("simple","flag","unicode8","diversity"),c.supports={everything:!0,everythingExceptFlag:!0},h=0;h<i.length;h++)c.supports[i[h]]=d(i[h]),c.supports.everything=c.supports.everything&&c.supports[i[h]],"flag"!==i[h]&&(c.supports.everythingExceptFlag=c.supports.everythingExceptFlag&&c.supports[i[h]]);c.supports.everythingExceptFlag=c.supports.everythingExceptFlag&&!c.supports.flag,c.DOMReady=!1,c.readyCallback=function(){c.DOMReady=!0},c.supports.everything||(g=function(){c.readyCallback()},b.addEventListener?(b.addEventListener("DOMContentLoaded",g,!1),a.addEventListener("load",g,!1)):(a.attachEvent("onload",g),b.attachEvent("onreadystatechange",function(){"complete"===b.readyState&&c.readyCallback()})),f=c.source||{},f.concatemoji?e(f.concatemoji):f.wpemoji&&f.twemoji&&(e(f.twemoji),e(f.wpemoji)))}(window,document,window._wpemojiSettings);
4586                 </script>
4587                 <?php
4588         }
4589 }
4590
4591 /**
4592  * Convert any 4 byte emoji in a string to their equivalent HTML entity.
4593  *
4594  * Currently, only Unicode 7 emoji are supported. Skin tone modifiers are allowed,
4595  * all other Unicode 8 emoji will be added when the spec is finalised.
4596  *
4597  * This allows us to store emoji in a DB using the utf8 character set.
4598  *
4599  * @since 4.2.0
4600  *
4601  * @param string $content The content to encode.
4602  * @return string The encoded content.
4603  */
4604 function wp_encode_emoji( $content ) {
4605         if ( function_exists( 'mb_convert_encoding' ) ) {
4606                 $regex = '/(
4607                      \x23\xE2\x83\xA3               # Digits
4608                      [\x30-\x39]\xE2\x83\xA3
4609                    | \xF0\x9F[\x85-\x88][\xA6-\xBF] # Enclosed characters
4610                    | \xF0\x9F[\x8C-\x97][\x80-\xBF] # Misc
4611                    | \xF0\x9F\x98[\x80-\xBF]        # Smilies
4612                    | \xF0\x9F\x99[\x80-\x8F]
4613                    | \xF0\x9F\x9A[\x80-\xBF]        # Transport and map symbols
4614                 )/x';
4615
4616                 $matches = array();
4617                 if ( preg_match_all( $regex, $content, $matches ) ) {
4618                         if ( ! empty( $matches[1] ) ) {
4619                                 foreach ( $matches[1] as $emoji ) {
4620                                         /*
4621                                          * UTF-32's hex encoding is the same as HTML's hex encoding.
4622                                          * So, by converting the emoji from UTF-8 to UTF-32, we magically
4623                                          * get the correct hex encoding.
4624                                          */
4625                                         $unpacked = unpack( 'H*', mb_convert_encoding( $emoji, 'UTF-32', 'UTF-8' ) );
4626                                         if ( isset( $unpacked[1] ) ) {
4627                                                 $entity = '&#x' . ltrim( $unpacked[1], '0' ) . ';';
4628                                                 $content = str_replace( $emoji, $entity, $content );
4629                                         }
4630                                 }
4631                         }
4632                 }
4633         }
4634
4635         return $content;
4636 }
4637
4638 /**
4639  * Convert emoji to a static img element.
4640  *
4641  * @since 4.2.0
4642  *
4643  * @param string $text The content to encode.
4644  * @return string The encoded content.
4645  */
4646 function wp_staticize_emoji( $text ) {
4647         $text = wp_encode_emoji( $text );
4648
4649         /** This filter is documented in wp-includes/formatting.php */
4650         $cdn_url = apply_filters( 'emoji_url', 'https://s.w.org/images/core/emoji/72x72/' );
4651
4652         /** This filter is documented in wp-includes/formatting.php */
4653         $ext = apply_filters( 'emoji_ext', '.png' );
4654
4655         $output = '';
4656         /*
4657          * HTML loop taken from smiley function, which was taken from texturize function.
4658          * It'll never be consolidated.
4659          *
4660          * First, capture the tags as well as in between.
4661          */
4662         $textarr = preg_split( '/(<.*>)/U', $text, -1, PREG_SPLIT_DELIM_CAPTURE );
4663         $stop = count( $textarr );
4664
4665         // Ignore processing of specific tags.
4666         $tags_to_ignore = 'code|pre|style|script|textarea';
4667         $ignore_block_element = '';
4668
4669         for ( $i = 0; $i < $stop; $i++ ) {
4670                 $content = $textarr[$i];
4671
4672                 // If we're in an ignore block, wait until we find its closing tag.
4673                 if ( '' == $ignore_block_element && preg_match( '/^<(' . $tags_to_ignore . ')>/', $content, $matches ) )  {
4674                         $ignore_block_element = $matches[1];
4675                 }
4676
4677                 // If it's not a tag and not in ignore block.
4678                 if ( '' ==  $ignore_block_element && strlen( $content ) > 0 && '<' != $content[0] ) {
4679                         $matches = array();
4680                         if ( preg_match_all( '/(&#x1f1(e[6-9a-f]|f[0-9a-f]);){2}/', $content, $matches ) ) {
4681                                 if ( ! empty( $matches[0] ) ) {
4682                                         foreach ( $matches[0] as $flag ) {
4683                                                 $chars = str_replace( array( '&#x', ';'), '', $flag );
4684
4685                                                 list( $char1, $char2 ) = str_split( $chars, 5 );
4686                                                 $entity = sprintf( '<img src="%s" alt="%s" class="wp-smiley" style="height: 1em; max-height: 1em;" />', $cdn_url . $char1 . '-' . $char2 . $ext, html_entity_decode( $flag ) );
4687
4688                                                 $content = str_replace( $flag, $entity, $content );
4689                                         }
4690                                 }
4691                         }
4692
4693                         // Loosely match the Emoji Unicode range.
4694                         $regex = '/(&#x[2-3][0-9a-f]{3};|&#x1f[1-6][0-9a-f]{2};)/';
4695
4696                         $matches = array();
4697                         if ( preg_match_all( $regex, $content, $matches ) ) {
4698                                 if ( ! empty( $matches[1] ) ) {
4699                                         foreach ( $matches[1] as $emoji ) {
4700                                                 $char = str_replace( array( '&#x', ';'), '', $emoji );
4701                                                 $entity = sprintf( '<img src="%s" alt="%s" class="wp-smiley" style="height: 1em; max-height: 1em;" />', $cdn_url . $char . $ext, html_entity_decode( $emoji ) );
4702
4703                                                 $content = str_replace( $emoji, $entity, $content );
4704                                         }
4705                                 }
4706                         }
4707                 }
4708
4709                 // Did we exit ignore block.
4710                 if ( '' != $ignore_block_element && '</' . $ignore_block_element . '>' == $content )  {
4711                         $ignore_block_element = '';
4712                 }
4713
4714                 $output .= $content;
4715         }
4716
4717         return $output;
4718 }
4719
4720 /**
4721  * Convert emoji in emails into static images.
4722  *
4723  * @since 4.2.0
4724  *
4725  * @param array $mail The email data array.
4726  * @return array The email data array, with emoji in the message staticized.
4727  */
4728 function wp_staticize_emoji_for_email( $mail ) {
4729         if ( ! isset( $mail['message'] ) ) {
4730                 return $mail;
4731         }
4732
4733         /*
4734          * We can only transform the emoji into images if it's a text/html email.
4735          * To do that, here's a cut down version of the same process that happens
4736          * in wp_mail() - get the Content-Type from the headers, if there is one,
4737          * then pass it through the wp_mail_content_type filter, in case a plugin
4738          * is handling changing the Content-Type.
4739          */
4740         $headers = array();
4741         if ( isset( $mail['headers'] ) ) {
4742                 if ( is_array( $mail['headers'] ) ) {
4743                         $headers = $mail['headers'];
4744                 } else {
4745                         $headers = explode( "\n", str_replace( "\r\n", "\n", $mail['headers'] ) );
4746                 }
4747         }
4748
4749         foreach ( $headers as $header ) {
4750                 if ( strpos($header, ':') === false ) {
4751                         continue;
4752                 }
4753
4754                 // Explode them out.
4755                 list( $name, $content ) = explode( ':', trim( $header ), 2 );
4756
4757                 // Cleanup crew.
4758                 $name    = trim( $name    );
4759                 $content = trim( $content );
4760
4761                 if ( 'content-type' === strtolower( $name ) ) {
4762                         if ( strpos( $content, ';' ) !== false ) {
4763                                 list( $type, $charset ) = explode( ';', $content );
4764                                 $content_type = trim( $type );
4765                         } else {
4766                                 $content_type = trim( $content );
4767                         }
4768                         break;
4769                 }
4770         }
4771
4772         // Set Content-Type if we don't have a content-type from the input headers.
4773         if ( ! isset( $content_type ) ) {
4774                 $content_type = 'text/plain';
4775         }
4776
4777         /** This filter is documented in wp-includes/pluggable.php */
4778         $content_type = apply_filters( 'wp_mail_content_type', $content_type );
4779
4780         if ( 'text/html' === $content_type ) {
4781                 $mail['message'] = wp_staticize_emoji( $mail['message'] );
4782         }
4783
4784         return $mail;
4785 }
4786
4787 /**
4788  * Shorten a URL, to be used as link text.
4789  *
4790  * @since 1.2.0
4791  * @since 4.4.0 Moved to wp-includes/formatting.php from wp-admin/includes/misc.php and added $length param.
4792  *
4793  * @param string $url    URL to shorten.
4794  * @param int    $length Optional. Maximum length of the shortened URL. Default 35 characters.
4795  * @return string Shortened URL.
4796  */
4797 function url_shorten( $url, $length = 35 ) {
4798         $stripped = str_replace( array( 'https://', 'http://', 'www.' ), '', $url );
4799         $short_url = untrailingslashit( $stripped );
4800
4801         if ( strlen( $short_url ) > $length ) {
4802                 $short_url = substr( $short_url, 0, $length - 3 ) . '&hellip;';
4803         }
4804         return $short_url;
4805 }