1f4a8638d4ef734f86a86492d643dca9b9c75550
[autoinstalls/wordpress.git] / 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 ( '/' !== $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         $title = preg_replace('/&.+?;/', '', $title); // kill entities
1588         $title = str_replace('.', '-', $title);
1589
1590         if ( 'save' == $context ) {
1591                 // Convert nbsp, ndash and mdash to hyphens
1592                 $title = str_replace( array( '%c2%a0', '%e2%80%93', '%e2%80%94' ), '-', $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('/[^%a-z0-9 _-]/', '', $title);
1616         $title = preg_replace('/\s+/', '-', $title);
1617         $title = preg_replace('|-+|', '-', $title);
1618         $title = trim($title, '-');
1619
1620         return $title;
1621 }
1622
1623 /**
1624  * Ensures a string is a valid SQL 'order by' clause.
1625  *
1626  * Accepts one or more columns, with or without a sort order (ASC / DESC).
1627  * e.g. 'column_1', 'column_1, column_2', 'column_1 ASC, column_2 DESC' etc.
1628  *
1629  * Also accepts 'RAND()'.
1630  *
1631  * @since 2.5.1
1632  *
1633  * @param string $orderby Order by clause to be validated.
1634  * @return string|false Returns $orderby if valid, false otherwise.
1635  */
1636 function sanitize_sql_orderby( $orderby ) {
1637         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 ) ) {
1638                 return $orderby;
1639         }
1640         return false;
1641 }
1642
1643 /**
1644  * Sanitizes an HTML classname to ensure it only contains valid characters.
1645  *
1646  * Strips the string down to A-Z,a-z,0-9,_,-. If this results in an empty
1647  * string then it will return the alternative value supplied.
1648  *
1649  * @todo Expand to support the full range of CDATA that a class attribute can contain.
1650  *
1651  * @since 2.8.0
1652  *
1653  * @param string $class    The classname to be sanitized
1654  * @param string $fallback Optional. The value to return if the sanitization ends up as an empty string.
1655  *      Defaults to an empty string.
1656  * @return string The sanitized value
1657  */
1658 function sanitize_html_class( $class, $fallback = '' ) {
1659         //Strip out any % encoded octets
1660         $sanitized = preg_replace( '|%[a-fA-F0-9][a-fA-F0-9]|', '', $class );
1661
1662         //Limit to A-Z,a-z,0-9,_,-
1663         $sanitized = preg_replace( '/[^A-Za-z0-9_-]/', '', $sanitized );
1664
1665         if ( '' == $sanitized && $fallback ) {
1666                 return sanitize_html_class( $fallback );
1667         }
1668         /**
1669          * Filter a sanitized HTML class string.
1670          *
1671          * @since 2.8.0
1672          *
1673          * @param string $sanitized The sanitized HTML class.
1674          * @param string $class     HTML class before sanitization.
1675          * @param string $fallback  The fallback string.
1676          */
1677         return apply_filters( 'sanitize_html_class', $sanitized, $class, $fallback );
1678 }
1679
1680 /**
1681  * Converts lone & characters into `&#038;` (a.k.a. `&amp;`)
1682  *
1683  * @since 0.71
1684  *
1685  * @param string $content    String of characters to be converted.
1686  * @param string $deprecated Not used.
1687  * @return string Converted string.
1688  */
1689 function convert_chars( $content, $deprecated = '' ) {
1690         if ( ! empty( $deprecated ) ) {
1691                 _deprecated_argument( __FUNCTION__, '0.71' );
1692         }
1693
1694         if ( strpos( $content, '&' ) !== false ) {
1695                 $content = preg_replace( '/&([^#])(?![a-z1-4]{1,8};)/i', '&#038;$1', $content );
1696         }
1697
1698         return $content;
1699 }
1700
1701 /**
1702  * Converts invalid Unicode references range to valid range.
1703  *
1704  * @since 4.3.0
1705  *
1706  * @param string $content String with entities that need converting.
1707  * @return string Converted string.
1708  */
1709 function convert_invalid_entities( $content ) {
1710         $wp_htmltranswinuni = array(
1711                 '&#128;' => '&#8364;', // the Euro sign
1712                 '&#129;' => '',
1713                 '&#130;' => '&#8218;', // these are Windows CP1252 specific characters
1714                 '&#131;' => '&#402;',  // they would look weird on non-Windows browsers
1715                 '&#132;' => '&#8222;',
1716                 '&#133;' => '&#8230;',
1717                 '&#134;' => '&#8224;',
1718                 '&#135;' => '&#8225;',
1719                 '&#136;' => '&#710;',
1720                 '&#137;' => '&#8240;',
1721                 '&#138;' => '&#352;',
1722                 '&#139;' => '&#8249;',
1723                 '&#140;' => '&#338;',
1724                 '&#141;' => '',
1725                 '&#142;' => '&#381;',
1726                 '&#143;' => '',
1727                 '&#144;' => '',
1728                 '&#145;' => '&#8216;',
1729                 '&#146;' => '&#8217;',
1730                 '&#147;' => '&#8220;',
1731                 '&#148;' => '&#8221;',
1732                 '&#149;' => '&#8226;',
1733                 '&#150;' => '&#8211;',
1734                 '&#151;' => '&#8212;',
1735                 '&#152;' => '&#732;',
1736                 '&#153;' => '&#8482;',
1737                 '&#154;' => '&#353;',
1738                 '&#155;' => '&#8250;',
1739                 '&#156;' => '&#339;',
1740                 '&#157;' => '',
1741                 '&#158;' => '&#382;',
1742                 '&#159;' => '&#376;'
1743         );
1744
1745         if ( strpos( $content, '&#1' ) !== false ) {
1746                 $content = strtr( $content, $wp_htmltranswinuni );
1747         }
1748
1749         return $content;
1750 }
1751
1752 /**
1753  * Balances tags if forced to, or if the 'use_balanceTags' option is set to true.
1754  *
1755  * @since 0.71
1756  *
1757  * @param string $text  Text to be balanced
1758  * @param bool   $force If true, forces balancing, ignoring the value of the option. Default false.
1759  * @return string Balanced text
1760  */
1761 function balanceTags( $text, $force = false ) {
1762         if ( $force || get_option('use_balanceTags') == 1 ) {
1763                 return force_balance_tags( $text );
1764         } else {
1765                 return $text;
1766         }
1767 }
1768
1769 /**
1770  * Balances tags of string using a modified stack.
1771  *
1772  * @since 2.0.4
1773  *
1774  * @author Leonard Lin <leonard@acm.org>
1775  * @license GPL
1776  * @copyright November 4, 2001
1777  * @version 1.1
1778  * @todo Make better - change loop condition to $text in 1.2
1779  * @internal Modified by Scott Reilly (coffee2code) 02 Aug 2004
1780  *              1.1  Fixed handling of append/stack pop order of end text
1781  *                       Added Cleaning Hooks
1782  *              1.0  First Version
1783  *
1784  * @param string $text Text to be balanced.
1785  * @return string Balanced text.
1786  */
1787 function force_balance_tags( $text ) {
1788         $tagstack = array();
1789         $stacksize = 0;
1790         $tagqueue = '';
1791         $newtext = '';
1792         // Known single-entity/self-closing tags
1793         $single_tags = array( 'area', 'base', 'basefont', 'br', 'col', 'command', 'embed', 'frame', 'hr', 'img', 'input', 'isindex', 'link', 'meta', 'param', 'source' );
1794         // Tags that can be immediately nested within themselves
1795         $nestable_tags = array( 'blockquote', 'div', 'object', 'q', 'span' );
1796
1797         // WP bug fix for comments - in case you REALLY meant to type '< !--'
1798         $text = str_replace('< !--', '<    !--', $text);
1799         // WP bug fix for LOVE <3 (and other situations with '<' before a number)
1800         $text = preg_replace('#<([0-9]{1})#', '&lt;$1', $text);
1801
1802         while ( preg_match("/<(\/?[\w:]*)\s*([^>]*)>/", $text, $regex) ) {
1803                 $newtext .= $tagqueue;
1804
1805                 $i = strpos($text, $regex[0]);
1806                 $l = strlen($regex[0]);
1807
1808                 // clear the shifter
1809                 $tagqueue = '';
1810                 // Pop or Push
1811                 if ( isset($regex[1][0]) && '/' == $regex[1][0] ) { // End Tag
1812                         $tag = strtolower(substr($regex[1],1));
1813                         // if too many closing tags
1814                         if ( $stacksize <= 0 ) {
1815                                 $tag = '';
1816                                 // or close to be safe $tag = '/' . $tag;
1817                         }
1818                         // if stacktop value = tag close value then pop
1819                         elseif ( $tagstack[$stacksize - 1] == $tag ) { // found closing tag
1820                                 $tag = '</' . $tag . '>'; // Close Tag
1821                                 // Pop
1822                                 array_pop( $tagstack );
1823                                 $stacksize--;
1824                         } else { // closing tag not at top, search for it
1825                                 for ( $j = $stacksize-1; $j >= 0; $j-- ) {
1826                                         if ( $tagstack[$j] == $tag ) {
1827                                         // add tag to tagqueue
1828                                                 for ( $k = $stacksize-1; $k >= $j; $k--) {
1829                                                         $tagqueue .= '</' . array_pop( $tagstack ) . '>';
1830                                                         $stacksize--;
1831                                                 }
1832                                                 break;
1833                                         }
1834                                 }
1835                                 $tag = '';
1836                         }
1837                 } else { // Begin Tag
1838                         $tag = strtolower($regex[1]);
1839
1840                         // Tag Cleaning
1841
1842                         // If it's an empty tag "< >", do nothing
1843                         if ( '' == $tag ) {
1844                                 // do nothing
1845                         }
1846                         // ElseIf it presents itself as a self-closing tag...
1847                         elseif ( substr( $regex[2], -1 ) == '/' ) {
1848                                 // ...but it isn't a known single-entity self-closing tag, then don't let it be treated as such and
1849                                 // immediately close it with a closing tag (the tag will encapsulate no text as a result)
1850                                 if ( ! in_array( $tag, $single_tags ) )
1851                                         $regex[2] = trim( substr( $regex[2], 0, -1 ) ) . "></$tag";
1852                         }
1853                         // ElseIf it's a known single-entity tag but it doesn't close itself, do so
1854                         elseif ( in_array($tag, $single_tags) ) {
1855                                 $regex[2] .= '/';
1856                         }
1857                         // Else it's not a single-entity tag
1858                         else {
1859                                 // If the top of the stack is the same as the tag we want to push, close previous tag
1860                                 if ( $stacksize > 0 && !in_array($tag, $nestable_tags) && $tagstack[$stacksize - 1] == $tag ) {
1861                                         $tagqueue = '</' . array_pop( $tagstack ) . '>';
1862                                         $stacksize--;
1863                                 }
1864                                 $stacksize = array_push( $tagstack, $tag );
1865                         }
1866
1867                         // Attributes
1868                         $attributes = $regex[2];
1869                         if ( ! empty( $attributes ) && $attributes[0] != '>' )
1870                                 $attributes = ' ' . $attributes;
1871
1872                         $tag = '<' . $tag . $attributes . '>';
1873                         //If already queuing a close tag, then put this tag on, too
1874                         if ( !empty($tagqueue) ) {
1875                                 $tagqueue .= $tag;
1876                                 $tag = '';
1877                         }
1878                 }
1879                 $newtext .= substr($text, 0, $i) . $tag;
1880                 $text = substr($text, $i + $l);
1881         }
1882
1883         // Clear Tag Queue
1884         $newtext .= $tagqueue;
1885
1886         // Add Remaining text
1887         $newtext .= $text;
1888
1889         // Empty Stack
1890         while( $x = array_pop($tagstack) )
1891                 $newtext .= '</' . $x . '>'; // Add remaining tags to close
1892
1893         // WP fix for the bug with HTML comments
1894         $newtext = str_replace("< !--","<!--",$newtext);
1895         $newtext = str_replace("<    !--","< !--",$newtext);
1896
1897         return $newtext;
1898 }
1899
1900 /**
1901  * Acts on text which is about to be edited.
1902  *
1903  * The $content is run through esc_textarea(), which uses htmlspecialchars()
1904  * to convert special characters to HTML entities. If $richedit is set to true,
1905  * it is simply a holder for the 'format_to_edit' filter.
1906  *
1907  * @since 0.71
1908  * @since 4.4.0 The `$richedit` parameter was renamed to `$rich_text` for clarity.
1909  *
1910  * @param string $content   The text about to be edited.
1911  * @param bool   $rich_text Optional. Whether `$content` should be considered rich text,
1912  *                          in which case it would not be passed through esc_textarea().
1913  *                          Default false.
1914  * @return string The text after the filter (and possibly htmlspecialchars()) has been run.
1915  */
1916 function format_to_edit( $content, $rich_text = false ) {
1917         /**
1918          * Filter the text to be formatted for editing.
1919          *
1920          * @since 1.2.0
1921          *
1922          * @param string $content The text, prior to formatting for editing.
1923          */
1924         $content = apply_filters( 'format_to_edit', $content );
1925         if ( ! $rich_text )
1926                 $content = esc_textarea( $content );
1927         return $content;
1928 }
1929
1930 /**
1931  * Add leading zeros when necessary.
1932  *
1933  * If you set the threshold to '4' and the number is '10', then you will get
1934  * back '0010'. If you set the threshold to '4' and the number is '5000', then you
1935  * will get back '5000'.
1936  *
1937  * Uses sprintf to append the amount of zeros based on the $threshold parameter
1938  * and the size of the number. If the number is large enough, then no zeros will
1939  * be appended.
1940  *
1941  * @since 0.71
1942  *
1943  * @param int $number     Number to append zeros to if not greater than threshold.
1944  * @param int $threshold  Digit places number needs to be to not have zeros added.
1945  * @return string Adds leading zeros to number if needed.
1946  */
1947 function zeroise( $number, $threshold ) {
1948         return sprintf( '%0' . $threshold . 's', $number );
1949 }
1950
1951 /**
1952  * Adds backslashes before letters and before a number at the start of a string.
1953  *
1954  * @since 0.71
1955  *
1956  * @param string $string Value to which backslashes will be added.
1957  * @return string String with backslashes inserted.
1958  */
1959 function backslashit( $string ) {
1960         if ( isset( $string[0] ) && $string[0] >= '0' && $string[0] <= '9' )
1961                 $string = '\\\\' . $string;
1962         return addcslashes( $string, 'A..Za..z' );
1963 }
1964
1965 /**
1966  * Appends a trailing slash.
1967  *
1968  * Will remove trailing forward and backslashes if it exists already before adding
1969  * a trailing forward slash. This prevents double slashing a string or path.
1970  *
1971  * The primary use of this is for paths and thus should be used for paths. It is
1972  * not restricted to paths and offers no specific path support.
1973  *
1974  * @since 1.2.0
1975  *
1976  * @param string $string What to add the trailing slash to.
1977  * @return string String with trailing slash added.
1978  */
1979 function trailingslashit( $string ) {
1980         return untrailingslashit( $string ) . '/';
1981 }
1982
1983 /**
1984  * Removes trailing forward slashes and backslashes if they exist.
1985  *
1986  * The primary use of this is for paths and thus should be used for paths. It is
1987  * not restricted to paths and offers no specific path support.
1988  *
1989  * @since 2.2.0
1990  *
1991  * @param string $string What to remove the trailing slashes from.
1992  * @return string String without the trailing slashes.
1993  */
1994 function untrailingslashit( $string ) {
1995         return rtrim( $string, '/\\' );
1996 }
1997
1998 /**
1999  * Adds slashes to escape strings.
2000  *
2001  * Slashes will first be removed if magic_quotes_gpc is set, see {@link
2002  * http://www.php.net/magic_quotes} for more details.
2003  *
2004  * @since 0.71
2005  *
2006  * @param string $gpc The string returned from HTTP request data.
2007  * @return string Returns a string escaped with slashes.
2008  */
2009 function addslashes_gpc($gpc) {
2010         if ( get_magic_quotes_gpc() )
2011                 $gpc = stripslashes($gpc);
2012
2013         return wp_slash($gpc);
2014 }
2015
2016 /**
2017  * Navigates through an array, object, or scalar, and removes slashes from the values.
2018  *
2019  * @since 2.0.0
2020  *
2021  * @param mixed $value The value to be stripped.
2022  * @return mixed Stripped value.
2023  */
2024 function stripslashes_deep( $value ) {
2025         return map_deep( $value, 'stripslashes_from_strings_only' );
2026 }
2027
2028 /**
2029  * Callback function for `stripslashes_deep()` which strips slashes from strings.
2030  *
2031  * @since 4.4.0
2032  *
2033  * @param mixed $value The array or string to be stripped.
2034  * @return mixed $value The stripped value.
2035  */
2036 function stripslashes_from_strings_only( $value ) {
2037         return is_string( $value ) ? stripslashes( $value ) : $value;
2038 }
2039
2040 /**
2041  * Navigates through an array, object, or scalar, and encodes the values to be used in a URL.
2042  *
2043  * @since 2.2.0
2044  *
2045  * @param mixed $value The array or string to be encoded.
2046  * @return mixed $value The encoded value.
2047  */
2048 function urlencode_deep( $value ) {
2049         return map_deep( $value, 'urlencode' );
2050 }
2051
2052 /**
2053  * Navigates through an array, object, or scalar, and raw-encodes the values to be used in a URL.
2054  *
2055  * @since 3.4.0
2056  *
2057  * @param mixed $value The array or string to be encoded.
2058  * @return mixed $value The encoded value.
2059  */
2060 function rawurlencode_deep( $value ) {
2061         return map_deep( $value, 'rawurlencode' );
2062 }
2063
2064 /**
2065  * Navigates through an array, object, or scalar, and decodes URL-encoded values
2066  *
2067  * @since 4.4.0
2068  *
2069  * @param mixed $value The array or string to be decoded.
2070  * @return mixed $value The decoded value.
2071  */
2072 function urldecode_deep( $value ) {
2073         return map_deep( $value, 'urldecode' );
2074 }
2075
2076 /**
2077  * Converts email addresses characters to HTML entities to block spam bots.
2078  *
2079  * @since 0.71
2080  *
2081  * @param string $email_address Email address.
2082  * @param int    $hex_encoding  Optional. Set to 1 to enable hex encoding.
2083  * @return string Converted email address.
2084  */
2085 function antispambot( $email_address, $hex_encoding = 0 ) {
2086         $email_no_spam_address = '';
2087         for ( $i = 0, $len = strlen( $email_address ); $i < $len; $i++ ) {
2088                 $j = rand( 0, 1 + $hex_encoding );
2089                 if ( $j == 0 ) {
2090                         $email_no_spam_address .= '&#' . ord( $email_address[$i] ) . ';';
2091                 } elseif ( $j == 1 ) {
2092                         $email_no_spam_address .= $email_address[$i];
2093                 } elseif ( $j == 2 ) {
2094                         $email_no_spam_address .= '%' . zeroise( dechex( ord( $email_address[$i] ) ), 2 );
2095                 }
2096         }
2097
2098         return str_replace( '@', '&#64;', $email_no_spam_address );
2099 }
2100
2101 /**
2102  * Callback to convert URI match to HTML A element.
2103  *
2104  * This function was backported from 2.5.0 to 2.3.2. Regex callback for {@link
2105  * make_clickable()}.
2106  *
2107  * @since 2.3.2
2108  * @access private
2109  *
2110  * @param array $matches Single Regex Match.
2111  * @return string HTML A element with URI address.
2112  */
2113 function _make_url_clickable_cb( $matches ) {
2114         $url = $matches[2];
2115
2116         if ( ')' == $matches[3] && strpos( $url, '(' ) ) {
2117                 // If the trailing character is a closing parethesis, and the URL has an opening parenthesis in it, add the closing parenthesis to the URL.
2118                 // Then we can let the parenthesis balancer do its thing below.
2119                 $url .= $matches[3];
2120                 $suffix = '';
2121         } else {
2122                 $suffix = $matches[3];
2123         }
2124
2125         // Include parentheses in the URL only if paired
2126         while ( substr_count( $url, '(' ) < substr_count( $url, ')' ) ) {
2127                 $suffix = strrchr( $url, ')' ) . $suffix;
2128                 $url = substr( $url, 0, strrpos( $url, ')' ) );
2129         }
2130
2131         $url = esc_url($url);
2132         if ( empty($url) )
2133                 return $matches[0];
2134
2135         return $matches[1] . "<a href=\"$url\" rel=\"nofollow\">$url</a>" . $suffix;
2136 }
2137
2138 /**
2139  * Callback to convert URL match to HTML A element.
2140  *
2141  * This function was backported from 2.5.0 to 2.3.2. Regex callback for {@link
2142  * make_clickable()}.
2143  *
2144  * @since 2.3.2
2145  * @access private
2146  *
2147  * @param array $matches Single Regex Match.
2148  * @return string HTML A element with URL address.
2149  */
2150 function _make_web_ftp_clickable_cb( $matches ) {
2151         $ret = '';
2152         $dest = $matches[2];
2153         $dest = 'http://' . $dest;
2154
2155         // removed trailing [.,;:)] from URL
2156         if ( in_array( substr($dest, -1), array('.', ',', ';', ':', ')') ) === true ) {
2157                 $ret = substr($dest, -1);
2158                 $dest = substr($dest, 0, strlen($dest)-1);
2159         }
2160
2161         $dest = esc_url($dest);
2162         if ( empty($dest) )
2163                 return $matches[0];
2164
2165         return $matches[1] . "<a href=\"$dest\" rel=\"nofollow\">$dest</a>$ret";
2166 }
2167
2168 /**
2169  * Callback to convert email address match to HTML A element.
2170  *
2171  * This function was backported from 2.5.0 to 2.3.2. Regex callback for {@link
2172  * make_clickable()}.
2173  *
2174  * @since 2.3.2
2175  * @access private
2176  *
2177  * @param array $matches Single Regex Match.
2178  * @return string HTML A element with email address.
2179  */
2180 function _make_email_clickable_cb( $matches ) {
2181         $email = $matches[2] . '@' . $matches[3];
2182         return $matches[1] . "<a href=\"mailto:$email\">$email</a>";
2183 }
2184
2185 /**
2186  * Convert plaintext URI to HTML links.
2187  *
2188  * Converts URI, www and ftp, and email addresses. Finishes by fixing links
2189  * within links.
2190  *
2191  * @since 0.71
2192  *
2193  * @param string $text Content to convert URIs.
2194  * @return string Content with converted URIs.
2195  */
2196 function make_clickable( $text ) {
2197         $r = '';
2198         $textarr = preg_split( '/(<[^<>]+>)/', $text, -1, PREG_SPLIT_DELIM_CAPTURE ); // split out HTML tags
2199         $nested_code_pre = 0; // Keep track of how many levels link is nested inside <pre> or <code>
2200         foreach ( $textarr as $piece ) {
2201
2202                 if ( preg_match( '|^<code[\s>]|i', $piece ) || preg_match( '|^<pre[\s>]|i', $piece ) )
2203                         $nested_code_pre++;
2204                 elseif ( ( '</code>' === strtolower( $piece ) || '</pre>' === strtolower( $piece ) ) && $nested_code_pre )
2205                         $nested_code_pre--;
2206
2207                 if ( $nested_code_pre || empty( $piece ) || ( $piece[0] === '<' && ! preg_match( '|^<\s*[\w]{1,20}+://|', $piece ) ) ) {
2208                         $r .= $piece;
2209                         continue;
2210                 }
2211
2212                 // Long strings might contain expensive edge cases ...
2213                 if ( 10000 < strlen( $piece ) ) {
2214                         // ... break it up
2215                         foreach ( _split_str_by_whitespace( $piece, 2100 ) as $chunk ) { // 2100: Extra room for scheme and leading and trailing paretheses
2216                                 if ( 2101 < strlen( $chunk ) ) {
2217                                         $r .= $chunk; // Too big, no whitespace: bail.
2218                                 } else {
2219                                         $r .= make_clickable( $chunk );
2220                                 }
2221                         }
2222                 } else {
2223                         $ret = " $piece "; // Pad with whitespace to simplify the regexes
2224
2225                         $url_clickable = '~
2226                                 ([\\s(<.,;:!?])                                        # 1: Leading whitespace, or punctuation
2227                                 (                                                      # 2: URL
2228                                         [\\w]{1,20}+://                                # Scheme and hier-part prefix
2229                                         (?=\S{1,2000}\s)                               # Limit to URLs less than about 2000 characters long
2230                                         [\\w\\x80-\\xff#%\\~/@\\[\\]*(+=&$-]*+         # Non-punctuation URL character
2231                                         (?:                                            # Unroll the Loop: Only allow puctuation URL character if followed by a non-punctuation URL character
2232                                                 [\'.,;:!?)]                            # Punctuation URL character
2233                                                 [\\w\\x80-\\xff#%\\~/@\\[\\]*(+=&$-]++ # Non-punctuation URL character
2234                                         )*
2235                                 )
2236                                 (\)?)                                                  # 3: Trailing closing parenthesis (for parethesis balancing post processing)
2237                         ~xS'; // The regex is a non-anchored pattern and does not have a single fixed starting character.
2238                               // Tell PCRE to spend more time optimizing since, when used on a page load, it will probably be used several times.
2239
2240                         $ret = preg_replace_callback( $url_clickable, '_make_url_clickable_cb', $ret );
2241
2242                         $ret = preg_replace_callback( '#([\s>])((www|ftp)\.[\w\\x80-\\xff\#$%&~/.\-;:=,?@\[\]+]+)#is', '_make_web_ftp_clickable_cb', $ret );
2243                         $ret = preg_replace_callback( '#([\s>])([.0-9a-z_+-]+)@(([0-9a-z-]+\.)+[0-9a-z]{2,})#i', '_make_email_clickable_cb', $ret );
2244
2245                         $ret = substr( $ret, 1, -1 ); // Remove our whitespace padding.
2246                         $r .= $ret;
2247                 }
2248         }
2249
2250         // Cleanup of accidental links within links
2251         return preg_replace( '#(<a([ \r\n\t]+[^>]+?>|>))<a [^>]+?>([^>]+?)</a></a>#i', "$1$3</a>", $r );
2252 }
2253
2254 /**
2255  * Breaks a string into chunks by splitting at whitespace characters.
2256  * The length of each returned chunk is as close to the specified length goal as possible,
2257  * with the caveat that each chunk includes its trailing delimiter.
2258  * Chunks longer than the goal are guaranteed to not have any inner whitespace.
2259  *
2260  * Joining the returned chunks with empty delimiters reconstructs the input string losslessly.
2261  *
2262  * Input string must have no null characters (or eventual transformations on output chunks must not care about null characters)
2263  *
2264  *     _split_str_by_whitespace( "1234 67890 1234 67890a cd 1234   890 123456789 1234567890a    45678   1 3 5 7 90 ", 10 ) ==
2265  *     array (
2266  *         0 => '1234 67890 ',  // 11 characters: Perfect split
2267  *         1 => '1234 ',        //  5 characters: '1234 67890a' was too long
2268  *         2 => '67890a cd ',   // 10 characters: '67890a cd 1234' was too long
2269  *         3 => '1234   890 ',  // 11 characters: Perfect split
2270  *         4 => '123456789 ',   // 10 characters: '123456789 1234567890a' was too long
2271  *         5 => '1234567890a ', // 12 characters: Too long, but no inner whitespace on which to split
2272  *         6 => '   45678   ',  // 11 characters: Perfect split
2273  *         7 => '1 3 5 7 90 ',  // 11 characters: End of $string
2274  *     );
2275  *
2276  * @since 3.4.0
2277  * @access private
2278  *
2279  * @param string $string The string to split.
2280  * @param int    $goal   The desired chunk length.
2281  * @return array Numeric array of chunks.
2282  */
2283 function _split_str_by_whitespace( $string, $goal ) {
2284         $chunks = array();
2285
2286         $string_nullspace = strtr( $string, "\r\n\t\v\f ", "\000\000\000\000\000\000" );
2287
2288         while ( $goal < strlen( $string_nullspace ) ) {
2289                 $pos = strrpos( substr( $string_nullspace, 0, $goal + 1 ), "\000" );
2290
2291                 if ( false === $pos ) {
2292                         $pos = strpos( $string_nullspace, "\000", $goal + 1 );
2293                         if ( false === $pos ) {
2294                                 break;
2295                         }
2296                 }
2297
2298                 $chunks[] = substr( $string, 0, $pos + 1 );
2299                 $string = substr( $string, $pos + 1 );
2300                 $string_nullspace = substr( $string_nullspace, $pos + 1 );
2301         }
2302
2303         if ( $string ) {
2304                 $chunks[] = $string;
2305         }
2306
2307         return $chunks;
2308 }
2309
2310 /**
2311  * Adds rel nofollow string to all HTML A elements in content.
2312  *
2313  * @since 1.5.0
2314  *
2315  * @param string $text Content that may contain HTML A elements.
2316  * @return string Converted content.
2317  */
2318 function wp_rel_nofollow( $text ) {
2319         // This is a pre save filter, so text is already escaped.
2320         $text = stripslashes($text);
2321         $text = preg_replace_callback('|<a (.+?)>|i', 'wp_rel_nofollow_callback', $text);
2322         return wp_slash( $text );
2323 }
2324
2325 /**
2326  * Callback to add rel=nofollow string to HTML A element.
2327  *
2328  * Will remove already existing rel="nofollow" and rel='nofollow' from the
2329  * string to prevent from invalidating (X)HTML.
2330  *
2331  * @since 2.3.0
2332  *
2333  * @param array $matches Single Match
2334  * @return string HTML A Element with rel nofollow.
2335  */
2336 function wp_rel_nofollow_callback( $matches ) {
2337         $text = $matches[1];
2338         $atts = shortcode_parse_atts( $matches[1] );
2339         $rel = 'nofollow';
2340         if ( ! empty( $atts['rel'] ) ) {
2341                 $parts = array_map( 'trim', explode( ' ', $atts['rel'] ) );
2342                 if ( false === array_search( 'nofollow', $parts ) ) {
2343                         $parts[] = 'nofollow';
2344                 }
2345                 $rel = implode( ' ', $parts );
2346                 unset( $atts['rel'] );
2347
2348                 $html = '';
2349                 foreach ( $atts as $name => $value ) {
2350                         $html .= "{$name}=\"$value\" ";
2351                 }
2352                 $text = trim( $html );
2353         }
2354         return "<a $text rel=\"$rel\">";
2355 }
2356
2357 /**
2358  * Convert one smiley code to the icon graphic file equivalent.
2359  *
2360  * Callback handler for {@link convert_smilies()}.
2361  * Looks up one smiley code in the $wpsmiliestrans global array and returns an
2362  * `<img>` string for that smiley.
2363  *
2364  * @since 2.8.0
2365  *
2366  * @global array $wpsmiliestrans
2367  *
2368  * @param array $matches Single match. Smiley code to convert to image.
2369  * @return string Image string for smiley.
2370  */
2371 function translate_smiley( $matches ) {
2372         global $wpsmiliestrans;
2373
2374         if ( count( $matches ) == 0 )
2375                 return '';
2376
2377         $smiley = trim( reset( $matches ) );
2378         $img = $wpsmiliestrans[ $smiley ];
2379
2380         $matches = array();
2381         $ext = preg_match( '/\.([^.]+)$/', $img, $matches ) ? strtolower( $matches[1] ) : false;
2382         $image_exts = array( 'jpg', 'jpeg', 'jpe', 'gif', 'png' );
2383
2384         // Don't convert smilies that aren't images - they're probably emoji.
2385         if ( ! in_array( $ext, $image_exts ) ) {
2386                 return $img;
2387         }
2388
2389         /**
2390          * Filter the Smiley image URL before it's used in the image element.
2391          *
2392          * @since 2.9.0
2393          *
2394          * @param string $smiley_url URL for the smiley image.
2395          * @param string $img        Filename for the smiley image.
2396          * @param string $site_url   Site URL, as returned by site_url().
2397          */
2398         $src_url = apply_filters( 'smilies_src', includes_url( "images/smilies/$img" ), $img, site_url() );
2399
2400         return sprintf( '<img src="%s" alt="%s" class="wp-smiley" style="height: 1em; max-height: 1em;" />', esc_url( $src_url ), esc_attr( $smiley ) );
2401 }
2402
2403 /**
2404  * Convert text equivalent of smilies to images.
2405  *
2406  * Will only convert smilies if the option 'use_smilies' is true and the global
2407  * used in the function isn't empty.
2408  *
2409  * @since 0.71
2410  *
2411  * @global string|array $wp_smiliessearch
2412  *
2413  * @param string $text Content to convert smilies from text.
2414  * @return string Converted content with text smilies replaced with images.
2415  */
2416 function convert_smilies( $text ) {
2417         global $wp_smiliessearch;
2418         $output = '';
2419         if ( get_option( 'use_smilies' ) && ! empty( $wp_smiliessearch ) ) {
2420                 // HTML loop taken from texturize function, could possible be consolidated
2421                 $textarr = preg_split( '/(<.*>)/U', $text, -1, PREG_SPLIT_DELIM_CAPTURE ); // capture the tags as well as in between
2422                 $stop = count( $textarr );// loop stuff
2423
2424                 // Ignore proessing of specific tags
2425                 $tags_to_ignore = 'code|pre|style|script|textarea';
2426                 $ignore_block_element = '';
2427
2428                 for ( $i = 0; $i < $stop; $i++ ) {
2429                         $content = $textarr[$i];
2430
2431                         // If we're in an ignore block, wait until we find its closing tag
2432                         if ( '' == $ignore_block_element && preg_match( '/^<(' . $tags_to_ignore . ')>/', $content, $matches ) )  {
2433                                 $ignore_block_element = $matches[1];
2434                         }
2435
2436                         // If it's not a tag and not in ignore block
2437                         if ( '' ==  $ignore_block_element && strlen( $content ) > 0 && '<' != $content[0] ) {
2438                                 $content = preg_replace_callback( $wp_smiliessearch, 'translate_smiley', $content );
2439                         }
2440
2441                         // did we exit ignore block
2442                         if ( '' != $ignore_block_element && '</' . $ignore_block_element . '>' == $content )  {
2443                                 $ignore_block_element = '';
2444                         }
2445
2446                         $output .= $content;
2447                 }
2448         } else {
2449                 // return default text.
2450                 $output = $text;
2451         }
2452         return $output;
2453 }
2454
2455 /**
2456  * Verifies that an email is valid.
2457  *
2458  * Does not grok i18n domains. Not RFC compliant.
2459  *
2460  * @since 0.71
2461  *
2462  * @param string $email      Email address to verify.
2463  * @param bool   $deprecated Deprecated.
2464  * @return string|bool Either false or the valid email address.
2465  */
2466 function is_email( $email, $deprecated = false ) {
2467         if ( ! empty( $deprecated ) )
2468                 _deprecated_argument( __FUNCTION__, '3.0' );
2469
2470         // Test for the minimum length the email can be
2471         if ( strlen( $email ) < 3 ) {
2472                 /**
2473                  * Filter whether an email address is valid.
2474                  *
2475                  * This filter is evaluated under several different contexts, such as 'email_too_short',
2476                  * 'email_no_at', 'local_invalid_chars', 'domain_period_sequence', 'domain_period_limits',
2477                  * 'domain_no_periods', 'sub_hyphen_limits', 'sub_invalid_chars', or no specific context.
2478                  *
2479                  * @since 2.8.0
2480                  *
2481                  * @param bool   $is_email Whether the email address has passed the is_email() checks. Default false.
2482                  * @param string $email    The email address being checked.
2483                  * @param string $context  Context under which the email was tested.
2484                  */
2485                 return apply_filters( 'is_email', false, $email, 'email_too_short' );
2486         }
2487
2488         // Test for an @ character after the first position
2489         if ( strpos( $email, '@', 1 ) === false ) {
2490                 /** This filter is documented in wp-includes/formatting.php */
2491                 return apply_filters( 'is_email', false, $email, 'email_no_at' );
2492         }
2493
2494         // Split out the local and domain parts
2495         list( $local, $domain ) = explode( '@', $email, 2 );
2496
2497         // LOCAL PART
2498         // Test for invalid characters
2499         if ( !preg_match( '/^[a-zA-Z0-9!#$%&\'*+\/=?^_`{|}~\.-]+$/', $local ) ) {
2500                 /** This filter is documented in wp-includes/formatting.php */
2501                 return apply_filters( 'is_email', false, $email, 'local_invalid_chars' );
2502         }
2503
2504         // DOMAIN PART
2505         // Test for sequences of periods
2506         if ( preg_match( '/\.{2,}/', $domain ) ) {
2507                 /** This filter is documented in wp-includes/formatting.php */
2508                 return apply_filters( 'is_email', false, $email, 'domain_period_sequence' );
2509         }
2510
2511         // Test for leading and trailing periods and whitespace
2512         if ( trim( $domain, " \t\n\r\0\x0B." ) !== $domain ) {
2513                 /** This filter is documented in wp-includes/formatting.php */
2514                 return apply_filters( 'is_email', false, $email, 'domain_period_limits' );
2515         }
2516
2517         // Split the domain into subs
2518         $subs = explode( '.', $domain );
2519
2520         // Assume the domain will have at least two subs
2521         if ( 2 > count( $subs ) ) {
2522                 /** This filter is documented in wp-includes/formatting.php */
2523                 return apply_filters( 'is_email', false, $email, 'domain_no_periods' );
2524         }
2525
2526         // Loop through each sub
2527         foreach ( $subs as $sub ) {
2528                 // Test for leading and trailing hyphens and whitespace
2529                 if ( trim( $sub, " \t\n\r\0\x0B-" ) !== $sub ) {
2530                         /** This filter is documented in wp-includes/formatting.php */
2531                         return apply_filters( 'is_email', false, $email, 'sub_hyphen_limits' );
2532                 }
2533
2534                 // Test for invalid characters
2535                 if ( !preg_match('/^[a-z0-9-]+$/i', $sub ) ) {
2536                         /** This filter is documented in wp-includes/formatting.php */
2537                         return apply_filters( 'is_email', false, $email, 'sub_invalid_chars' );
2538                 }
2539         }
2540
2541         // Congratulations your email made it!
2542         /** This filter is documented in wp-includes/formatting.php */
2543         return apply_filters( 'is_email', $email, $email, null );
2544 }
2545
2546 /**
2547  * Convert to ASCII from email subjects.
2548  *
2549  * @since 1.2.0
2550  *
2551  * @param string $string Subject line
2552  * @return string Converted string to ASCII
2553  */
2554 function wp_iso_descrambler( $string ) {
2555         /* this may only work with iso-8859-1, I'm afraid */
2556         if (!preg_match('#\=\?(.+)\?Q\?(.+)\?\=#i', $string, $matches)) {
2557                 return $string;
2558         } else {
2559                 $subject = str_replace('_', ' ', $matches[2]);
2560                 return preg_replace_callback( '#\=([0-9a-f]{2})#i', '_wp_iso_convert', $subject );
2561         }
2562 }
2563
2564 /**
2565  * Helper function to convert hex encoded chars to ASCII
2566  *
2567  * @since 3.1.0
2568  * @access private
2569  *
2570  * @param array $match The preg_replace_callback matches array
2571  * @return string Converted chars
2572  */
2573 function _wp_iso_convert( $match ) {
2574         return chr( hexdec( strtolower( $match[1] ) ) );
2575 }
2576
2577 /**
2578  * Returns a date in the GMT equivalent.
2579  *
2580  * Requires and returns a date in the Y-m-d H:i:s format. If there is a
2581  * timezone_string available, the date is assumed to be in that timezone,
2582  * otherwise it simply subtracts the value of the 'gmt_offset' option. Return
2583  * format can be overridden using the $format parameter.
2584  *
2585  * @since 1.2.0
2586  *
2587  * @param string $string The date to be converted.
2588  * @param string $format The format string for the returned date (default is Y-m-d H:i:s)
2589  * @return string GMT version of the date provided.
2590  */
2591 function get_gmt_from_date( $string, $format = 'Y-m-d H:i:s' ) {
2592         $tz = get_option( 'timezone_string' );
2593         if ( $tz ) {
2594                 $datetime = date_create( $string, new DateTimeZone( $tz ) );
2595                 if ( ! $datetime ) {
2596                         return gmdate( $format, 0 );
2597                 }
2598                 $datetime->setTimezone( new DateTimeZone( 'UTC' ) );
2599                 $string_gmt = $datetime->format( $format );
2600         } else {
2601                 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 ) ) {
2602                         $datetime = strtotime( $string );
2603                         if ( false === $datetime ) {
2604                                 return gmdate( $format, 0 );
2605                         }
2606                         return gmdate( $format, $datetime );
2607                 }
2608                 $string_time = gmmktime( $matches[4], $matches[5], $matches[6], $matches[2], $matches[3], $matches[1] );
2609                 $string_gmt = gmdate( $format, $string_time - get_option( 'gmt_offset' ) * HOUR_IN_SECONDS );
2610         }
2611         return $string_gmt;
2612 }
2613
2614 /**
2615  * Converts a GMT date into the correct format for the blog.
2616  *
2617  * Requires and returns a date in the Y-m-d H:i:s format. If there is a
2618  * timezone_string available, the returned date is in that timezone, otherwise
2619  * it simply adds the value of gmt_offset. Return format can be overridden
2620  * using the $format parameter
2621  *
2622  * @since 1.2.0
2623  *
2624  * @param string $string The date to be converted.
2625  * @param string $format The format string for the returned date (default is Y-m-d H:i:s)
2626  * @return string Formatted date relative to the timezone / GMT offset.
2627  */
2628 function get_date_from_gmt( $string, $format = 'Y-m-d H:i:s' ) {
2629         $tz = get_option( 'timezone_string' );
2630         if ( $tz ) {
2631                 $datetime = date_create( $string, new DateTimeZone( 'UTC' ) );
2632                 if ( ! $datetime )
2633                         return date( $format, 0 );
2634                 $datetime->setTimezone( new DateTimeZone( $tz ) );
2635                 $string_localtime = $datetime->format( $format );
2636         } else {
2637                 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) )
2638                         return date( $format, 0 );
2639                 $string_time = gmmktime( $matches[4], $matches[5], $matches[6], $matches[2], $matches[3], $matches[1] );
2640                 $string_localtime = gmdate( $format, $string_time + get_option( 'gmt_offset' ) * HOUR_IN_SECONDS );
2641         }
2642         return $string_localtime;
2643 }
2644
2645 /**
2646  * Computes an offset in seconds from an iso8601 timezone.
2647  *
2648  * @since 1.5.0
2649  *
2650  * @param string $timezone Either 'Z' for 0 offset or '±hhmm'.
2651  * @return int|float The offset in seconds.
2652  */
2653 function iso8601_timezone_to_offset( $timezone ) {
2654         // $timezone is either 'Z' or '[+|-]hhmm'
2655         if ($timezone == 'Z') {
2656                 $offset = 0;
2657         } else {
2658                 $sign    = (substr($timezone, 0, 1) == '+') ? 1 : -1;
2659                 $hours   = intval(substr($timezone, 1, 2));
2660                 $minutes = intval(substr($timezone, 3, 4)) / 60;
2661                 $offset  = $sign * HOUR_IN_SECONDS * ($hours + $minutes);
2662         }
2663         return $offset;
2664 }
2665
2666 /**
2667  * Converts an iso8601 date to MySQL DateTime format used by post_date[_gmt].
2668  *
2669  * @since 1.5.0
2670  *
2671  * @param string $date_string Date and time in ISO 8601 format {@link http://en.wikipedia.org/wiki/ISO_8601}.
2672  * @param string $timezone    Optional. If set to GMT returns the time minus gmt_offset. Default is 'user'.
2673  * @return string The date and time in MySQL DateTime format - Y-m-d H:i:s.
2674  */
2675 function iso8601_to_datetime( $date_string, $timezone = 'user' ) {
2676         $timezone = strtolower($timezone);
2677
2678         if ($timezone == 'gmt') {
2679
2680                 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);
2681
2682                 if (!empty($date_bits[7])) { // we have a timezone, so let's compute an offset
2683                         $offset = iso8601_timezone_to_offset($date_bits[7]);
2684                 } else { // we don't have a timezone, so we assume user local timezone (not server's!)
2685                         $offset = HOUR_IN_SECONDS * get_option('gmt_offset');
2686                 }
2687
2688                 $timestamp = gmmktime($date_bits[4], $date_bits[5], $date_bits[6], $date_bits[2], $date_bits[3], $date_bits[1]);
2689                 $timestamp -= $offset;
2690
2691                 return gmdate('Y-m-d H:i:s', $timestamp);
2692
2693         } elseif ($timezone == 'user') {
2694                 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);
2695         }
2696 }
2697
2698 /**
2699  * Adds a element attributes to open links in new windows.
2700  *
2701  * Comment text in popup windows should be filtered through this. Right now it's
2702  * a moderately dumb function, ideally it would detect whether a target or rel
2703  * attribute was already there and adjust its actions accordingly.
2704  *
2705  * @since 0.71
2706  *
2707  * @param string $text Content to replace links to open in a new window.
2708  * @return string Content that has filtered links.
2709  */
2710 function popuplinks( $text ) {
2711         $text = preg_replace('/<a (.+?)>/i', "<a $1 target='_blank' rel='external'>", $text);
2712         return $text;
2713 }
2714
2715 /**
2716  * Strips out all characters that are not allowable in an email.
2717  *
2718  * @since 1.5.0
2719  *
2720  * @param string $email Email address to filter.
2721  * @return string Filtered email address.
2722  */
2723 function sanitize_email( $email ) {
2724         // Test for the minimum length the email can be
2725         if ( strlen( $email ) < 3 ) {
2726                 /**
2727                  * Filter a sanitized email address.
2728                  *
2729                  * This filter is evaluated under several contexts, including 'email_too_short',
2730                  * 'email_no_at', 'local_invalid_chars', 'domain_period_sequence', 'domain_period_limits',
2731                  * 'domain_no_periods', 'domain_no_valid_subs', or no context.
2732                  *
2733                  * @since 2.8.0
2734                  *
2735                  * @param string $email   The sanitized email address.
2736                  * @param string $email   The email address, as provided to sanitize_email().
2737                  * @param string $message A message to pass to the user.
2738                  */
2739                 return apply_filters( 'sanitize_email', '', $email, 'email_too_short' );
2740         }
2741
2742         // Test for an @ character after the first position
2743         if ( strpos( $email, '@', 1 ) === false ) {
2744                 /** This filter is documented in wp-includes/formatting.php */
2745                 return apply_filters( 'sanitize_email', '', $email, 'email_no_at' );
2746         }
2747
2748         // Split out the local and domain parts
2749         list( $local, $domain ) = explode( '@', $email, 2 );
2750
2751         // LOCAL PART
2752         // Test for invalid characters
2753         $local = preg_replace( '/[^a-zA-Z0-9!#$%&\'*+\/=?^_`{|}~\.-]/', '', $local );
2754         if ( '' === $local ) {
2755                 /** This filter is documented in wp-includes/formatting.php */
2756                 return apply_filters( 'sanitize_email', '', $email, 'local_invalid_chars' );
2757         }
2758
2759         // DOMAIN PART
2760         // Test for sequences of periods
2761         $domain = preg_replace( '/\.{2,}/', '', $domain );
2762         if ( '' === $domain ) {
2763                 /** This filter is documented in wp-includes/formatting.php */
2764                 return apply_filters( 'sanitize_email', '', $email, 'domain_period_sequence' );
2765         }
2766
2767         // Test for leading and trailing periods and whitespace
2768         $domain = trim( $domain, " \t\n\r\0\x0B." );
2769         if ( '' === $domain ) {
2770                 /** This filter is documented in wp-includes/formatting.php */
2771                 return apply_filters( 'sanitize_email', '', $email, 'domain_period_limits' );
2772         }
2773
2774         // Split the domain into subs
2775         $subs = explode( '.', $domain );
2776
2777         // Assume the domain will have at least two subs
2778         if ( 2 > count( $subs ) ) {
2779                 /** This filter is documented in wp-includes/formatting.php */
2780                 return apply_filters( 'sanitize_email', '', $email, 'domain_no_periods' );
2781         }
2782
2783         // Create an array that will contain valid subs
2784         $new_subs = array();
2785
2786         // Loop through each sub
2787         foreach ( $subs as $sub ) {
2788                 // Test for leading and trailing hyphens
2789                 $sub = trim( $sub, " \t\n\r\0\x0B-" );
2790
2791                 // Test for invalid characters
2792                 $sub = preg_replace( '/[^a-z0-9-]+/i', '', $sub );
2793
2794                 // If there's anything left, add it to the valid subs
2795                 if ( '' !== $sub ) {
2796                         $new_subs[] = $sub;
2797                 }
2798         }
2799
2800         // If there aren't 2 or more valid subs
2801         if ( 2 > count( $new_subs ) ) {
2802                 /** This filter is documented in wp-includes/formatting.php */
2803                 return apply_filters( 'sanitize_email', '', $email, 'domain_no_valid_subs' );
2804         }
2805
2806         // Join valid subs into the new domain
2807         $domain = join( '.', $new_subs );
2808
2809         // Put the email back together
2810         $email = $local . '@' . $domain;
2811
2812         // Congratulations your email made it!
2813         /** This filter is documented in wp-includes/formatting.php */
2814         return apply_filters( 'sanitize_email', $email, $email, null );
2815 }
2816
2817 /**
2818  * Determines the difference between two timestamps.
2819  *
2820  * The difference is returned in a human readable format such as "1 hour",
2821  * "5 mins", "2 days".
2822  *
2823  * @since 1.5.0
2824  *
2825  * @param int $from Unix timestamp from which the difference begins.
2826  * @param int $to   Optional. Unix timestamp to end the time difference. Default becomes time() if not set.
2827  * @return string Human readable time difference.
2828  */
2829 function human_time_diff( $from, $to = '' ) {
2830         if ( empty( $to ) ) {
2831                 $to = time();
2832         }
2833
2834         $diff = (int) abs( $to - $from );
2835
2836         if ( $diff < HOUR_IN_SECONDS ) {
2837                 $mins = round( $diff / MINUTE_IN_SECONDS );
2838                 if ( $mins <= 1 )
2839                         $mins = 1;
2840                 /* translators: min=minute */
2841                 $since = sprintf( _n( '%s min', '%s mins', $mins ), $mins );
2842         } elseif ( $diff < DAY_IN_SECONDS && $diff >= HOUR_IN_SECONDS ) {
2843                 $hours = round( $diff / HOUR_IN_SECONDS );
2844                 if ( $hours <= 1 )
2845                         $hours = 1;
2846                 $since = sprintf( _n( '%s hour', '%s hours', $hours ), $hours );
2847         } elseif ( $diff < WEEK_IN_SECONDS && $diff >= DAY_IN_SECONDS ) {
2848                 $days = round( $diff / DAY_IN_SECONDS );
2849                 if ( $days <= 1 )
2850                         $days = 1;
2851                 $since = sprintf( _n( '%s day', '%s days', $days ), $days );
2852         } elseif ( $diff < MONTH_IN_SECONDS && $diff >= WEEK_IN_SECONDS ) {
2853                 $weeks = round( $diff / WEEK_IN_SECONDS );
2854                 if ( $weeks <= 1 )
2855                         $weeks = 1;
2856                 $since = sprintf( _n( '%s week', '%s weeks', $weeks ), $weeks );
2857         } elseif ( $diff < YEAR_IN_SECONDS && $diff >= MONTH_IN_SECONDS ) {
2858                 $months = round( $diff / MONTH_IN_SECONDS );
2859                 if ( $months <= 1 )
2860                         $months = 1;
2861                 $since = sprintf( _n( '%s month', '%s months', $months ), $months );
2862         } elseif ( $diff >= YEAR_IN_SECONDS ) {
2863                 $years = round( $diff / YEAR_IN_SECONDS );
2864                 if ( $years <= 1 )
2865                         $years = 1;
2866                 $since = sprintf( _n( '%s year', '%s years', $years ), $years );
2867         }
2868
2869         /**
2870          * Filter the human readable difference between two timestamps.
2871          *
2872          * @since 4.0.0
2873          *
2874          * @param string $since The difference in human readable text.
2875          * @param int    $diff  The difference in seconds.
2876          * @param int    $from  Unix timestamp from which the difference begins.
2877          * @param int    $to    Unix timestamp to end the time difference.
2878          */
2879         return apply_filters( 'human_time_diff', $since, $diff, $from, $to );
2880 }
2881
2882 /**
2883  * Generates an excerpt from the content, if needed.
2884  *
2885  * The excerpt word amount will be 55 words and if the amount is greater than
2886  * that, then the string ' [&hellip;]' will be appended to the excerpt. If the string
2887  * is less than 55 words, then the content will be returned as is.
2888  *
2889  * The 55 word limit can be modified by plugins/themes using the excerpt_length filter
2890  * The ' [&hellip;]' string can be modified by plugins/themes using the excerpt_more filter
2891  *
2892  * @since 1.5.0
2893  *
2894  * @param string $text Optional. The excerpt. If set to empty, an excerpt is generated.
2895  * @return string The excerpt.
2896  */
2897 function wp_trim_excerpt( $text = '' ) {
2898         $raw_excerpt = $text;
2899         if ( '' == $text ) {
2900                 $text = get_the_content('');
2901
2902                 $text = strip_shortcodes( $text );
2903
2904                 /** This filter is documented in wp-includes/post-template.php */
2905                 $text = apply_filters( 'the_content', $text );
2906                 $text = str_replace(']]>', ']]&gt;', $text);
2907
2908                 /**
2909                  * Filter the number of words in an excerpt.
2910                  *
2911                  * @since 2.7.0
2912                  *
2913                  * @param int $number The number of words. Default 55.
2914                  */
2915                 $excerpt_length = apply_filters( 'excerpt_length', 55 );
2916                 /**
2917                  * Filter the string in the "more" link displayed after a trimmed excerpt.
2918                  *
2919                  * @since 2.9.0
2920                  *
2921                  * @param string $more_string The string shown within the more link.
2922                  */
2923                 $excerpt_more = apply_filters( 'excerpt_more', ' ' . '[&hellip;]' );
2924                 $text = wp_trim_words( $text, $excerpt_length, $excerpt_more );
2925         }
2926         /**
2927          * Filter the trimmed excerpt string.
2928          *
2929          * @since 2.8.0
2930          *
2931          * @param string $text        The trimmed text.
2932          * @param string $raw_excerpt The text prior to trimming.
2933          */
2934         return apply_filters( 'wp_trim_excerpt', $text, $raw_excerpt );
2935 }
2936
2937 /**
2938  * Trims text to a certain number of words.
2939  *
2940  * This function is localized. For languages that count 'words' by the individual
2941  * character (such as East Asian languages), the $num_words argument will apply
2942  * to the number of individual characters.
2943  *
2944  * @since 3.3.0
2945  *
2946  * @param string $text      Text to trim.
2947  * @param int    $num_words Number of words. Default 55.
2948  * @param string $more      Optional. What to append if $text needs to be trimmed. Default '&hellip;'.
2949  * @return string Trimmed text.
2950  */
2951 function wp_trim_words( $text, $num_words = 55, $more = null ) {
2952         if ( null === $more ) {
2953                 $more = __( '&hellip;' );
2954         }
2955
2956         $original_text = $text;
2957         $text = wp_strip_all_tags( $text );
2958
2959         /*
2960          * translators: If your word count is based on single characters (e.g. East Asian characters),
2961          * enter 'characters_excluding_spaces' or 'characters_including_spaces'. Otherwise, enter 'words'.
2962          * Do not translate into your own language.
2963          */
2964         if ( strpos( _x( 'words', 'Word count type. Do not translate!' ), 'characters' ) === 0 && preg_match( '/^utf\-?8$/i', get_option( 'blog_charset' ) ) ) {
2965                 $text = trim( preg_replace( "/[\n\r\t ]+/", ' ', $text ), ' ' );
2966                 preg_match_all( '/./u', $text, $words_array );
2967                 $words_array = array_slice( $words_array[0], 0, $num_words + 1 );
2968                 $sep = '';
2969         } else {
2970                 $words_array = preg_split( "/[\n\r\t ]+/", $text, $num_words + 1, PREG_SPLIT_NO_EMPTY );
2971                 $sep = ' ';
2972         }
2973
2974         if ( count( $words_array ) > $num_words ) {
2975                 array_pop( $words_array );
2976                 $text = implode( $sep, $words_array );
2977                 $text = $text . $more;
2978         } else {
2979                 $text = implode( $sep, $words_array );
2980         }
2981
2982         /**
2983          * Filter the text content after words have been trimmed.
2984          *
2985          * @since 3.3.0
2986          *
2987          * @param string $text          The trimmed text.
2988          * @param int    $num_words     The number of words to trim the text to. Default 5.
2989          * @param string $more          An optional string to append to the end of the trimmed text, e.g. &hellip;.
2990          * @param string $original_text The text before it was trimmed.
2991          */
2992         return apply_filters( 'wp_trim_words', $text, $num_words, $more, $original_text );
2993 }
2994
2995 /**
2996  * Converts named entities into numbered entities.
2997  *
2998  * @since 1.5.1
2999  *
3000  * @param string $text The text within which entities will be converted.
3001  * @return string Text with converted entities.
3002  */
3003 function ent2ncr( $text ) {
3004
3005         /**
3006          * Filter text before named entities are converted into numbered entities.
3007          *
3008          * A non-null string must be returned for the filter to be evaluated.
3009          *
3010          * @since 3.3.0
3011          *
3012          * @param null   $converted_text The text to be converted. Default null.
3013          * @param string $text           The text prior to entity conversion.
3014          */
3015         $filtered = apply_filters( 'pre_ent2ncr', null, $text );
3016         if ( null !== $filtered )
3017                 return $filtered;
3018
3019         $to_ncr = array(
3020                 '&quot;' => '&#34;',
3021                 '&amp;' => '&#38;',
3022                 '&lt;' => '&#60;',
3023                 '&gt;' => '&#62;',
3024                 '|' => '&#124;',
3025                 '&nbsp;' => '&#160;',
3026                 '&iexcl;' => '&#161;',
3027                 '&cent;' => '&#162;',
3028                 '&pound;' => '&#163;',
3029                 '&curren;' => '&#164;',
3030                 '&yen;' => '&#165;',
3031                 '&brvbar;' => '&#166;',
3032                 '&brkbar;' => '&#166;',
3033                 '&sect;' => '&#167;',
3034                 '&uml;' => '&#168;',
3035                 '&die;' => '&#168;',
3036                 '&copy;' => '&#169;',
3037                 '&ordf;' => '&#170;',
3038                 '&laquo;' => '&#171;',
3039                 '&not;' => '&#172;',
3040                 '&shy;' => '&#173;',
3041                 '&reg;' => '&#174;',
3042                 '&macr;' => '&#175;',
3043                 '&hibar;' => '&#175;',
3044                 '&deg;' => '&#176;',
3045                 '&plusmn;' => '&#177;',
3046                 '&sup2;' => '&#178;',
3047                 '&sup3;' => '&#179;',
3048                 '&acute;' => '&#180;',
3049                 '&micro;' => '&#181;',
3050                 '&para;' => '&#182;',
3051                 '&middot;' => '&#183;',
3052                 '&cedil;' => '&#184;',
3053                 '&sup1;' => '&#185;',
3054                 '&ordm;' => '&#186;',
3055                 '&raquo;' => '&#187;',
3056                 '&frac14;' => '&#188;',
3057                 '&frac12;' => '&#189;',
3058                 '&frac34;' => '&#190;',
3059                 '&iquest;' => '&#191;',
3060                 '&Agrave;' => '&#192;',
3061                 '&Aacute;' => '&#193;',
3062                 '&Acirc;' => '&#194;',
3063                 '&Atilde;' => '&#195;',
3064                 '&Auml;' => '&#196;',
3065                 '&Aring;' => '&#197;',
3066                 '&AElig;' => '&#198;',
3067                 '&Ccedil;' => '&#199;',
3068                 '&Egrave;' => '&#200;',
3069                 '&Eacute;' => '&#201;',
3070                 '&Ecirc;' => '&#202;',
3071                 '&Euml;' => '&#203;',
3072                 '&Igrave;' => '&#204;',
3073                 '&Iacute;' => '&#205;',
3074                 '&Icirc;' => '&#206;',
3075                 '&Iuml;' => '&#207;',
3076                 '&ETH;' => '&#208;',
3077                 '&Ntilde;' => '&#209;',
3078                 '&Ograve;' => '&#210;',
3079                 '&Oacute;' => '&#211;',
3080                 '&Ocirc;' => '&#212;',
3081                 '&Otilde;' => '&#213;',
3082                 '&Ouml;' => '&#214;',
3083                 '&times;' => '&#215;',
3084                 '&Oslash;' => '&#216;',
3085                 '&Ugrave;' => '&#217;',
3086                 '&Uacute;' => '&#218;',
3087                 '&Ucirc;' => '&#219;',
3088                 '&Uuml;' => '&#220;',
3089                 '&Yacute;' => '&#221;',
3090                 '&THORN;' => '&#222;',
3091                 '&szlig;' => '&#223;',
3092                 '&agrave;' => '&#224;',
3093                 '&aacute;' => '&#225;',
3094                 '&acirc;' => '&#226;',
3095                 '&atilde;' => '&#227;',
3096                 '&auml;' => '&#228;',
3097                 '&aring;' => '&#229;',
3098                 '&aelig;' => '&#230;',
3099                 '&ccedil;' => '&#231;',
3100                 '&egrave;' => '&#232;',
3101                 '&eacute;' => '&#233;',
3102                 '&ecirc;' => '&#234;',
3103                 '&euml;' => '&#235;',
3104                 '&igrave;' => '&#236;',
3105                 '&iacute;' => '&#237;',
3106                 '&icirc;' => '&#238;',
3107                 '&iuml;' => '&#239;',
3108                 '&eth;' => '&#240;',
3109                 '&ntilde;' => '&#241;',
3110                 '&ograve;' => '&#242;',
3111                 '&oacute;' => '&#243;',
3112                 '&ocirc;' => '&#244;',
3113                 '&otilde;' => '&#245;',
3114                 '&ouml;' => '&#246;',
3115                 '&divide;' => '&#247;',
3116                 '&oslash;' => '&#248;',
3117                 '&ugrave;' => '&#249;',
3118                 '&uacute;' => '&#250;',
3119                 '&ucirc;' => '&#251;',
3120                 '&uuml;' => '&#252;',
3121                 '&yacute;' => '&#253;',
3122                 '&thorn;' => '&#254;',
3123                 '&yuml;' => '&#255;',
3124                 '&OElig;' => '&#338;',
3125                 '&oelig;' => '&#339;',
3126                 '&Scaron;' => '&#352;',
3127                 '&scaron;' => '&#353;',
3128                 '&Yuml;' => '&#376;',
3129                 '&fnof;' => '&#402;',
3130                 '&circ;' => '&#710;',
3131                 '&tilde;' => '&#732;',
3132                 '&Alpha;' => '&#913;',
3133                 '&Beta;' => '&#914;',
3134                 '&Gamma;' => '&#915;',
3135                 '&Delta;' => '&#916;',
3136                 '&Epsilon;' => '&#917;',
3137                 '&Zeta;' => '&#918;',
3138                 '&Eta;' => '&#919;',
3139                 '&Theta;' => '&#920;',
3140                 '&Iota;' => '&#921;',
3141                 '&Kappa;' => '&#922;',
3142                 '&Lambda;' => '&#923;',
3143                 '&Mu;' => '&#924;',
3144                 '&Nu;' => '&#925;',
3145                 '&Xi;' => '&#926;',
3146                 '&Omicron;' => '&#927;',
3147                 '&Pi;' => '&#928;',
3148                 '&Rho;' => '&#929;',
3149                 '&Sigma;' => '&#931;',
3150                 '&Tau;' => '&#932;',
3151                 '&Upsilon;' => '&#933;',
3152                 '&Phi;' => '&#934;',
3153                 '&Chi;' => '&#935;',
3154                 '&Psi;' => '&#936;',
3155                 '&Omega;' => '&#937;',
3156                 '&alpha;' => '&#945;',
3157                 '&beta;' => '&#946;',
3158                 '&gamma;' => '&#947;',
3159                 '&delta;' => '&#948;',
3160                 '&epsilon;' => '&#949;',
3161                 '&zeta;' => '&#950;',
3162                 '&eta;' => '&#951;',
3163                 '&theta;' => '&#952;',
3164                 '&iota;' => '&#953;',
3165                 '&kappa;' => '&#954;',
3166                 '&lambda;' => '&#955;',
3167                 '&mu;' => '&#956;',
3168                 '&nu;' => '&#957;',
3169                 '&xi;' => '&#958;',
3170                 '&omicron;' => '&#959;',
3171                 '&pi;' => '&#960;',
3172                 '&rho;' => '&#961;',
3173                 '&sigmaf;' => '&#962;',
3174                 '&sigma;' => '&#963;',
3175                 '&tau;' => '&#964;',
3176                 '&upsilon;' => '&#965;',
3177                 '&phi;' => '&#966;',
3178                 '&chi;' => '&#967;',
3179                 '&psi;' => '&#968;',
3180                 '&omega;' => '&#969;',
3181                 '&thetasym;' => '&#977;',
3182                 '&upsih;' => '&#978;',
3183                 '&piv;' => '&#982;',
3184                 '&ensp;' => '&#8194;',
3185                 '&emsp;' => '&#8195;',
3186                 '&thinsp;' => '&#8201;',
3187                 '&zwnj;' => '&#8204;',
3188                 '&zwj;' => '&#8205;',
3189                 '&lrm;' => '&#8206;',
3190                 '&rlm;' => '&#8207;',
3191                 '&ndash;' => '&#8211;',
3192                 '&mdash;' => '&#8212;',
3193                 '&lsquo;' => '&#8216;',
3194                 '&rsquo;' => '&#8217;',
3195                 '&sbquo;' => '&#8218;',
3196                 '&ldquo;' => '&#8220;',
3197                 '&rdquo;' => '&#8221;',
3198                 '&bdquo;' => '&#8222;',
3199                 '&dagger;' => '&#8224;',
3200                 '&Dagger;' => '&#8225;',
3201                 '&bull;' => '&#8226;',
3202                 '&hellip;' => '&#8230;',
3203                 '&permil;' => '&#8240;',
3204                 '&prime;' => '&#8242;',
3205                 '&Prime;' => '&#8243;',
3206                 '&lsaquo;' => '&#8249;',
3207                 '&rsaquo;' => '&#8250;',
3208                 '&oline;' => '&#8254;',
3209                 '&frasl;' => '&#8260;',
3210                 '&euro;' => '&#8364;',
3211                 '&image;' => '&#8465;',
3212                 '&weierp;' => '&#8472;',
3213                 '&real;' => '&#8476;',
3214                 '&trade;' => '&#8482;',
3215                 '&alefsym;' => '&#8501;',
3216                 '&crarr;' => '&#8629;',
3217                 '&lArr;' => '&#8656;',
3218                 '&uArr;' => '&#8657;',
3219                 '&rArr;' => '&#8658;',
3220                 '&dArr;' => '&#8659;',
3221                 '&hArr;' => '&#8660;',
3222                 '&forall;' => '&#8704;',
3223                 '&part;' => '&#8706;',
3224                 '&exist;' => '&#8707;',
3225                 '&empty;' => '&#8709;',
3226                 '&nabla;' => '&#8711;',
3227                 '&isin;' => '&#8712;',
3228                 '&notin;' => '&#8713;',
3229                 '&ni;' => '&#8715;',
3230                 '&prod;' => '&#8719;',
3231                 '&sum;' => '&#8721;',
3232                 '&minus;' => '&#8722;',
3233                 '&lowast;' => '&#8727;',
3234                 '&radic;' => '&#8730;',
3235                 '&prop;' => '&#8733;',
3236                 '&infin;' => '&#8734;',
3237                 '&ang;' => '&#8736;',
3238                 '&and;' => '&#8743;',
3239                 '&or;' => '&#8744;',
3240                 '&cap;' => '&#8745;',
3241                 '&cup;' => '&#8746;',
3242                 '&int;' => '&#8747;',
3243                 '&there4;' => '&#8756;',
3244                 '&sim;' => '&#8764;',
3245                 '&cong;' => '&#8773;',
3246                 '&asymp;' => '&#8776;',
3247                 '&ne;' => '&#8800;',
3248                 '&equiv;' => '&#8801;',
3249                 '&le;' => '&#8804;',
3250                 '&ge;' => '&#8805;',
3251                 '&sub;' => '&#8834;',
3252                 '&sup;' => '&#8835;',
3253                 '&nsub;' => '&#8836;',
3254                 '&sube;' => '&#8838;',
3255                 '&supe;' => '&#8839;',
3256                 '&oplus;' => '&#8853;',
3257                 '&otimes;' => '&#8855;',
3258                 '&perp;' => '&#8869;',
3259                 '&sdot;' => '&#8901;',
3260                 '&lceil;' => '&#8968;',
3261                 '&rceil;' => '&#8969;',
3262                 '&lfloor;' => '&#8970;',
3263                 '&rfloor;' => '&#8971;',
3264                 '&lang;' => '&#9001;',
3265                 '&rang;' => '&#9002;',
3266                 '&larr;' => '&#8592;',
3267                 '&uarr;' => '&#8593;',
3268                 '&rarr;' => '&#8594;',
3269                 '&darr;' => '&#8595;',
3270                 '&harr;' => '&#8596;',
3271                 '&loz;' => '&#9674;',
3272                 '&spades;' => '&#9824;',
3273                 '&clubs;' => '&#9827;',
3274                 '&hearts;' => '&#9829;',
3275                 '&diams;' => '&#9830;'
3276         );
3277
3278         return str_replace( array_keys($to_ncr), array_values($to_ncr), $text );
3279 }
3280
3281 /**
3282  * Formats text for the editor.
3283  *
3284  * Generally the browsers treat everything inside a textarea as text, but
3285  * it is still a good idea to HTML entity encode `<`, `>` and `&` in the content.
3286  *
3287  * The filter {@see 'format_for_editor'} is applied here. If `$text` is empty the
3288  * filter will be applied to an empty string.
3289  *
3290  * @since 4.3.0
3291  *
3292  * @param string $text The text to be formatted.
3293  * @return string The formatted text after filter is applied.
3294  */
3295 function format_for_editor( $text, $default_editor = null ) {
3296         if ( $text ) {
3297                 $text = htmlspecialchars( $text, ENT_NOQUOTES, get_option( 'blog_charset' ) );
3298         }
3299
3300         /**
3301          * Filter the text after it is formatted for the editor.
3302          *
3303          * @since 4.3.0
3304          *
3305          * @param string $text The formatted text.
3306          */
3307         return apply_filters( 'format_for_editor', $text, $default_editor );
3308 }
3309
3310 /**
3311  * Perform a deep string replace operation to ensure the values in $search are no longer present
3312  *
3313  * Repeats the replacement operation until it no longer replaces anything so as to remove "nested" values
3314  * e.g. $subject = '%0%0%0DDD', $search ='%0D', $result ='' rather than the '%0%0DD' that
3315  * str_replace would return
3316  *
3317  * @since 2.8.1
3318  * @access private
3319  *
3320  * @param string|array $search  The value being searched for, otherwise known as the needle.
3321  *                              An array may be used to designate multiple needles.
3322  * @param string       $subject The string being searched and replaced on, otherwise known as the haystack.
3323  * @return string The string with the replaced svalues.
3324  */
3325 function _deep_replace( $search, $subject ) {
3326         $subject = (string) $subject;
3327
3328         $count = 1;
3329         while ( $count ) {
3330                 $subject = str_replace( $search, '', $subject, $count );
3331         }
3332
3333         return $subject;
3334 }
3335
3336 /**
3337  * Escapes data for use in a MySQL query.
3338  *
3339  * Usually you should prepare queries using wpdb::prepare().
3340  * Sometimes, spot-escaping is required or useful. One example
3341  * is preparing an array for use in an IN clause.
3342  *
3343  * @since 2.8.0
3344  *
3345  * @global wpdb $wpdb WordPress database abstraction object.
3346  *
3347  * @param string|array $data Unescaped data
3348  * @return string|array Escaped data
3349  */
3350 function esc_sql( $data ) {
3351         global $wpdb;
3352         return $wpdb->_escape( $data );
3353 }
3354
3355 /**
3356  * Checks and cleans a URL.
3357  *
3358  * A number of characters are removed from the URL. If the URL is for displaying
3359  * (the default behaviour) ampersands are also replaced. The 'clean_url' filter
3360  * is applied to the returned cleaned URL.
3361  *
3362  * @since 2.8.0
3363  *
3364  * @param string $url       The URL to be cleaned.
3365  * @param array  $protocols Optional. An array of acceptable protocols.
3366  *                                  Defaults to return value of wp_allowed_protocols()
3367  * @param string $_context  Private. Use esc_url_raw() for database usage.
3368  * @return string The cleaned $url after the 'clean_url' filter is applied.
3369  */
3370 function esc_url( $url, $protocols = null, $_context = 'display' ) {
3371         $original_url = $url;
3372
3373         if ( '' == $url )
3374                 return $url;
3375
3376         $url = str_replace( ' ', '%20', $url );
3377         $url = preg_replace('|[^a-z0-9-~+_.?#=!&;,/:%@$\|*\'()\[\]\\x80-\\xff]|i', '', $url);
3378
3379         if ( '' === $url ) {
3380                 return $url;
3381         }
3382
3383         if ( 0 !== stripos( $url, 'mailto:' ) ) {
3384                 $strip = array('%0d', '%0a', '%0D', '%0A');
3385                 $url = _deep_replace($strip, $url);
3386         }
3387
3388         $url = str_replace(';//', '://', $url);
3389         /* If the URL doesn't appear to contain a scheme, we
3390          * presume it needs http:// prepended (unless a relative
3391          * link starting with /, # or ? or a php file).
3392          */
3393         if ( strpos($url, ':') === false && ! in_array( $url[0], array( '/', '#', '?' ) ) &&
3394                 ! preg_match('/^[a-z0-9-]+?\.php/i', $url) )
3395                 $url = 'http://' . $url;
3396
3397         // Replace ampersands and single quotes only when displaying.
3398         if ( 'display' == $_context ) {
3399                 $url = wp_kses_normalize_entities( $url );
3400                 $url = str_replace( '&amp;', '&#038;', $url );
3401                 $url = str_replace( "'", '&#039;', $url );
3402         }
3403
3404         if ( ( false !== strpos( $url, '[' ) ) || ( false !== strpos( $url, ']' ) ) ) {
3405
3406                 $parsed = wp_parse_url( $url );
3407                 $front  = '';
3408
3409                 if ( isset( $parsed['scheme'] ) ) {
3410                         $front .= $parsed['scheme'] . '://';
3411                 } elseif ( '/' === $url[0] ) {
3412                         $front .= '//';
3413                 }
3414
3415                 if ( isset( $parsed['user'] ) ) {
3416                         $front .= $parsed['user'];
3417                 }
3418
3419                 if ( isset( $parsed['pass'] ) ) {
3420                         $front .= ':' . $parsed['pass'];
3421                 }
3422
3423                 if ( isset( $parsed['user'] ) || isset( $parsed['pass'] ) ) {
3424                         $front .= '@';
3425                 }
3426
3427                 if ( isset( $parsed['host'] ) ) {
3428                         $front .= $parsed['host'];
3429                 }
3430
3431                 if ( isset( $parsed['port'] ) ) {
3432                         $front .= ':' . $parsed['port'];
3433                 }
3434
3435                 $end_dirty = str_replace( $front, '', $url );
3436                 $end_clean = str_replace( array( '[', ']' ), array( '%5B', '%5D' ), $end_dirty );
3437                 $url       = str_replace( $end_dirty, $end_clean, $url );
3438
3439         }
3440
3441         if ( '/' === $url[0] ) {
3442                 $good_protocol_url = $url;
3443         } else {
3444                 if ( ! is_array( $protocols ) )
3445                         $protocols = wp_allowed_protocols();
3446                 $good_protocol_url = wp_kses_bad_protocol( $url, $protocols );
3447                 if ( strtolower( $good_protocol_url ) != strtolower( $url ) )
3448                         return '';
3449         }
3450
3451         /**
3452          * Filter a string cleaned and escaped for output as a URL.
3453          *
3454          * @since 2.3.0
3455          *
3456          * @param string $good_protocol_url The cleaned URL to be returned.
3457          * @param string $original_url      The URL prior to cleaning.
3458          * @param string $_context          If 'display', replace ampersands and single quotes only.
3459          */
3460         return apply_filters( 'clean_url', $good_protocol_url, $original_url, $_context );
3461 }
3462
3463 /**
3464  * Performs esc_url() for database usage.
3465  *
3466  * @since 2.8.0
3467  *
3468  * @param string $url       The URL to be cleaned.
3469  * @param array  $protocols An array of acceptable protocols.
3470  * @return string The cleaned URL.
3471  */
3472 function esc_url_raw( $url, $protocols = null ) {
3473         return esc_url( $url, $protocols, 'db' );
3474 }
3475
3476 /**
3477  * Convert entities, while preserving already-encoded entities.
3478  *
3479  * @link http://www.php.net/htmlentities Borrowed from the PHP Manual user notes.
3480  *
3481  * @since 1.2.2
3482  *
3483  * @param string $myHTML The text to be converted.
3484  * @return string Converted text.
3485  */
3486 function htmlentities2( $myHTML ) {
3487         $translation_table = get_html_translation_table( HTML_ENTITIES, ENT_QUOTES );
3488 &nb