PageRenderTime 66ms CodeModel.GetById 22ms RepoModel.GetById 1ms app.codeStats 0ms

/wp-includes/formatting.php

https://github.com/dipakdotyadav/WordPress
PHP | 3390 lines | 2058 code | 277 blank | 1055 comment | 275 complexity | e40f91bb75c2f45a1c65542692f12914 MD5 | raw file
Possible License(s): GPL-2.0, AGPL-1.0, LGPL-2.1

Large files files are truncated, but you can click here to view the full file

  1. <?php
  2. /**
  3. * Main WordPress Formatting API.
  4. *
  5. * Handles many functions for formatting output.
  6. *
  7. * @package WordPress
  8. */
  9. /**
  10. * Replaces common plain text characters into formatted entities
  11. *
  12. * As an example,
  13. * <code>
  14. * 'cause today's effort makes it worth tomorrow's "holiday"...
  15. * </code>
  16. * Becomes:
  17. * <code>
  18. * &#8217;cause today&#8217;s effort makes it worth tomorrow&#8217;s &#8220;holiday&#8221;&#8230;
  19. * </code>
  20. * Code within certain html blocks are skipped.
  21. *
  22. * @since 0.71
  23. * @uses $wp_cockneyreplace Array of formatted entities for certain common phrases
  24. *
  25. * @param string $text The text to be formatted
  26. * @return string The string replaced with html entities
  27. */
  28. function wptexturize($text) {
  29. global $wp_cockneyreplace;
  30. static $static_characters, $static_replacements, $dynamic_characters, $dynamic_replacements,
  31. $default_no_texturize_tags, $default_no_texturize_shortcodes;
  32. // No need to set up these static variables more than once
  33. if ( ! isset( $static_characters ) ) {
  34. /* translators: opening curly double quote */
  35. $opening_quote = _x( '&#8220;', 'opening curly double quote' );
  36. /* translators: closing curly double quote */
  37. $closing_quote = _x( '&#8221;', 'closing curly double quote' );
  38. /* translators: apostrophe, for example in 'cause or can't */
  39. $apos = _x( '&#8217;', 'apostrophe' );
  40. /* translators: prime, for example in 9' (nine feet) */
  41. $prime = _x( '&#8242;', 'prime' );
  42. /* translators: double prime, for example in 9" (nine inches) */
  43. $double_prime = _x( '&#8243;', 'double prime' );
  44. /* translators: opening curly single quote */
  45. $opening_single_quote = _x( '&#8216;', 'opening curly single quote' );
  46. /* translators: closing curly single quote */
  47. $closing_single_quote = _x( '&#8217;', 'closing curly single quote' );
  48. /* translators: en dash */
  49. $en_dash = _x( '&#8211;', 'en dash' );
  50. /* translators: em dash */
  51. $em_dash = _x( '&#8212;', 'em dash' );
  52. $default_no_texturize_tags = array('pre', 'code', 'kbd', 'style', 'script', 'tt');
  53. $default_no_texturize_shortcodes = array('code');
  54. // if a plugin has provided an autocorrect array, use it
  55. if ( isset($wp_cockneyreplace) ) {
  56. $cockney = array_keys($wp_cockneyreplace);
  57. $cockneyreplace = array_values($wp_cockneyreplace);
  58. } elseif ( "'" != $apos ) { // Only bother if we're doing a replacement.
  59. $cockney = array( "'tain't", "'twere", "'twas", "'tis", "'twill", "'til", "'bout", "'nuff", "'round", "'cause" );
  60. $cockneyreplace = array( $apos . "tain" . $apos . "t", $apos . "twere", $apos . "twas", $apos . "tis", $apos . "twill", $apos . "til", $apos . "bout", $apos . "nuff", $apos . "round", $apos . "cause" );
  61. } else {
  62. $cockney = $cockneyreplace = array();
  63. }
  64. $static_characters = array_merge( array( '---', ' -- ', '--', ' - ', 'xn&#8211;', '...', '``', '\'\'', ' (tm)' ), $cockney );
  65. $static_replacements = array_merge( array( $em_dash, ' ' . $em_dash . ' ', $en_dash, ' ' . $en_dash . ' ', 'xn--', '&#8230;', $opening_quote, $closing_quote, ' &#8482;' ), $cockneyreplace );
  66. $dynamic = array();
  67. if ( "'" != $apos ) {
  68. $dynamic[ '/\'(\d\d(?:&#8217;|\')?s)/' ] = $apos . '$1'; // '99's
  69. $dynamic[ '/\'(\d)/' ] = $apos . '$1'; // '99
  70. }
  71. if ( "'" != $opening_single_quote )
  72. $dynamic[ '/(\s|\A|[([{<]|")\'/' ] = '$1' . $opening_single_quote; // opening single quote, even after (, {, <, [
  73. if ( '"' != $double_prime )
  74. $dynamic[ '/(\d)"/' ] = '$1' . $double_prime; // 9" (double prime)
  75. if ( "'" != $prime )
  76. $dynamic[ '/(\d)\'/' ] = '$1' . $prime; // 9' (prime)
  77. if ( "'" != $apos )
  78. $dynamic[ '/(\S)\'([^\'\s])/' ] = '$1' . $apos . '$2'; // apostrophe in a word
  79. if ( '"' != $opening_quote )
  80. $dynamic[ '/(\s|\A|[([{<])"(?!\s)/' ] = '$1' . $opening_quote . '$2'; // opening double quote, even after (, {, <, [
  81. if ( '"' != $closing_quote )
  82. $dynamic[ '/"(\s|\S|\Z)/' ] = $closing_quote . '$1'; // closing double quote
  83. if ( "'" != $closing_single_quote )
  84. $dynamic[ '/\'([\s.]|\Z)/' ] = $closing_single_quote . '$1'; // closing single quote
  85. $dynamic[ '/\b(\d+)x(\d+)\b/' ] = '$1&#215;$2'; // 9x9 (times)
  86. $dynamic_characters = array_keys( $dynamic );
  87. $dynamic_replacements = array_values( $dynamic );
  88. }
  89. // Transform into regexp sub-expression used in _wptexturize_pushpop_element
  90. // Must do this every time in case plugins use these filters in a context sensitive manner
  91. $no_texturize_tags = '(' . implode('|', apply_filters('no_texturize_tags', $default_no_texturize_tags) ) . ')';
  92. $no_texturize_shortcodes = '(' . implode('|', apply_filters('no_texturize_shortcodes', $default_no_texturize_shortcodes) ) . ')';
  93. $no_texturize_tags_stack = array();
  94. $no_texturize_shortcodes_stack = array();
  95. $textarr = preg_split('/(<.*>|\[.*\])/Us', $text, -1, PREG_SPLIT_DELIM_CAPTURE);
  96. foreach ( $textarr as &$curl ) {
  97. if ( empty( $curl ) )
  98. continue;
  99. // Only call _wptexturize_pushpop_element if first char is correct tag opening
  100. $first = $curl[0];
  101. if ( '<' === $first ) {
  102. _wptexturize_pushpop_element($curl, $no_texturize_tags_stack, $no_texturize_tags, '<', '>');
  103. } elseif ( '[' === $first ) {
  104. _wptexturize_pushpop_element($curl, $no_texturize_shortcodes_stack, $no_texturize_shortcodes, '[', ']');
  105. } elseif ( empty($no_texturize_shortcodes_stack) && empty($no_texturize_tags_stack) ) {
  106. // This is not a tag, nor is the texturization disabled static strings
  107. $curl = str_replace($static_characters, $static_replacements, $curl);
  108. // regular expressions
  109. $curl = preg_replace($dynamic_characters, $dynamic_replacements, $curl);
  110. }
  111. $curl = preg_replace('/&([^#])(?![a-zA-Z1-4]{1,8};)/', '&#038;$1', $curl);
  112. }
  113. return implode( '', $textarr );
  114. }
  115. /**
  116. * Search for disabled element tags. Push element to stack on tag open and pop
  117. * on tag close. Assumes first character of $text is tag opening.
  118. *
  119. * @since 2.9.0
  120. * @access private
  121. *
  122. * @param string $text Text to check. First character is assumed to be $opening
  123. * @param array $stack Array used as stack of opened tag elements
  124. * @param string $disabled_elements Tags to match against formatted as regexp sub-expression
  125. * @param string $opening Tag opening character, assumed to be 1 character long
  126. * @param string $closing Tag closing character
  127. */
  128. function _wptexturize_pushpop_element($text, &$stack, $disabled_elements, $opening = '<', $closing = '>') {
  129. // Check if it is a closing tag -- otherwise assume opening tag
  130. if (strncmp($opening . '/', $text, 2)) {
  131. // Opening? Check $text+1 against disabled elements
  132. if (preg_match('/^' . $disabled_elements . '\b/', substr($text, 1), $matches)) {
  133. /*
  134. * This disables texturize until we find a closing tag of our type
  135. * (e.g. <pre>) even if there was invalid nesting before that
  136. *
  137. * Example: in the case <pre>sadsadasd</code>"baba"</pre>
  138. * "baba" won't be texturize
  139. */
  140. array_push($stack, $matches[1]);
  141. }
  142. } else {
  143. // Closing? Check $text+2 against disabled elements
  144. $c = preg_quote($closing, '/');
  145. if (preg_match('/^' . $disabled_elements . $c . '/', substr($text, 2), $matches)) {
  146. $last = array_pop($stack);
  147. // Make sure it matches the opening tag
  148. if ($last != $matches[1])
  149. array_push($stack, $last);
  150. }
  151. }
  152. }
  153. /**
  154. * Replaces double line-breaks with paragraph elements.
  155. *
  156. * A group of regex replaces used to identify text formatted with newlines and
  157. * replace double line-breaks with HTML paragraph tags. The remaining
  158. * line-breaks after conversion become <<br />> tags, unless $br is set to '0'
  159. * or 'false'.
  160. *
  161. * @since 0.71
  162. *
  163. * @param string $pee The text which has to be formatted.
  164. * @param bool $br Optional. If set, this will convert all remaining line-breaks after paragraphing. Default true.
  165. * @return string Text which has been converted into correct paragraph tags.
  166. */
  167. function wpautop($pee, $br = true) {
  168. $pre_tags = array();
  169. if ( trim($pee) === '' )
  170. return '';
  171. $pee = $pee . "\n"; // just to make things a little easier, pad the end
  172. if ( strpos($pee, '<pre') !== false ) {
  173. $pee_parts = explode( '</pre>', $pee );
  174. $last_pee = array_pop($pee_parts);
  175. $pee = '';
  176. $i = 0;
  177. foreach ( $pee_parts as $pee_part ) {
  178. $start = strpos($pee_part, '<pre');
  179. // Malformed html?
  180. if ( $start === false ) {
  181. $pee .= $pee_part;
  182. continue;
  183. }
  184. $name = "<pre wp-pre-tag-$i></pre>";
  185. $pre_tags[$name] = substr( $pee_part, $start ) . '</pre>';
  186. $pee .= substr( $pee_part, 0, $start ) . $name;
  187. $i++;
  188. }
  189. $pee .= $last_pee;
  190. }
  191. $pee = preg_replace('|<br />\s*<br />|', "\n\n", $pee);
  192. // Space things out a little
  193. $allblocks = '(?:table|thead|tfoot|caption|col|colgroup|tbody|tr|td|th|div|dl|dd|dt|ul|ol|li|pre|select|option|form|map|area|blockquote|address|math|style|p|h[1-6]|hr|fieldset|noscript|legend|section|article|aside|hgroup|header|footer|nav|figure|figcaption|details|menu|summary)';
  194. $pee = preg_replace('!(<' . $allblocks . '[^>]*>)!', "\n$1", $pee);
  195. $pee = preg_replace('!(</' . $allblocks . '>)!', "$1\n\n", $pee);
  196. $pee = str_replace(array("\r\n", "\r"), "\n", $pee); // cross-platform newlines
  197. if ( strpos($pee, '<object') !== false ) {
  198. $pee = preg_replace('|\s*<param([^>]*)>\s*|', "<param$1>", $pee); // no pee inside object/embed
  199. $pee = preg_replace('|\s*</embed>\s*|', '</embed>', $pee);
  200. }
  201. $pee = preg_replace("/\n\n+/", "\n\n", $pee); // take care of duplicates
  202. // make paragraphs, including one at the end
  203. $pees = preg_split('/\n\s*\n/', $pee, -1, PREG_SPLIT_NO_EMPTY);
  204. $pee = '';
  205. foreach ( $pees as $tinkle )
  206. $pee .= '<p>' . trim($tinkle, "\n") . "</p>\n";
  207. $pee = preg_replace('|<p>\s*</p>|', '', $pee); // under certain strange conditions it could create a P of entirely whitespace
  208. $pee = preg_replace('!<p>([^<]+)</(div|address|form)>!', "<p>$1</p></$2>", $pee);
  209. $pee = preg_replace('!<p>\s*(</?' . $allblocks . '[^>]*>)\s*</p>!', "$1", $pee); // don't pee all over a tag
  210. $pee = preg_replace("|<p>(<li.+?)</p>|", "$1", $pee); // problem with nested lists
  211. $pee = preg_replace('|<p><blockquote([^>]*)>|i', "<blockquote$1><p>", $pee);
  212. $pee = str_replace('</blockquote></p>', '</p></blockquote>', $pee);
  213. $pee = preg_replace('!<p>\s*(</?' . $allblocks . '[^>]*>)!', "$1", $pee);
  214. $pee = preg_replace('!(</?' . $allblocks . '[^>]*>)\s*</p>!', "$1", $pee);
  215. if ( $br ) {
  216. $pee = preg_replace_callback('/<(script|style).*?<\/\\1>/s', '_autop_newline_preservation_helper', $pee);
  217. $pee = preg_replace('|(?<!<br />)\s*\n|', "<br />\n", $pee); // optionally make line breaks
  218. $pee = str_replace('<WPPreserveNewline />', "\n", $pee);
  219. }
  220. $pee = preg_replace('!(</?' . $allblocks . '[^>]*>)\s*<br />!', "$1", $pee);
  221. $pee = preg_replace('!<br />(\s*</?(?:p|li|div|dl|dd|dt|th|pre|td|ul|ol)[^>]*>)!', '$1', $pee);
  222. $pee = preg_replace( "|\n</p>$|", '</p>', $pee );
  223. if ( !empty($pre_tags) )
  224. $pee = str_replace(array_keys($pre_tags), array_values($pre_tags), $pee);
  225. return $pee;
  226. }
  227. /**
  228. * Newline preservation help function for wpautop
  229. *
  230. * @since 3.1.0
  231. * @access private
  232. *
  233. * @param array $matches preg_replace_callback matches array
  234. * @return string
  235. */
  236. function _autop_newline_preservation_helper( $matches ) {
  237. return str_replace("\n", "<WPPreserveNewline />", $matches[0]);
  238. }
  239. /**
  240. * Don't auto-p wrap shortcodes that stand alone
  241. *
  242. * Ensures that shortcodes are not wrapped in <<p>>...<</p>>.
  243. *
  244. * @since 2.9.0
  245. *
  246. * @param string $pee The content.
  247. * @return string The filtered content.
  248. */
  249. function shortcode_unautop( $pee ) {
  250. global $shortcode_tags;
  251. if ( empty( $shortcode_tags ) || !is_array( $shortcode_tags ) ) {
  252. return $pee;
  253. }
  254. $tagregexp = join( '|', array_map( 'preg_quote', array_keys( $shortcode_tags ) ) );
  255. $pattern =
  256. '/'
  257. . '<p>' // Opening paragraph
  258. . '\\s*+' // Optional leading whitespace
  259. . '(' // 1: The shortcode
  260. . '\\[' // Opening bracket
  261. . "($tagregexp)" // 2: Shortcode name
  262. . '(?![\\w-])' // Not followed by word character or hyphen
  263. // Unroll the loop: Inside the opening shortcode tag
  264. . '[^\\]\\/]*' // Not a closing bracket or forward slash
  265. . '(?:'
  266. . '\\/(?!\\])' // A forward slash not followed by a closing bracket
  267. . '[^\\]\\/]*' // Not a closing bracket or forward slash
  268. . ')*?'
  269. . '(?:'
  270. . '\\/\\]' // Self closing tag and closing bracket
  271. . '|'
  272. . '\\]' // Closing bracket
  273. . '(?:' // Unroll the loop: Optionally, anything between the opening and closing shortcode tags
  274. . '[^\\[]*+' // Not an opening bracket
  275. . '(?:'
  276. . '\\[(?!\\/\\2\\])' // An opening bracket not followed by the closing shortcode tag
  277. . '[^\\[]*+' // Not an opening bracket
  278. . ')*+'
  279. . '\\[\\/\\2\\]' // Closing shortcode tag
  280. . ')?'
  281. . ')'
  282. . ')'
  283. . '\\s*+' // optional trailing whitespace
  284. . '<\\/p>' // closing paragraph
  285. . '/s';
  286. return preg_replace( $pattern, '$1', $pee );
  287. }
  288. /**
  289. * Checks to see if a string is utf8 encoded.
  290. *
  291. * NOTE: This function checks for 5-Byte sequences, UTF8
  292. * has Bytes Sequences with a maximum length of 4.
  293. *
  294. * @author bmorel at ssi dot fr (modified)
  295. * @since 1.2.1
  296. *
  297. * @param string $str The string to be checked
  298. * @return bool True if $str fits a UTF-8 model, false otherwise.
  299. */
  300. function seems_utf8($str) {
  301. $length = strlen($str);
  302. for ($i=0; $i < $length; $i++) {
  303. $c = ord($str[$i]);
  304. if ($c < 0x80) $n = 0; # 0bbbbbbb
  305. elseif (($c & 0xE0) == 0xC0) $n=1; # 110bbbbb
  306. elseif (($c & 0xF0) == 0xE0) $n=2; # 1110bbbb
  307. elseif (($c & 0xF8) == 0xF0) $n=3; # 11110bbb
  308. elseif (($c & 0xFC) == 0xF8) $n=4; # 111110bb
  309. elseif (($c & 0xFE) == 0xFC) $n=5; # 1111110b
  310. else return false; # Does not match any model
  311. for ($j=0; $j<$n; $j++) { # n bytes matching 10bbbbbb follow ?
  312. if ((++$i == $length) || ((ord($str[$i]) & 0xC0) != 0x80))
  313. return false;
  314. }
  315. }
  316. return true;
  317. }
  318. /**
  319. * Converts a number of special characters into their HTML entities.
  320. *
  321. * Specifically deals with: &, <, >, ", and '.
  322. *
  323. * $quote_style can be set to ENT_COMPAT to encode " to
  324. * &quot;, or ENT_QUOTES to do both. Default is ENT_NOQUOTES where no quotes are encoded.
  325. *
  326. * @since 1.2.2
  327. * @access private
  328. *
  329. * @param string $string The text which is to be encoded.
  330. * @param mixed $quote_style Optional. Converts double quotes if set to ENT_COMPAT, both single and double if set to ENT_QUOTES or none if set to ENT_NOQUOTES. Also compatible with old values; converting single quotes if set to 'single', double if set to 'double' or both if otherwise set. Default is ENT_NOQUOTES.
  331. * @param string $charset Optional. The character encoding of the string. Default is false.
  332. * @param boolean $double_encode Optional. Whether to encode existing html entities. Default is false.
  333. * @return string The encoded text with HTML entities.
  334. */
  335. function _wp_specialchars( $string, $quote_style = ENT_NOQUOTES, $charset = false, $double_encode = false ) {
  336. $string = (string) $string;
  337. if ( 0 === strlen( $string ) )
  338. return '';
  339. // Don't bother if there are no specialchars - saves some processing
  340. if ( ! preg_match( '/[&<>"\']/', $string ) )
  341. return $string;
  342. // Account for the previous behaviour of the function when the $quote_style is not an accepted value
  343. if ( empty( $quote_style ) )
  344. $quote_style = ENT_NOQUOTES;
  345. elseif ( ! in_array( $quote_style, array( 0, 2, 3, 'single', 'double' ), true ) )
  346. $quote_style = ENT_QUOTES;
  347. // Store the site charset as a static to avoid multiple calls to wp_load_alloptions()
  348. if ( ! $charset ) {
  349. static $_charset;
  350. if ( ! isset( $_charset ) ) {
  351. $alloptions = wp_load_alloptions();
  352. $_charset = isset( $alloptions['blog_charset'] ) ? $alloptions['blog_charset'] : '';
  353. }
  354. $charset = $_charset;
  355. }
  356. if ( in_array( $charset, array( 'utf8', 'utf-8', 'UTF8' ) ) )
  357. $charset = 'UTF-8';
  358. $_quote_style = $quote_style;
  359. if ( $quote_style === 'double' ) {
  360. $quote_style = ENT_COMPAT;
  361. $_quote_style = ENT_COMPAT;
  362. } elseif ( $quote_style === 'single' ) {
  363. $quote_style = ENT_NOQUOTES;
  364. }
  365. // Handle double encoding ourselves
  366. if ( $double_encode ) {
  367. $string = @htmlspecialchars( $string, $quote_style, $charset );
  368. } else {
  369. // Decode &amp; into &
  370. $string = wp_specialchars_decode( $string, $_quote_style );
  371. // Guarantee every &entity; is valid or re-encode the &
  372. $string = wp_kses_normalize_entities( $string );
  373. // Now re-encode everything except &entity;
  374. $string = preg_split( '/(&#?x?[0-9a-z]+;)/i', $string, -1, PREG_SPLIT_DELIM_CAPTURE );
  375. for ( $i = 0; $i < count( $string ); $i += 2 )
  376. $string[$i] = @htmlspecialchars( $string[$i], $quote_style, $charset );
  377. $string = implode( '', $string );
  378. }
  379. // Backwards compatibility
  380. if ( 'single' === $_quote_style )
  381. $string = str_replace( "'", '&#039;', $string );
  382. return $string;
  383. }
  384. /**
  385. * Converts a number of HTML entities into their special characters.
  386. *
  387. * Specifically deals with: &, <, >, ", and '.
  388. *
  389. * $quote_style can be set to ENT_COMPAT to decode " entities,
  390. * or ENT_QUOTES to do both " and '. Default is ENT_NOQUOTES where no quotes are decoded.
  391. *
  392. * @since 2.8.0
  393. *
  394. * @param string $string The text which is to be decoded.
  395. * @param mixed $quote_style Optional. Converts double quotes if set to ENT_COMPAT, both single and double if set to ENT_QUOTES or none if set to ENT_NOQUOTES. Also compatible with old _wp_specialchars() values; converting single quotes if set to 'single', double if set to 'double' or both if otherwise set. Default is ENT_NOQUOTES.
  396. * @return string The decoded text without HTML entities.
  397. */
  398. function wp_specialchars_decode( $string, $quote_style = ENT_NOQUOTES ) {
  399. $string = (string) $string;
  400. if ( 0 === strlen( $string ) ) {
  401. return '';
  402. }
  403. // Don't bother if there are no entities - saves a lot of processing
  404. if ( strpos( $string, '&' ) === false ) {
  405. return $string;
  406. }
  407. // Match the previous behaviour of _wp_specialchars() when the $quote_style is not an accepted value
  408. if ( empty( $quote_style ) ) {
  409. $quote_style = ENT_NOQUOTES;
  410. } elseif ( !in_array( $quote_style, array( 0, 2, 3, 'single', 'double' ), true ) ) {
  411. $quote_style = ENT_QUOTES;
  412. }
  413. // More complete than get_html_translation_table( HTML_SPECIALCHARS )
  414. $single = array( '&#039;' => '\'', '&#x27;' => '\'' );
  415. $single_preg = array( '/&#0*39;/' => '&#039;', '/&#x0*27;/i' => '&#x27;' );
  416. $double = array( '&quot;' => '"', '&#034;' => '"', '&#x22;' => '"' );
  417. $double_preg = array( '/&#0*34;/' => '&#034;', '/&#x0*22;/i' => '&#x22;' );
  418. $others = array( '&lt;' => '<', '&#060;' => '<', '&gt;' => '>', '&#062;' => '>', '&amp;' => '&', '&#038;' => '&', '&#x26;' => '&' );
  419. $others_preg = array( '/&#0*60;/' => '&#060;', '/&#0*62;/' => '&#062;', '/&#0*38;/' => '&#038;', '/&#x0*26;/i' => '&#x26;' );
  420. if ( $quote_style === ENT_QUOTES ) {
  421. $translation = array_merge( $single, $double, $others );
  422. $translation_preg = array_merge( $single_preg, $double_preg, $others_preg );
  423. } elseif ( $quote_style === ENT_COMPAT || $quote_style === 'double' ) {
  424. $translation = array_merge( $double, $others );
  425. $translation_preg = array_merge( $double_preg, $others_preg );
  426. } elseif ( $quote_style === 'single' ) {
  427. $translation = array_merge( $single, $others );
  428. $translation_preg = array_merge( $single_preg, $others_preg );
  429. } elseif ( $quote_style === ENT_NOQUOTES ) {
  430. $translation = $others;
  431. $translation_preg = $others_preg;
  432. }
  433. // Remove zero padding on numeric entities
  434. $string = preg_replace( array_keys( $translation_preg ), array_values( $translation_preg ), $string );
  435. // Replace characters according to translation table
  436. return strtr( $string, $translation );
  437. }
  438. /**
  439. * Checks for invalid UTF8 in a string.
  440. *
  441. * @since 2.8.0
  442. *
  443. * @param string $string The text which is to be checked.
  444. * @param boolean $strip Optional. Whether to attempt to strip out invalid UTF8. Default is false.
  445. * @return string The checked text.
  446. */
  447. function wp_check_invalid_utf8( $string, $strip = false ) {
  448. $string = (string) $string;
  449. if ( 0 === strlen( $string ) ) {
  450. return '';
  451. }
  452. // Store the site charset as a static to avoid multiple calls to get_option()
  453. static $is_utf8;
  454. if ( !isset( $is_utf8 ) ) {
  455. $is_utf8 = in_array( get_option( 'blog_charset' ), array( 'utf8', 'utf-8', 'UTF8', 'UTF-8' ) );
  456. }
  457. if ( !$is_utf8 ) {
  458. return $string;
  459. }
  460. // Check for support for utf8 in the installed PCRE library once and store the result in a static
  461. static $utf8_pcre;
  462. if ( !isset( $utf8_pcre ) ) {
  463. $utf8_pcre = @preg_match( '/^./u', 'a' );
  464. }
  465. // We can't demand utf8 in the PCRE installation, so just return the string in those cases
  466. if ( !$utf8_pcre ) {
  467. return $string;
  468. }
  469. // preg_match fails when it encounters invalid UTF8 in $string
  470. if ( 1 === @preg_match( '/^./us', $string ) ) {
  471. return $string;
  472. }
  473. // Attempt to strip the bad chars if requested (not recommended)
  474. if ( $strip && function_exists( 'iconv' ) ) {
  475. return iconv( 'utf-8', 'utf-8', $string );
  476. }
  477. return '';
  478. }
  479. /**
  480. * Encode the Unicode values to be used in the URI.
  481. *
  482. * @since 1.5.0
  483. *
  484. * @param string $utf8_string
  485. * @param int $length Max length of the string
  486. * @return string String with Unicode encoded for URI.
  487. */
  488. function utf8_uri_encode( $utf8_string, $length = 0 ) {
  489. $unicode = '';
  490. $values = array();
  491. $num_octets = 1;
  492. $unicode_length = 0;
  493. $string_length = strlen( $utf8_string );
  494. for ($i = 0; $i < $string_length; $i++ ) {
  495. $value = ord( $utf8_string[ $i ] );
  496. if ( $value < 128 ) {
  497. if ( $length && ( $unicode_length >= $length ) )
  498. break;
  499. $unicode .= chr($value);
  500. $unicode_length++;
  501. } else {
  502. if ( count( $values ) == 0 ) $num_octets = ( $value < 224 ) ? 2 : 3;
  503. $values[] = $value;
  504. if ( $length && ( $unicode_length + ($num_octets * 3) ) > $length )
  505. break;
  506. if ( count( $values ) == $num_octets ) {
  507. if ($num_octets == 3) {
  508. $unicode .= '%' . dechex($values[0]) . '%' . dechex($values[1]) . '%' . dechex($values[2]);
  509. $unicode_length += 9;
  510. } else {
  511. $unicode .= '%' . dechex($values[0]) . '%' . dechex($values[1]);
  512. $unicode_length += 6;
  513. }
  514. $values = array();
  515. $num_octets = 1;
  516. }
  517. }
  518. }
  519. return $unicode;
  520. }
  521. /**
  522. * Converts all accent characters to ASCII characters.
  523. *
  524. * If there are no accent characters, then the string given is just returned.
  525. *
  526. * @since 1.2.1
  527. *
  528. * @param string $string Text that might have accent characters
  529. * @return string Filtered string with replaced "nice" characters.
  530. */
  531. function remove_accents($string) {
  532. if ( !preg_match('/[\x80-\xff]/', $string) )
  533. return $string;
  534. if (seems_utf8($string)) {
  535. $chars = array(
  536. // Decompositions for Latin-1 Supplement
  537. chr(194).chr(170) => 'a', chr(194).chr(186) => 'o',
  538. chr(195).chr(128) => 'A', chr(195).chr(129) => 'A',
  539. chr(195).chr(130) => 'A', chr(195).chr(131) => 'A',
  540. chr(195).chr(132) => 'A', chr(195).chr(133) => 'A',
  541. chr(195).chr(134) => 'AE',chr(195).chr(135) => 'C',
  542. chr(195).chr(136) => 'E', chr(195).chr(137) => 'E',
  543. chr(195).chr(138) => 'E', chr(195).chr(139) => 'E',
  544. chr(195).chr(140) => 'I', chr(195).chr(141) => 'I',
  545. chr(195).chr(142) => 'I', chr(195).chr(143) => 'I',
  546. chr(195).chr(144) => 'D', chr(195).chr(145) => 'N',
  547. chr(195).chr(146) => 'O', chr(195).chr(147) => 'O',
  548. chr(195).chr(148) => 'O', chr(195).chr(149) => 'O',
  549. chr(195).chr(150) => 'O', chr(195).chr(153) => 'U',
  550. chr(195).chr(154) => 'U', chr(195).chr(155) => 'U',
  551. chr(195).chr(156) => 'U', chr(195).chr(157) => 'Y',
  552. chr(195).chr(158) => 'TH',chr(195).chr(159) => 's',
  553. chr(195).chr(160) => 'a', chr(195).chr(161) => 'a',
  554. chr(195).chr(162) => 'a', chr(195).chr(163) => 'a',
  555. chr(195).chr(164) => 'a', chr(195).chr(165) => 'a',
  556. chr(195).chr(166) => 'ae',chr(195).chr(167) => 'c',
  557. chr(195).chr(168) => 'e', chr(195).chr(169) => 'e',
  558. chr(195).chr(170) => 'e', chr(195).chr(171) => 'e',
  559. chr(195).chr(172) => 'i', chr(195).chr(173) => 'i',
  560. chr(195).chr(174) => 'i', chr(195).chr(175) => 'i',
  561. chr(195).chr(176) => 'd', chr(195).chr(177) => 'n',
  562. chr(195).chr(178) => 'o', chr(195).chr(179) => 'o',
  563. chr(195).chr(180) => 'o', chr(195).chr(181) => 'o',
  564. chr(195).chr(182) => 'o', chr(195).chr(184) => 'o',
  565. chr(195).chr(185) => 'u', chr(195).chr(186) => 'u',
  566. chr(195).chr(187) => 'u', chr(195).chr(188) => 'u',
  567. chr(195).chr(189) => 'y', chr(195).chr(190) => 'th',
  568. chr(195).chr(191) => 'y', chr(195).chr(152) => 'O',
  569. // Decompositions for Latin Extended-A
  570. chr(196).chr(128) => 'A', chr(196).chr(129) => 'a',
  571. chr(196).chr(130) => 'A', chr(196).chr(131) => 'a',
  572. chr(196).chr(132) => 'A', chr(196).chr(133) => 'a',
  573. chr(196).chr(134) => 'C', chr(196).chr(135) => 'c',
  574. chr(196).chr(136) => 'C', chr(196).chr(137) => 'c',
  575. chr(196).chr(138) => 'C', chr(196).chr(139) => 'c',
  576. chr(196).chr(140) => 'C', chr(196).chr(141) => 'c',
  577. chr(196).chr(142) => 'D', chr(196).chr(143) => 'd',
  578. chr(196).chr(144) => 'D', chr(196).chr(145) => 'd',
  579. chr(196).chr(146) => 'E', chr(196).chr(147) => 'e',
  580. chr(196).chr(148) => 'E', chr(196).chr(149) => 'e',
  581. chr(196).chr(150) => 'E', chr(196).chr(151) => 'e',
  582. chr(196).chr(152) => 'E', chr(196).chr(153) => 'e',
  583. chr(196).chr(154) => 'E', chr(196).chr(155) => 'e',
  584. chr(196).chr(156) => 'G', chr(196).chr(157) => 'g',
  585. chr(196).chr(158) => 'G', chr(196).chr(159) => 'g',
  586. chr(196).chr(160) => 'G', chr(196).chr(161) => 'g',
  587. chr(196).chr(162) => 'G', chr(196).chr(163) => 'g',
  588. chr(196).chr(164) => 'H', chr(196).chr(165) => 'h',
  589. chr(196).chr(166) => 'H', chr(196).chr(167) => 'h',
  590. chr(196).chr(168) => 'I', chr(196).chr(169) => 'i',
  591. chr(196).chr(170) => 'I', chr(196).chr(171) => 'i',
  592. chr(196).chr(172) => 'I', chr(196).chr(173) => 'i',
  593. chr(196).chr(174) => 'I', chr(196).chr(175) => 'i',
  594. chr(196).chr(176) => 'I', chr(196).chr(177) => 'i',
  595. chr(196).chr(178) => 'IJ',chr(196).chr(179) => 'ij',
  596. chr(196).chr(180) => 'J', chr(196).chr(181) => 'j',
  597. chr(196).chr(182) => 'K', chr(196).chr(183) => 'k',
  598. chr(196).chr(184) => 'k', chr(196).chr(185) => 'L',
  599. chr(196).chr(186) => 'l', chr(196).chr(187) => 'L',
  600. chr(196).chr(188) => 'l', chr(196).chr(189) => 'L',
  601. chr(196).chr(190) => 'l', chr(196).chr(191) => 'L',
  602. chr(197).chr(128) => 'l', chr(197).chr(129) => 'L',
  603. chr(197).chr(130) => 'l', chr(197).chr(131) => 'N',
  604. chr(197).chr(132) => 'n', chr(197).chr(133) => 'N',
  605. chr(197).chr(134) => 'n', chr(197).chr(135) => 'N',
  606. chr(197).chr(136) => 'n', chr(197).chr(137) => 'N',
  607. chr(197).chr(138) => 'n', chr(197).chr(139) => 'N',
  608. chr(197).chr(140) => 'O', chr(197).chr(141) => 'o',
  609. chr(197).chr(142) => 'O', chr(197).chr(143) => 'o',
  610. chr(197).chr(144) => 'O', chr(197).chr(145) => 'o',
  611. chr(197).chr(146) => 'OE',chr(197).chr(147) => 'oe',
  612. chr(197).chr(148) => 'R',chr(197).chr(149) => 'r',
  613. chr(197).chr(150) => 'R',chr(197).chr(151) => 'r',
  614. chr(197).chr(152) => 'R',chr(197).chr(153) => 'r',
  615. chr(197).chr(154) => 'S',chr(197).chr(155) => 's',
  616. chr(197).chr(156) => 'S',chr(197).chr(157) => 's',
  617. chr(197).chr(158) => 'S',chr(197).chr(159) => 's',
  618. chr(197).chr(160) => 'S', chr(197).chr(161) => 's',
  619. chr(197).chr(162) => 'T', chr(197).chr(163) => 't',
  620. chr(197).chr(164) => 'T', chr(197).chr(165) => 't',
  621. chr(197).chr(166) => 'T', chr(197).chr(167) => 't',
  622. chr(197).chr(168) => 'U', chr(197).chr(169) => 'u',
  623. chr(197).chr(170) => 'U', chr(197).chr(171) => 'u',
  624. chr(197).chr(172) => 'U', chr(197).chr(173) => 'u',
  625. chr(197).chr(174) => 'U', chr(197).chr(175) => 'u',
  626. chr(197).chr(176) => 'U', chr(197).chr(177) => 'u',
  627. chr(197).chr(178) => 'U', chr(197).chr(179) => 'u',
  628. chr(197).chr(180) => 'W', chr(197).chr(181) => 'w',
  629. chr(197).chr(182) => 'Y', chr(197).chr(183) => 'y',
  630. chr(197).chr(184) => 'Y', chr(197).chr(185) => 'Z',
  631. chr(197).chr(186) => 'z', chr(197).chr(187) => 'Z',
  632. chr(197).chr(188) => 'z', chr(197).chr(189) => 'Z',
  633. chr(197).chr(190) => 'z', chr(197).chr(191) => 's',
  634. // Decompositions for Latin Extended-B
  635. chr(200).chr(152) => 'S', chr(200).chr(153) => 's',
  636. chr(200).chr(154) => 'T', chr(200).chr(155) => 't',
  637. // Euro Sign
  638. chr(226).chr(130).chr(172) => 'E',
  639. // GBP (Pound) Sign
  640. chr(194).chr(163) => '',
  641. // Vowels with diacritic (Vietnamese)
  642. // unmarked
  643. chr(198).chr(160) => 'O', chr(198).chr(161) => 'o',
  644. chr(198).chr(175) => 'U', chr(198).chr(176) => 'u',
  645. // grave accent
  646. chr(225).chr(186).chr(166) => 'A', chr(225).chr(186).chr(167) => 'a',
  647. chr(225).chr(186).chr(176) => 'A', chr(225).chr(186).chr(177) => 'a',
  648. chr(225).chr(187).chr(128) => 'E', chr(225).chr(187).chr(129) => 'e',
  649. chr(225).chr(187).chr(146) => 'O', chr(225).chr(187).chr(147) => 'o',
  650. chr(225).chr(187).chr(156) => 'O', chr(225).chr(187).chr(157) => 'o',
  651. chr(225).chr(187).chr(170) => 'U', chr(225).chr(187).chr(171) => 'u',
  652. chr(225).chr(187).chr(178) => 'Y', chr(225).chr(187).chr(179) => 'y',
  653. // hook
  654. chr(225).chr(186).chr(162) => 'A', chr(225).chr(186).chr(163) => 'a',
  655. chr(225).chr(186).chr(168) => 'A', chr(225).chr(186).chr(169) => 'a',
  656. chr(225).chr(186).chr(178) => 'A', chr(225).chr(186).chr(179) => 'a',
  657. chr(225).chr(186).chr(186) => 'E', chr(225).chr(186).chr(187) => 'e',
  658. chr(225).chr(187).chr(130) => 'E', chr(225).chr(187).chr(131) => 'e',
  659. chr(225).chr(187).chr(136) => 'I', chr(225).chr(187).chr(137) => 'i',
  660. chr(225).chr(187).chr(142) => 'O', chr(225).chr(187).chr(143) => 'o',
  661. chr(225).chr(187).chr(148) => 'O', chr(225).chr(187).chr(149) => 'o',
  662. chr(225).chr(187).chr(158) => 'O', chr(225).chr(187).chr(159) => 'o',
  663. chr(225).chr(187).chr(166) => 'U', chr(225).chr(187).chr(167) => 'u',
  664. chr(225).chr(187).chr(172) => 'U', chr(225).chr(187).chr(173) => 'u',
  665. chr(225).chr(187).chr(182) => 'Y', chr(225).chr(187).chr(183) => 'y',
  666. // tilde
  667. chr(225).chr(186).chr(170) => 'A', chr(225).chr(186).chr(171) => 'a',
  668. chr(225).chr(186).chr(180) => 'A', chr(225).chr(186).chr(181) => 'a',
  669. chr(225).chr(186).chr(188) => 'E', chr(225).chr(186).chr(189) => 'e',
  670. chr(225).chr(187).chr(132) => 'E', chr(225).chr(187).chr(133) => 'e',
  671. chr(225).chr(187).chr(150) => 'O', chr(225).chr(187).chr(151) => 'o',
  672. chr(225).chr(187).chr(160) => 'O', chr(225).chr(187).chr(161) => 'o',
  673. chr(225).chr(187).chr(174) => 'U', chr(225).chr(187).chr(175) => 'u',
  674. chr(225).chr(187).chr(184) => 'Y', chr(225).chr(187).chr(185) => 'y',
  675. // acute accent
  676. chr(225).chr(186).chr(164) => 'A', chr(225).chr(186).chr(165) => 'a',
  677. chr(225).chr(186).chr(174) => 'A', chr(225).chr(186).chr(175) => 'a',
  678. chr(225).chr(186).chr(190) => 'E', chr(225).chr(186).chr(191) => 'e',
  679. chr(225).chr(187).chr(144) => 'O', chr(225).chr(187).chr(145) => 'o',
  680. chr(225).chr(187).chr(154) => 'O', chr(225).chr(187).chr(155) => 'o',
  681. chr(225).chr(187).chr(168) => 'U', chr(225).chr(187).chr(169) => 'u',
  682. // dot below
  683. chr(225).chr(186).chr(160) => 'A', chr(225).chr(186).chr(161) => 'a',
  684. chr(225).chr(186).chr(172) => 'A', chr(225).chr(186).chr(173) => 'a',
  685. chr(225).chr(186).chr(182) => 'A', chr(225).chr(186).chr(183) => 'a',
  686. chr(225).chr(186).chr(184) => 'E', chr(225).chr(186).chr(185) => 'e',
  687. chr(225).chr(187).chr(134) => 'E', chr(225).chr(187).chr(135) => 'e',
  688. chr(225).chr(187).chr(138) => 'I', chr(225).chr(187).chr(139) => 'i',
  689. chr(225).chr(187).chr(140) => 'O', chr(225).chr(187).chr(141) => 'o',
  690. chr(225).chr(187).chr(152) => 'O', chr(225).chr(187).chr(153) => 'o',
  691. chr(225).chr(187).chr(162) => 'O', chr(225).chr(187).chr(163) => 'o',
  692. chr(225).chr(187).chr(164) => 'U', chr(225).chr(187).chr(165) => 'u',
  693. chr(225).chr(187).chr(176) => 'U', chr(225).chr(187).chr(177) => 'u',
  694. chr(225).chr(187).chr(180) => 'Y', chr(225).chr(187).chr(181) => 'y',
  695. // Vowels with diacritic (Chinese, Hanyu Pinyin)
  696. chr(201).chr(145) => 'a',
  697. // macron
  698. chr(199).chr(149) => 'U', chr(199).chr(150) => 'u',
  699. // acute accent
  700. chr(199).chr(151) => 'U', chr(199).chr(152) => 'u',
  701. // caron
  702. chr(199).chr(141) => 'A', chr(199).chr(142) => 'a',
  703. chr(199).chr(143) => 'I', chr(199).chr(144) => 'i',
  704. chr(199).chr(145) => 'O', chr(199).chr(146) => 'o',
  705. chr(199).chr(147) => 'U', chr(199).chr(148) => 'u',
  706. chr(199).chr(153) => 'U', chr(199).chr(154) => 'u',
  707. // grave accent
  708. chr(199).chr(155) => 'U', chr(199).chr(156) => 'u',
  709. );
  710. // Used for locale-specific rules
  711. $locale = get_locale();
  712. if ( 'de_DE' == $locale ) {
  713. $chars[ chr(195).chr(132) ] = 'Ae';
  714. $chars[ chr(195).chr(164) ] = 'ae';
  715. $chars[ chr(195).chr(150) ] = 'Oe';
  716. $chars[ chr(195).chr(182) ] = 'oe';
  717. $chars[ chr(195).chr(156) ] = 'Ue';
  718. $chars[ chr(195).chr(188) ] = 'ue';
  719. $chars[ chr(195).chr(159) ] = 'ss';
  720. }
  721. $string = strtr($string, $chars);
  722. } else {
  723. // Assume ISO-8859-1 if not UTF-8
  724. $chars['in'] = chr(128).chr(131).chr(138).chr(142).chr(154).chr(158)
  725. .chr(159).chr(162).chr(165).chr(181).chr(192).chr(193).chr(194)
  726. .chr(195).chr(196).chr(197).chr(199).chr(200).chr(201).chr(202)
  727. .chr(203).chr(204).chr(205).chr(206).chr(207).chr(209).chr(210)
  728. .chr(211).chr(212).chr(213).chr(214).chr(216).chr(217).chr(218)
  729. .chr(219).chr(220).chr(221).chr(224).chr(225).chr(226).chr(227)
  730. .chr(228).chr(229).chr(231).chr(232).chr(233).chr(234).chr(235)
  731. .chr(236).chr(237).chr(238).chr(239).chr(241).chr(242).chr(243)
  732. .chr(244).chr(245).chr(246).chr(248).chr(249).chr(250).chr(251)
  733. .chr(252).chr(253).chr(255);
  734. $chars['out'] = "EfSZszYcYuAAAAAACEEEEIIIINOOOOOOUUUUYaaaaaaceeeeiiiinoooooouuuuyy";
  735. $string = strtr($string, $chars['in'], $chars['out']);
  736. $double_chars['in'] = array(chr(140), chr(156), chr(198), chr(208), chr(222), chr(223), chr(230), chr(240), chr(254));
  737. $double_chars['out'] = array('OE', 'oe', 'AE', 'DH', 'TH', 'ss', 'ae', 'dh', 'th');
  738. $string = str_replace($double_chars['in'], $double_chars['out'], $string);
  739. }
  740. return $string;
  741. }
  742. /**
  743. * Sanitizes a filename, replacing whitespace with dashes.
  744. *
  745. * Removes special characters that are illegal in filenames on certain
  746. * operating systems and special characters requiring special escaping
  747. * to manipulate at the command line. Replaces spaces and consecutive
  748. * dashes with a single dash. Trims period, dash and underscore from beginning
  749. * and end of filename.
  750. *
  751. * @since 2.1.0
  752. *
  753. * @param string $filename The filename to be sanitized
  754. * @return string The sanitized filename
  755. */
  756. function sanitize_file_name( $filename ) {
  757. $filename_raw = $filename;
  758. $special_chars = array("?", "[", "]", "/", "\\", "=", "<", ">", ":", ";", ",", "'", "\"", "&", "$", "#", "*", "(", ")", "|", "~", "`", "!", "{", "}", chr(0));
  759. $special_chars = apply_filters('sanitize_file_name_chars', $special_chars, $filename_raw);
  760. $filename = str_replace($special_chars, '', $filename);
  761. $filename = preg_replace('/[\s-]+/', '-', $filename);
  762. $filename = trim($filename, '.-_');
  763. // Split the filename into a base and extension[s]
  764. $parts = explode('.', $filename);
  765. // Return if only one extension
  766. if ( count($parts) <= 2 )
  767. return apply_filters('sanitize_file_name', $filename, $filename_raw);
  768. // Process multiple extensions
  769. $filename = array_shift($parts);
  770. $extension = array_pop($parts);
  771. $mimes = get_allowed_mime_types();
  772. // Loop over any intermediate extensions. Munge them with a trailing underscore if they are a 2 - 5 character
  773. // long alpha string not in the extension whitelist.
  774. foreach ( (array) $parts as $part) {
  775. $filename .= '.' . $part;
  776. if ( preg_match("/^[a-zA-Z]{2,5}\d?$/", $part) ) {
  777. $allowed = false;
  778. foreach ( $mimes as $ext_preg => $mime_match ) {
  779. $ext_preg = '!^(' . $ext_preg . ')$!i';
  780. if ( preg_match( $ext_preg, $part ) ) {
  781. $allowed = true;
  782. break;
  783. }
  784. }
  785. if ( !$allowed )
  786. $filename .= '_';
  787. }
  788. }
  789. $filename .= '.' . $extension;
  790. return apply_filters('sanitize_file_name', $filename, $filename_raw);
  791. }
  792. /**
  793. * Sanitizes a username, stripping out unsafe characters.
  794. *
  795. * Removes tags, octets, entities, and if strict is enabled, will only keep
  796. * alphanumeric, _, space, ., -, @. After sanitizing, it passes the username,
  797. * raw username (the username in the parameter), and the value of $strict as
  798. * parameters for the 'sanitize_user' filter.
  799. *
  800. * @since 2.0.0
  801. * @uses apply_filters() Calls 'sanitize_user' hook on username, raw username,
  802. * and $strict parameter.
  803. *
  804. * @param string $username The username to be sanitized.
  805. * @param bool $strict If set limits $username to specific characters. Default false.
  806. * @return string The sanitized username, after passing through filters.
  807. */
  808. function sanitize_user( $username, $strict = false ) {
  809. $raw_username = $username;
  810. $username = wp_strip_all_tags( $username );
  811. $username = remove_accents( $username );
  812. // Kill octets
  813. $username = preg_replace( '|%([a-fA-F0-9][a-fA-F0-9])|', '', $username );
  814. $username = preg_replace( '/&.+?;/', '', $username ); // Kill entities
  815. // If strict, reduce to ASCII for max portability.
  816. if ( $strict )
  817. $username = preg_replace( '|[^a-z0-9 _.\-@]|i', '', $username );
  818. $username = trim( $username );
  819. // Consolidate contiguous whitespace
  820. $username = preg_replace( '|\s+|', ' ', $username );
  821. return apply_filters( 'sanitize_user', $username, $raw_username, $strict );
  822. }
  823. /**
  824. * Sanitizes a string key.
  825. *
  826. * Keys are used as internal identifiers. Lowercase alphanumeric characters, dashes and underscores are allowed.
  827. *
  828. * @since 3.0.0
  829. *
  830. * @param string $key String key
  831. * @return string Sanitized key
  832. */
  833. function sanitize_key( $key ) {
  834. $raw_key = $key;
  835. $key = strtolower( $key );
  836. $key = preg_replace( '/[^a-z0-9_\-]/', '', $key );
  837. return apply_filters( 'sanitize_key', $key, $raw_key );
  838. }
  839. /**
  840. * Sanitizes a title, or returns a fallback title.
  841. *
  842. * Specifically, HTML and PHP tags are stripped. Further actions can be added
  843. * via the plugin API. If $title is empty and $fallback_title is set, the latter
  844. * will be used.
  845. *
  846. * @since 1.0.0
  847. *
  848. * @param string $title The string to be sanitized.
  849. * @param string $fallback_title Optional. A title to use if $title is empty.
  850. * @param string $context Optional. The operation for which the string is sanitized
  851. * @return string The sanitized string.
  852. */
  853. function sanitize_title( $title, $fallback_title = '', $context = 'save' ) {
  854. $raw_title = $title;
  855. if ( 'save' == $context )
  856. $title = remove_accents($title);
  857. $title = apply_filters('sanitize_title', $title, $raw_title, $context);
  858. if ( '' === $title || false === $title )
  859. $title = $fallback_title;
  860. return $title;
  861. }
  862. /**
  863. * Sanitizes a title with the 'query' context.
  864. *
  865. * Used for querying the database for a value from URL.
  866. *
  867. * @since 3.1.0
  868. * @uses sanitize_title()
  869. *
  870. * @param string $title The string to be sanitized.
  871. * @return string The sanitized string.
  872. */
  873. function sanitize_title_for_query( $title ) {
  874. return sanitize_title( $title, '', 'query' );
  875. }
  876. /**
  877. * Sanitizes a title, replacing whitespace and a few other characters with dashes.
  878. *
  879. * Limits the output to alphanumeric characters, underscore (_) and dash (-).
  880. * Whitespace becomes a dash.
  881. *
  882. * @since 1.2.0
  883. *
  884. * @param string $title The title to be sanitized.
  885. * @param string $raw_title Optional. Not used.
  886. * @param string $context Optional. The operation for which the string is sanitized.
  887. * @return string The sanitized title.
  888. */
  889. function sanitize_title_with_dashes( $title, $raw_title = '', $context = 'display' ) {
  890. $title = strip_tags($title);
  891. // Preserve escaped octets.
  892. $title = preg_replace('|%([a-fA-F0-9][a-fA-F0-9])|', '---$1---', $title);
  893. // Remove percent signs that are not part of an octet.
  894. $title = str_replace('%', '', $title);
  895. // Restore octets.
  896. $title = preg_replace('|---([a-fA-F0-9][a-fA-F0-9])---|', '%$1', $title);
  897. if (seems_utf8($title)) {
  898. if (function_exists('mb_strtolower')) {
  899. $title = mb_strtolower($title, 'UTF-8');
  900. }
  901. $title = utf8_uri_encode($title, 200);
  902. }
  903. $title = strtolower($title);
  904. $title = preg_replace('/&.+?;/', '', $title); // kill entities
  905. $title = str_replace('.', '-', $title);
  906. if ( 'save' == $context ) {
  907. // Convert nbsp, ndash and mdash to hyphens
  908. $title = str_replace( array( '%c2%a0', '%e2%80%93', '%e2%80%94' ), '-', $title );
  909. // Strip these characters entirely
  910. $title = str_replace( array(
  911. // iexcl and iquest
  912. '%c2%a1', '%c2%bf',
  913. // angle quotes
  914. '%c2%ab', '%c2%bb', '%e2%80%b9', '%e2%80%ba',
  915. // curly quotes
  916. '%e2%80%98', '%e2%80%99', '%e2%80%9c', '%e2%80%9d',
  917. '%e2%80%9a', '%e2%80%9b', '%e2%80%9e', '%e2%80%9f',
  918. // copy, reg, deg, hellip and trade
  919. '%c2%a9', '%c2%ae', '%c2%b0', '%e2%80%a6', '%e2%84%a2',
  920. // acute accents
  921. '%c2%b4', '%cb%8a', '%cc%81', '%cd%81',
  922. // grave accent, macron, caron
  923. '%cc%80', '%cc%84', '%cc%8c',
  924. ), '', $title );
  925. // Convert times to x
  926. $title = str_replace( '%c3%97', 'x', $title );
  927. }
  928. $title = preg_replace('/[^%a-z0-9 _-]/', '', $title);
  929. $title = preg_replace('/\s+/', '-', $title);
  930. $title = preg_replace('|-+|', '-', $title);
  931. $title = trim($title, '-');
  932. return $title;
  933. }
  934. /**
  935. * Ensures a string is a valid SQL order by clause.
  936. *
  937. * Accepts one or more columns, with or without ASC/DESC, and also accepts
  938. * RAND().
  939. *
  940. * @since 2.5.1
  941. *
  942. * @param string $orderby Order by string to be checked.
  943. * @return string|bool Returns the order by clause if it is a match, false otherwise.
  944. */
  945. function sanitize_sql_orderby( $orderby ){
  946. preg_match('/^\s*([a-z0-9_]+(\s+(ASC|DESC))?(\s*,\s*|\s*$))+|^\s*RAND\(\s*\)\s*$/i', $orderby, $obmatches);
  947. if ( !$obmatches )
  948. return false;
  949. return $orderby;
  950. }
  951. /**
  952. * Sanitizes an HTML classname to ensure it only contains valid characters.
  953. *
  954. * Strips the string down to A-Z,a-z,0-9,_,-. If this results in an empty
  955. * string then it will return the alternative value supplied.
  956. *
  957. * @todo Expand to support the full range of CDATA that a class attribute can contain.
  958. *
  959. * @since 2.8.0
  960. *
  961. * @param string $class The classname to be sanitized
  962. * @param string $fallback Optional. The value to return if the sanitization end's up as an empty string.
  963. * Defaults to an empty string.
  964. * @return string The sanitized value
  965. */
  966. function sanitize_html_class( $class, $fallback = '' ) {
  967. //Strip out any % encoded octets
  968. $sanitized = preg_replace( '|%[a-fA-F0-9][a-fA-F0-9]|', '', $class );
  969. //Limit to A-Z,a-z,0-9,_,-
  970. $sanitized = preg_replace( '/[^A-Za-z0-9_-]/', '', $sanitized );
  971. if ( '' == $sanitized )
  972. $sanitized = $fallback;
  973. return apply_filters( 'sanitize_html_class', $sanitized, $class, $fallback );
  974. }
  975. /**
  976. * Converts a number of characters from a string.
  977. *
  978. * Metadata tags <<title>> and <<category>> are removed, <<br>> and <<hr>> are
  979. * converted into correct XHTML and Unicode characters are converted to the
  980. * valid range.
  981. *
  982. * @since 0.71
  983. *
  984. * @param string $content String of characters to be converted.
  985. * @param string $deprecated Not used.
  986. * @return string Converted string.
  987. */
  988. function convert_chars($content, $deprecated = '') {
  989. if ( !empty( $deprecated ) )
  990. _deprecated_argument( __FUNCTION__, '0.71' );
  991. // Translation of invalid Unicode references range to valid range
  992. $wp_htmltranswinuni = array(
  993. '&#128;' => '&#8364;', // the Euro sign
  994. '&#129;' => '',
  995. '&#130;' => '&#8218;', // these are Windows CP1252 specific characters
  996. '&#131;' => '&#402;', // they would look weird on non-Windows browsers
  997. '&#132;' => '&#8222;',
  998. '&#133;' => '&#8230;',
  999. '&#134;' => '&#8224;',
  1000. '&#135;' => '&#8225;',
  1001. '&#136;' => '&#710;',
  1002. '&#137;' => '&#8240;',
  1003. '&#138;' => '&#352;',
  1004. '&#139;' => '&#8249;',
  1005. '&#140;' => '&#338;',
  1006. '&#141;' => '',
  1007. '&#142;' => '&#381;',
  1008. '&#143;' => '',
  1009. '&#144;' => '',
  1010. '&#145;' => '&#8216;',
  1011. '&#146;' => '&#8217;',
  1012. '&#147;' => '&#8220;',
  1013. '&#148;' => '&#8221;',
  1014. '&#149;' => '&#8226;',
  1015. '&#150;' => '&#8211;',
  1016. '&#151;' => '&#8212;',
  1017. '&#152;' => '&#732;',
  1018. '&#153;' => '&#8482;',
  1019. '&#154;' => '&#353;',
  1020. '&#155;' => '&#8250;',
  1021. '&#156;' => '&#339;',
  1022. '&#157;' => '',
  1023. '&#158;' => '&#382;',
  1024. '&#159;' => '&#376;'
  1025. );
  1026. // Remove metadata tags
  1027. $content = preg_replace('/<title>(.+?)<\/title>/','',$content);
  1028. $content = preg_replace('/<category>(.+?)<\/category>/','',$content);
  1029. // Converts lone & characters into &#38; (a.k.a. &amp;)
  1030. $content = preg_replace('/&([^#])(?![a-z1-4]{1,8};)/i', '&#038;$1', $content);
  1031. // Fix Word pasting
  1032. $content = strtr($content, $wp_htmltranswinuni);
  1033. // Just a little XHTML help
  1034. $content = str_replace('<br>', '<br />', $content);
  1035. $content = str_replace('<hr>', '<hr />', $content);
  1036. return $content;
  1037. }
  1038. /**
  1039. * Balances tags if forced to, or if the 'use_balanceTags' option is set to true.
  1040. *
  1041. * @since 0.71
  1042. *
  1043. * @param string $text Text to be balanced
  1044. * @param bool $force If true, forces balancing, ignoring the value of the option. Default false.
  1045. * @return string Balanced text
  1046. */
  1047. function balanceTags( $text, $force = false ) {
  1048. if ( $force || get_option('use_balanceTags') == 1 )
  1049. return force_balance_tags( $text );
  1050. else
  1051. return $text;
  1052. }
  1053. /**
  1054. * Balances tags of string using a modified stack.
  1055. *
  1056. * @since 2.0.4
  1057. *
  1058. * @author Leonard Lin <leonard@acm.org>
  1059. * @license GPL
  1060. * @copyright November 4, 2001
  1061. * @version 1.1
  1062. * @todo Make better - change loop condition to $text in 1.2
  1063. * @internal Modified by Scott Reilly (coffee2code) 02 Aug 2004
  1064. * 1.1 Fixed handling of append/stack pop order of end text
  1065. * Added Cleaning Hooks
  1066. * 1.0 First Version
  1067. *
  1068. * @param string $text Text to be balanced.
  1069. * @return string Balanced text.
  1070. */
  1071. function force_balance_tags( $text ) {
  1072. $tagstack = array();
  1073. $stacksize = 0;
  1074. $tagqueue = '';
  1075. $newtext = '';
  1076. // Known single-entity/self-closing tags
  1077. $single_tags = array( 'area', 'base', 'basefont', 'br', 'col', 'command', 'embed', 'frame', 'hr', 'img', 'input', 'isindex', 'link', 'meta', 'param', 'source' );
  1078. // Tags that can be immediately nested within themselves
  1079. $nestable_tags = array( 'blockquote', 'div', 'object', 'q', 'span' );
  1080. // WP bug fix for comments - in case you REALLY meant to type '< !--'
  1081. $text = str_replace('< !--', '< !--', $text);
  1082. // WP bug fix for LOVE <3 (and other situations with '<' before a number)
  1083. $text = preg_replace('#<([0-9]{1})#', '&lt;$1', $text);
  1084. while ( preg_match("/<(\/?[\w:]*)\s*([^>]*)>/", $text, $regex) ) {
  1085. $newtext .= $tagqueue;
  1086. $i = strpos($text, $regex[0]);
  1087. $l = strlen($regex[0]);
  1088. // clear the shifter
  1089. $tagqueue = '';
  1090. // Pop or Push
  1091. if ( isset($regex[1][0]) && '/' == $regex[1][0] ) { // End Tag
  1092. $tag = strtolower(substr($regex[1],1));
  1093. // if too many closing tags
  1094. if( $stacksize <= 0 ) {
  1095. $tag = '';
  1096. // or close to be safe $tag = '/' . $tag;
  1097. }
  1098. // if stacktop value = tag close value then pop
  1099. else if ( $tagstack[$stacksize - 1] == $tag ) { // found closing tag
  1100. $tag = '</' . $tag . '>'; // Close Tag
  1101. // Pop
  1102. array_pop( $tagstack );
  1103. $stacksize--;
  1104. } else { // closing tag not at top, search for it
  1105. for ( $j = $stacksize-1; $j >= 0; $j-- ) {
  1106. if ( $tagstack[$j] == $tag ) {
  1107. // add tag to tagqueue
  1108. for ( $k = $stacksize-1; $k >= $j; $k--) {
  1109. $tagqueue .= '</' . array_pop( $tagstack ) . '>';
  1110. $stacksize--;
  1111. }
  1112. break;
  1113. }
  1114. }
  1115. $tag = '';
  1116. }
  1117. } else { // Begin Tag
  1118. $tag = strtolower($regex[1]);
  1119. // Tag Cleaning
  1120. // If it's an empty tag "< >", do nothing
  1121. if ( '' == $tag ) {
  1122. // do nothing
  1123. }
  1124. // ElseIf it presents itself as a self-closing tag...
  1125. elseif ( substr( $regex[2], -1 ) == '/' ) {
  1126. // ...but it isn't a known single-entity self-closing tag, then don't let it be treated as such and
  1127. // immediately close it with a closing tag (the tag will encapsulate no text as a result)
  1128. if ( ! in_array( $tag, $single_tags ) )
  1129. $regex[2] = trim( substr( $regex[2], 0, -1 ) ) . "></$tag";
  1130. }
  1131. // ElseIf it's a known single-entity tag but it doesn't close itself, do so
  1132. elseif ( in_array($tag, $single_tags) ) {
  1133. $regex[2] .= '/';
  1134. }
  1135. // Else it's not a single-entity tag
  1136. else {
  1137. // If the top of the stack is the same as the tag we want to push, close previous tag
  1138. if ( $stacksize > 0 && !in_array($tag, $nestable_tags) && $tagstack[$stacksize - 1] == $tag ) {
  1139. $tagqueue = '</' . array_pop( $tagstack ) . '>';
  1140. $stacksize--;
  1141. }
  1142. $stacksize = array_push( $tagstack, $tag );
  1143. }
  1144. // Attributes
  1145. $attributes = $regex[2];
  1146. if( ! empty( $attributes ) && $attributes[0] != '>' )
  1147. $attributes = ' ' . $attributes;
  1148. $tag = '<' . $tag . $attributes . '>';
  1149. //If already queuing a close tag, then put this tag on, too
  1150. if ( !empty($tagqueue) ) {
  1151. $tagqueue .= $tag;
  1152. $tag = '';
  1153. }
  1154. }
  1155. $newtext .= substr($text, 0, $i) . $tag;
  1156. $text = substr($text, $i + $l);
  1157. }
  1158. // Clear Tag Queue
  1159. $newtext .= $tagqueue;
  1160. // Add Remaining text
  1161. $newtext .= $text;
  1162. // Empty Stack
  1163. while( $x = array_pop($tagstack) )
  1164. $newtext .= '</' . $x . '>'; // Add remaining tags to close
  1165. // WP fix for the bug with HTML comments
  1166. $newtext = str_replace("< !--","<!--",$newtext);
  1167. $newtext = str_replace("< !--","< !--",$newtext);
  1168. return $newtext;
  1169. }
  1170. /**
  1171. * Acts on text which is about to be edited.
  1172. *
  1173. * The $content is run through esc_textarea(), which uses htmlspecialchars()
  1174. * to convert special characters to HTML entities. If $richedit is set to true,
  1175. * it is simply a holder for the 'format_to_edit' filter.
  1176. *
  1177. * @since 0.71
  1178. *
  1179. * @param string $content The text about to be edited.
  1180. * @param bool $richedit Whether the $content should not pass through htmlspecialchars(). Default false (meaning it will be passed).
  1181. * @return string The text after the filter (and possibly htmlspecialchars()) has been run.
  1182. */
  1183. function format_to_edit( $content, $richedit = false ) {
  1184. $content = apply_filters( 'format_to_edit', $content );
  1185. if (

Large files files are truncated, but you can click here to view the full file