PageRenderTime 62ms CodeModel.GetById 23ms RepoModel.GetById 1ms app.codeStats 0ms

/wp-includes/formatting.php

https://github.com/davidmh/WordPress
PHP | 3145 lines | 1885 code | 258 blank | 1002 comment | 248 complexity | 26916e2e25578625b030e14c24d3cc01 MD5 | raw file
Possible License(s): AGPL-1.0, GPL-2.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 everytime 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. * @access private
  120. * @since 2.9.0
  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 $opening Tag closing character
  127. * @return object
  128. */
  129. function _wptexturize_pushpop_element($text, &$stack, $disabled_elements, $opening = '<', $closing = '>') {
  130. // Check if it is a closing tag -- otherwise assume opening tag
  131. if (strncmp($opening . '/', $text, 2)) {
  132. // Opening? Check $text+1 against disabled elements
  133. if (preg_match('/^' . $disabled_elements . '\b/', substr($text, 1), $matches)) {
  134. /*
  135. * This disables texturize until we find a closing tag of our type
  136. * (e.g. <pre>) even if there was invalid nesting before that
  137. *
  138. * Example: in the case <pre>sadsadasd</code>"baba"</pre>
  139. * "baba" won't be texturize
  140. */
  141. array_push($stack, $matches[1]);
  142. }
  143. } else {
  144. // Closing? Check $text+2 against disabled elements
  145. $c = preg_quote($closing, '/');
  146. if (preg_match('/^' . $disabled_elements . $c . '/', substr($text, 2), $matches)) {
  147. $last = array_pop($stack);
  148. // Make sure it matches the opening tag
  149. if ($last != $matches[1])
  150. array_push($stack, $last);
  151. }
  152. }
  153. }
  154. /**
  155. * Accepts matches array from preg_replace_callback in wpautop() or a string.
  156. *
  157. * Ensures that the contents of a <<pre>>...<</pre>> HTML block are not
  158. * converted into paragraphs or line-breaks.
  159. *
  160. * @since 1.2.0
  161. *
  162. * @param array|string $matches The array or string
  163. * @return string The pre block without paragraph/line-break conversion.
  164. */
  165. function clean_pre($matches) {
  166. if ( is_array($matches) )
  167. $text = $matches[1] . $matches[2] . "</pre>";
  168. else
  169. $text = $matches;
  170. $text = str_replace('<br />', '', $text);
  171. $text = str_replace('<p>', "\n", $text);
  172. $text = str_replace('</p>', '', $text);
  173. return $text;
  174. }
  175. /**
  176. * Replaces double line-breaks with paragraph elements.
  177. *
  178. * A group of regex replaces used to identify text formatted with newlines and
  179. * replace double line-breaks with HTML paragraph tags. The remaining
  180. * line-breaks after conversion become <<br />> tags, unless $br is set to '0'
  181. * or 'false'.
  182. *
  183. * @since 0.71
  184. *
  185. * @param string $pee The text which has to be formatted.
  186. * @param int|bool $br Optional. If set, this will convert all remaining line-breaks after paragraphing. Default true.
  187. * @return string Text which has been converted into correct paragraph tags.
  188. */
  189. function wpautop($pee, $br = 1) {
  190. if ( trim($pee) === '' )
  191. return '';
  192. $pee = $pee . "\n"; // just to make things a little easier, pad the end
  193. $pee = preg_replace('|<br />\s*<br />|', "\n\n", $pee);
  194. // Space things out a little
  195. $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|legend|section|article|aside|hgroup|header|footer|nav|figure|figcaption|details|menu|summary)';
  196. $pee = preg_replace('!(<' . $allblocks . '[^>]*>)!', "\n$1", $pee);
  197. $pee = preg_replace('!(</' . $allblocks . '>)!', "$1\n\n", $pee);
  198. $pee = str_replace(array("\r\n", "\r"), "\n", $pee); // cross-platform newlines
  199. if ( strpos($pee, '<object') !== false ) {
  200. $pee = preg_replace('|\s*<param([^>]*)>\s*|', "<param$1>", $pee); // no pee inside object/embed
  201. $pee = preg_replace('|\s*</embed>\s*|', '</embed>', $pee);
  202. }
  203. $pee = preg_replace("/\n\n+/", "\n\n", $pee); // take care of duplicates
  204. // make paragraphs, including one at the end
  205. $pees = preg_split('/\n\s*\n/', $pee, -1, PREG_SPLIT_NO_EMPTY);
  206. $pee = '';
  207. foreach ( $pees as $tinkle )
  208. $pee .= '<p>' . trim($tinkle, "\n") . "</p>\n";
  209. $pee = preg_replace('|<p>\s*</p>|', '', $pee); // under certain strange conditions it could create a P of entirely whitespace
  210. $pee = preg_replace('!<p>([^<]+)</(div|address|form)>!', "<p>$1</p></$2>", $pee);
  211. $pee = preg_replace('!<p>\s*(</?' . $allblocks . '[^>]*>)\s*</p>!', "$1", $pee); // don't pee all over a tag
  212. $pee = preg_replace("|<p>(<li.+?)</p>|", "$1", $pee); // problem with nested lists
  213. $pee = preg_replace('|<p><blockquote([^>]*)>|i', "<blockquote$1><p>", $pee);
  214. $pee = str_replace('</blockquote></p>', '</p></blockquote>', $pee);
  215. $pee = preg_replace('!<p>\s*(</?' . $allblocks . '[^>]*>)!', "$1", $pee);
  216. $pee = preg_replace('!(</?' . $allblocks . '[^>]*>)\s*</p>!', "$1", $pee);
  217. if ($br) {
  218. $pee = preg_replace_callback('/<(script|style).*?<\/\\1>/s', '_autop_newline_preservation_helper', $pee);
  219. $pee = preg_replace('|(?<!<br />)\s*\n|', "<br />\n", $pee); // optionally make line breaks
  220. $pee = str_replace('<WPPreserveNewline />', "\n", $pee);
  221. }
  222. $pee = preg_replace('!(</?' . $allblocks . '[^>]*>)\s*<br />!', "$1", $pee);
  223. $pee = preg_replace('!<br />(\s*</?(?:p|li|div|dl|dd|dt|th|pre|td|ul|ol)[^>]*>)!', '$1', $pee);
  224. if (strpos($pee, '<pre') !== false)
  225. $pee = preg_replace_callback('!(<pre[^>]*>)(.*?)</pre>!is', 'clean_pre', $pee );
  226. $pee = preg_replace( "|\n</p>$|", '</p>', $pee );
  227. return $pee;
  228. }
  229. /**
  230. * Newline preservation help function for wpautop
  231. *
  232. * @since 3.1.0
  233. * @access private
  234. * @param array $matches preg_replace_callback matches array
  235. * @returns string
  236. */
  237. function _autop_newline_preservation_helper( $matches ) {
  238. return str_replace("\n", "<WPPreserveNewline />", $matches[0]);
  239. }
  240. /**
  241. * Don't auto-p wrap shortcodes that stand alone
  242. *
  243. * Ensures that shortcodes are not wrapped in <<p>>...<</p>>.
  244. *
  245. * @since 2.9.0
  246. *
  247. * @param string $pee The content.
  248. * @return string The filtered content.
  249. */
  250. function shortcode_unautop( $pee ) {
  251. global $shortcode_tags;
  252. if ( empty( $shortcode_tags ) || !is_array( $shortcode_tags ) ) {
  253. return $pee;
  254. }
  255. $tagregexp = join( '|', array_map( 'preg_quote', array_keys( $shortcode_tags ) ) );
  256. $pattern =
  257. '/'
  258. . '<p>' // Opening paragraph
  259. . '\\s*+' // Optional leading whitespace
  260. . '(' // 1: The shortcode
  261. . '\\[' // Opening bracket
  262. . "($tagregexp)" // 2: Shortcode name
  263. . '\\b' // Word boundary
  264. // Unroll the loop: Inside the opening shortcode tag
  265. . '[^\\]\\/]*' // Not a closing bracket or forward slash
  266. . '(?:'
  267. . '\\/(?!\\])' // A forward slash not followed by a closing bracket
  268. . '[^\\]\\/]*' // Not a closing bracket or forward slash
  269. . ')*?'
  270. . '(?:'
  271. . '\\/\\]' // Self closing tag and closing bracket
  272. . '|'
  273. . '\\]' // Closing bracket
  274. . '(?:' // Unroll the loop: Optionally, anything between the opening and closing shortcode tags
  275. . '[^\\[]*+' // Not an opening bracket
  276. . '(?:'
  277. . '\\[(?!\\/\\2\\])' // An opening bracket not followed by the closing shortcode tag
  278. . '[^\\[]*+' // Not an opening bracket
  279. . ')*+'
  280. . '\\[\\/\\2\\]' // Closing shortcode tag
  281. . ')?'
  282. . ')'
  283. . ')'
  284. . '\\s*+' // optional trailing whitespace
  285. . '<\\/p>' // closing paragraph
  286. . '/s';
  287. return preg_replace( $pattern, '$1', $pee );
  288. }
  289. /**
  290. * Checks to see if a string is utf8 encoded.
  291. *
  292. * NOTE: This function checks for 5-Byte sequences, UTF8
  293. * has Bytes Sequences with a maximum length of 4.
  294. *
  295. * @author bmorel at ssi dot fr (modified)
  296. * @since 1.2.1
  297. *
  298. * @param string $str The string to be checked
  299. * @return bool True if $str fits a UTF-8 model, false otherwise.
  300. */
  301. function seems_utf8($str) {
  302. $length = strlen($str);
  303. for ($i=0; $i < $length; $i++) {
  304. $c = ord($str[$i]);
  305. if ($c < 0x80) $n = 0; # 0bbbbbbb
  306. elseif (($c & 0xE0) == 0xC0) $n=1; # 110bbbbb
  307. elseif (($c & 0xF0) == 0xE0) $n=2; # 1110bbbb
  308. elseif (($c & 0xF8) == 0xF0) $n=3; # 11110bbb
  309. elseif (($c & 0xFC) == 0xF8) $n=4; # 111110bb
  310. elseif (($c & 0xFE) == 0xFC) $n=5; # 1111110b
  311. else return false; # Does not match any model
  312. for ($j=0; $j<$n; $j++) { # n bytes matching 10bbbbbb follow ?
  313. if ((++$i == $length) || ((ord($str[$i]) & 0xC0) != 0x80))
  314. return false;
  315. }
  316. }
  317. return true;
  318. }
  319. /**
  320. * Converts a number of special characters into their HTML entities.
  321. *
  322. * Specifically deals with: &, <, >, ", and '.
  323. *
  324. * $quote_style can be set to ENT_COMPAT to encode " to
  325. * &quot;, or ENT_QUOTES to do both. Default is ENT_NOQUOTES where no quotes are encoded.
  326. *
  327. * @since 1.2.2
  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
  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
  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. $string = strtr($string, $chars);
  642. } else {
  643. // Assume ISO-8859-1 if not UTF-8
  644. $chars['in'] = chr(128).chr(131).chr(138).chr(142).chr(154).chr(158)
  645. .chr(159).chr(162).chr(165).chr(181).chr(192).chr(193).chr(194)
  646. .chr(195).chr(196).chr(197).chr(199).chr(200).chr(201).chr(202)
  647. .chr(203).chr(204).chr(205).chr(206).chr(207).chr(209).chr(210)
  648. .chr(211).chr(212).chr(213).chr(214).chr(216).chr(217).chr(218)
  649. .chr(219).chr(220).chr(221).chr(224).chr(225).chr(226).chr(227)
  650. .chr(228).chr(229).chr(231).chr(232).chr(233).chr(234).chr(235)
  651. .chr(236).chr(237).chr(238).chr(239).chr(241).chr(242).chr(243)
  652. .chr(244).chr(245).chr(246).chr(248).chr(249).chr(250).chr(251)
  653. .chr(252).chr(253).chr(255);
  654. $chars['out'] = "EfSZszYcYuAAAAAACEEEEIIIINOOOOOOUUUUYaaaaaaceeeeiiiinoooooouuuuyy";
  655. $string = strtr($string, $chars['in'], $chars['out']);
  656. $double_chars['in'] = array(chr(140), chr(156), chr(198), chr(208), chr(222), chr(223), chr(230), chr(240), chr(254));
  657. $double_chars['out'] = array('OE', 'oe', 'AE', 'DH', 'TH', 'ss', 'ae', 'dh', 'th');
  658. $string = str_replace($double_chars['in'], $double_chars['out'], $string);
  659. }
  660. return $string;
  661. }
  662. /**
  663. * Sanitizes a filename replacing whitespace with dashes
  664. *
  665. * Removes special characters that are illegal in filenames on certain
  666. * operating systems and special characters requiring special escaping
  667. * to manipulate at the command line. Replaces spaces and consecutive
  668. * dashes with a single dash. Trim period, dash and underscore from beginning
  669. * and end of filename.
  670. *
  671. * @since 2.1.0
  672. *
  673. * @param string $filename The filename to be sanitized
  674. * @return string The sanitized filename
  675. */
  676. function sanitize_file_name( $filename ) {
  677. $filename_raw = $filename;
  678. $special_chars = array("?", "[", "]", "/", "\\", "=", "<", ">", ":", ";", ",", "'", "\"", "&", "$", "#", "*", "(", ")", "|", "~", "`", "!", "{", "}", chr(0));
  679. $special_chars = apply_filters('sanitize_file_name_chars', $special_chars, $filename_raw);
  680. $filename = str_replace($special_chars, '', $filename);
  681. $filename = preg_replace('/[\s-]+/', '-', $filename);
  682. $filename = trim($filename, '.-_');
  683. // Split the filename into a base and extension[s]
  684. $parts = explode('.', $filename);
  685. // Return if only one extension
  686. if ( count($parts) <= 2 )
  687. return apply_filters('sanitize_file_name', $filename, $filename_raw);
  688. // Process multiple extensions
  689. $filename = array_shift($parts);
  690. $extension = array_pop($parts);
  691. $mimes = get_allowed_mime_types();
  692. // Loop over any intermediate extensions. Munge them with a trailing underscore if they are a 2 - 5 character
  693. // long alpha string not in the extension whitelist.
  694. foreach ( (array) $parts as $part) {
  695. $filename .= '.' . $part;
  696. if ( preg_match("/^[a-zA-Z]{2,5}\d?$/", $part) ) {
  697. $allowed = false;
  698. foreach ( $mimes as $ext_preg => $mime_match ) {
  699. $ext_preg = '!^(' . $ext_preg . ')$!i';
  700. if ( preg_match( $ext_preg, $part ) ) {
  701. $allowed = true;
  702. break;
  703. }
  704. }
  705. if ( !$allowed )
  706. $filename .= '_';
  707. }
  708. }
  709. $filename .= '.' . $extension;
  710. return apply_filters('sanitize_file_name', $filename, $filename_raw);
  711. }
  712. /**
  713. * Sanitize username stripping out unsafe characters.
  714. *
  715. * Removes tags, octets, entities, and if strict is enabled, will only keep
  716. * alphanumeric, _, space, ., -, @. After sanitizing, it passes the username,
  717. * raw username (the username in the parameter), and the value of $strict as
  718. * parameters for the 'sanitize_user' filter.
  719. *
  720. * @since 2.0.0
  721. * @uses apply_filters() Calls 'sanitize_user' hook on username, raw username,
  722. * and $strict parameter.
  723. *
  724. * @param string $username The username to be sanitized.
  725. * @param bool $strict If set limits $username to specific characters. Default false.
  726. * @return string The sanitized username, after passing through filters.
  727. */
  728. function sanitize_user( $username, $strict = false ) {
  729. $raw_username = $username;
  730. $username = wp_strip_all_tags( $username );
  731. $username = remove_accents( $username );
  732. // Kill octets
  733. $username = preg_replace( '|%([a-fA-F0-9][a-fA-F0-9])|', '', $username );
  734. $username = preg_replace( '/&.+?;/', '', $username ); // Kill entities
  735. // If strict, reduce to ASCII for max portability.
  736. if ( $strict )
  737. $username = preg_replace( '|[^a-z0-9 _.\-@]|i', '', $username );
  738. $username = trim( $username );
  739. // Consolidate contiguous whitespace
  740. $username = preg_replace( '|\s+|', ' ', $username );
  741. return apply_filters( 'sanitize_user', $username, $raw_username, $strict );
  742. }
  743. /**
  744. * Sanitize a string key.
  745. *
  746. * Keys are used as internal identifiers. Lowercase alphanumeric characters, dashes and underscores are allowed.
  747. *
  748. * @since 3.0.0
  749. *
  750. * @param string $key String key
  751. * @return string Sanitized key
  752. */
  753. function sanitize_key( $key ) {
  754. $raw_key = $key;
  755. $key = strtolower( $key );
  756. $key = preg_replace( '/[^a-z0-9_\-]/', '', $key );
  757. return apply_filters( 'sanitize_key', $key, $raw_key );
  758. }
  759. /**
  760. * Sanitizes title or use fallback title.
  761. *
  762. * Specifically, HTML and PHP tags are stripped. Further actions can be added
  763. * via the plugin API. If $title is empty and $fallback_title is set, the latter
  764. * will be used.
  765. *
  766. * @since 1.0.0
  767. *
  768. * @param string $title The string to be sanitized.
  769. * @param string $fallback_title Optional. A title to use if $title is empty.
  770. * @param string $context Optional. The operation for which the string is sanitized
  771. * @return string The sanitized string.
  772. */
  773. function sanitize_title($title, $fallback_title = '', $context = 'save') {
  774. $raw_title = $title;
  775. if ( 'save' == $context )
  776. $title = remove_accents($title);
  777. $title = apply_filters('sanitize_title', $title, $raw_title, $context);
  778. if ( '' === $title || false === $title )
  779. $title = $fallback_title;
  780. return $title;
  781. }
  782. function sanitize_title_for_query($title) {
  783. return sanitize_title($title, '', 'query');
  784. }
  785. /**
  786. * Sanitizes title, replacing whitespace and a few other characters with dashes.
  787. *
  788. * Limits the output to alphanumeric characters, underscore (_) and dash (-).
  789. * Whitespace becomes a dash.
  790. *
  791. * @since 1.2.0
  792. *
  793. * @param string $title The title to be sanitized.
  794. * @param string $raw_title Optional. Not used.
  795. * @param string $context Optional. The operation for which the string is sanitized.
  796. * @return string The sanitized title.
  797. */
  798. function sanitize_title_with_dashes($title, $raw_title = '', $context = 'display') {
  799. $title = strip_tags($title);
  800. // Preserve escaped octets.
  801. $title = preg_replace('|%([a-fA-F0-9][a-fA-F0-9])|', '---$1---', $title);
  802. // Remove percent signs that are not part of an octet.
  803. $title = str_replace('%', '', $title);
  804. // Restore octets.
  805. $title = preg_replace('|---([a-fA-F0-9][a-fA-F0-9])---|', '%$1', $title);
  806. if (seems_utf8($title)) {
  807. if (function_exists('mb_strtolower')) {
  808. $title = mb_strtolower($title, 'UTF-8');
  809. }
  810. $title = utf8_uri_encode($title, 200);
  811. }
  812. $title = strtolower($title);
  813. $title = preg_replace('/&.+?;/', '', $title); // kill entities
  814. $title = str_replace('.', '-', $title);
  815. if ( 'save' == $context ) {
  816. // nbsp, ndash and mdash
  817. $title = str_replace( array( '%c2%a0', '%e2%80%93', '%e2%80%94' ), '-', $title );
  818. // iexcl and iquest
  819. $title = str_replace( array( '%c2%a1', '%c2%bf' ), '', $title );
  820. // angle quotes
  821. $title = str_replace( array( '%c2%ab', '%c2%bb', '%e2%80%b9', '%e2%80%ba' ), '', $title );
  822. // curly quotes
  823. $title = str_replace( array( '%e2%80%98', '%e2%80%99', '%e2%80%9c', '%e2%80%9d' ), '', $title );
  824. // copy, reg, deg, hellip and trade
  825. $title = str_replace( array( '%c2%a9', '%c2%ae', '%c2%b0', '%e2%80%a6', '%e2%84%a2' ), '', $title );
  826. }
  827. $title = preg_replace('/[^%a-z0-9 _-]/', '', $title);
  828. $title = preg_replace('/\s+/', '-', $title);
  829. $title = preg_replace('|-+|', '-', $title);
  830. $title = trim($title, '-');
  831. return $title;
  832. }
  833. /**
  834. * Ensures a string is a valid SQL order by clause.
  835. *
  836. * Accepts one or more columns, with or without ASC/DESC, and also accepts
  837. * RAND().
  838. *
  839. * @since 2.5.1
  840. *
  841. * @param string $orderby Order by string to be checked.
  842. * @return string|false Returns the order by clause if it is a match, false otherwise.
  843. */
  844. function sanitize_sql_orderby( $orderby ){
  845. preg_match('/^\s*([a-z0-9_]+(\s+(ASC|DESC))?(\s*,\s*|\s*$))+|^\s*RAND\(\s*\)\s*$/i', $orderby, $obmatches);
  846. if ( !$obmatches )
  847. return false;
  848. return $orderby;
  849. }
  850. /**
  851. * Santizes a html classname to ensure it only contains valid characters
  852. *
  853. * Strips the string down to A-Z,a-z,0-9,_,-. If this results in an empty
  854. * string then it will return the alternative value supplied.
  855. *
  856. * @todo Expand to support the full range of CDATA that a class attribute can contain.
  857. *
  858. * @since 2.8.0
  859. *
  860. * @param string $class The classname to be sanitized
  861. * @param string $fallback Optional. The value to return if the sanitization end's up as an empty string.
  862. * Defaults to an empty string.
  863. * @return string The sanitized value
  864. */
  865. function sanitize_html_class( $class, $fallback = '' ) {
  866. //Strip out any % encoded octets
  867. $sanitized = preg_replace( '|%[a-fA-F0-9][a-fA-F0-9]|', '', $class );
  868. //Limit to A-Z,a-z,0-9,_,-
  869. $sanitized = preg_replace( '/[^A-Za-z0-9_-]/', '', $sanitized );
  870. if ( '' == $sanitized )
  871. $sanitized = $fallback;
  872. return apply_filters( 'sanitize_html_class', $sanitized, $class, $fallback );
  873. }
  874. /**
  875. * Converts a number of characters from a string.
  876. *
  877. * Metadata tags <<title>> and <<category>> are removed, <<br>> and <<hr>> are
  878. * converted into correct XHTML and Unicode characters are converted to the
  879. * valid range.
  880. *
  881. * @since 0.71
  882. *
  883. * @param string $content String of characters to be converted.
  884. * @param string $deprecated Not used.
  885. * @return string Converted string.
  886. */
  887. function convert_chars($content, $deprecated = '') {
  888. if ( !empty( $deprecated ) )
  889. _deprecated_argument( __FUNCTION__, '0.71' );
  890. // Translation of invalid Unicode references range to valid range
  891. $wp_htmltranswinuni = array(
  892. '&#128;' => '&#8364;', // the Euro sign
  893. '&#129;' => '',
  894. '&#130;' => '&#8218;', // these are Windows CP1252 specific characters
  895. '&#131;' => '&#402;', // they would look weird on non-Windows browsers
  896. '&#132;' => '&#8222;',
  897. '&#133;' => '&#8230;',
  898. '&#134;' => '&#8224;',
  899. '&#135;' => '&#8225;',
  900. '&#136;' => '&#710;',
  901. '&#137;' => '&#8240;',
  902. '&#138;' => '&#352;',
  903. '&#139;' => '&#8249;',
  904. '&#140;' => '&#338;',
  905. '&#141;' => '',
  906. '&#142;' => '&#382;',
  907. '&#143;' => '',
  908. '&#144;' => '',
  909. '&#145;' => '&#8216;',
  910. '&#146;' => '&#8217;',
  911. '&#147;' => '&#8220;',
  912. '&#148;' => '&#8221;',
  913. '&#149;' => '&#8226;',
  914. '&#150;' => '&#8211;',
  915. '&#151;' => '&#8212;',
  916. '&#152;' => '&#732;',
  917. '&#153;' => '&#8482;',
  918. '&#154;' => '&#353;',
  919. '&#155;' => '&#8250;',
  920. '&#156;' => '&#339;',
  921. '&#157;' => '',
  922. '&#158;' => '',
  923. '&#159;' => '&#376;'
  924. );
  925. // Remove metadata tags
  926. $content = preg_replace('/<title>(.+?)<\/title>/','',$content);
  927. $content = preg_replace('/<category>(.+?)<\/category>/','',$content);
  928. // Converts lone & characters into &#38; (a.k.a. &amp;)
  929. $content = preg_replace('/&([^#])(?![a-z1-4]{1,8};)/i', '&#038;$1', $content);
  930. // Fix Word pasting
  931. $content = strtr($content, $wp_htmltranswinuni);
  932. // Just a little XHTML help
  933. $content = str_replace('<br>', '<br />', $content);
  934. $content = str_replace('<hr>', '<hr />', $content);
  935. return $content;
  936. }
  937. /**
  938. * Will only balance the tags if forced to and the option is set to balance tags.
  939. *
  940. * The option 'use_balanceTags' is used to determine whether the tags will be balanced.
  941. *
  942. * @since 0.71
  943. *
  944. * @param string $text Text to be balanced
  945. * @param bool $force If true, forces balancing, ignoring the value of the option. Default false.
  946. * @return string Balanced text
  947. */
  948. function balanceTags( $text, $force = false ) {
  949. if ( !$force && get_option('use_balanceTags') == 0 )
  950. return $text;
  951. return force_balance_tags( $text );
  952. }
  953. /**
  954. * Balances tags of string using a modified stack.
  955. *
  956. * @since 2.0.4
  957. *
  958. * @author Leonard Lin <leonard@acm.org>
  959. * @license GPL
  960. * @copyright November 4, 2001
  961. * @version 1.1
  962. * @todo Make better - change loop condition to $text in 1.2
  963. * @internal Modified by Scott Reilly (coffee2code) 02 Aug 2004
  964. * 1.1 Fixed handling of append/stack pop order of end text
  965. * Added Cleaning Hooks
  966. * 1.0 First Version
  967. *
  968. * @param string $text Text to be balanced.
  969. * @return string Balanced text.
  970. */
  971. function force_balance_tags( $text ) {
  972. $tagstack = array();
  973. $stacksize = 0;
  974. $tagqueue = '';
  975. $newtext = '';
  976. $single_tags = array( 'br', 'hr', 'img', 'input' ); // Known single-entity/self-closing tags
  977. $nestable_tags = array( 'blockquote', 'div', 'span', 'q' ); // Tags that can be immediately nested within themselves
  978. // WP bug fix for comments - in case you REALLY meant to type '< !--'
  979. $text = str_replace('< !--', '< !--', $text);
  980. // WP bug fix for LOVE <3 (and other situations with '<' before a number)
  981. $text = preg_replace('#<([0-9]{1})#', '&lt;$1', $text);
  982. while ( preg_match("/<(\/?[\w:]*)\s*([^>]*)>/", $text, $regex) ) {
  983. $newtext .= $tagqueue;
  984. $i = strpos($text, $regex[0]);
  985. $l = strlen($regex[0]);
  986. // clear the shifter
  987. $tagqueue = '';
  988. // Pop or Push
  989. if ( isset($regex[1][0]) && '/' == $regex[1][0] ) { // End Tag
  990. $tag = strtolower(substr($regex[1],1));
  991. // if too many closing tags
  992. if( $stacksize <= 0 ) {
  993. $tag = '';
  994. // or close to be safe $tag = '/' . $tag;
  995. }
  996. // if stacktop value = tag close value then pop
  997. else if ( $tagstack[$stacksize - 1] == $tag ) { // found closing tag
  998. $tag = '</' . $tag . '>'; // Close Tag
  999. // Pop
  1000. array_pop( $tagstack );
  1001. $stacksize--;
  1002. } else { // closing tag not at top, search for it
  1003. for ( $j = $stacksize-1; $j >= 0; $j-- ) {
  1004. if ( $tagstack[$j] == $tag ) {
  1005. // add tag to tagqueue
  1006. for ( $k = $stacksize-1; $k >= $j; $k--) {
  1007. $tagqueue .= '</' . array_pop( $tagstack ) . '>';
  1008. $stacksize--;
  1009. }
  1010. break;
  1011. }
  1012. }
  1013. $tag = '';
  1014. }
  1015. } else { // Begin Tag
  1016. $tag = strtolower($regex[1]);
  1017. // Tag Cleaning
  1018. // If self-closing or '', don't do anything.
  1019. if ( substr($regex[2],-1) == '/' || $tag == '' ) {
  1020. // do nothing
  1021. }
  1022. // ElseIf it's a known single-entity tag but it doesn't close itself, do so
  1023. elseif ( in_array($tag, $single_tags) ) {
  1024. $regex[2] .= '/';
  1025. } else { // Push the tag onto the stack
  1026. // If the top of the stack is the same as the tag we want to push, close previous tag
  1027. if ( $stacksize > 0 && !in_array($tag, $nestable_tags) && $tagstack[$stacksize - 1] == $tag ) {
  1028. $tagqueue = '</' . array_pop ($tagstack) . '>';
  1029. $stacksize--;
  1030. }
  1031. $stacksize = array_push ($tagstack, $tag);
  1032. }
  1033. // Attributes
  1034. $attributes = $regex[2];
  1035. if( !empty($attributes) )
  1036. $attributes = ' '.$attributes;
  1037. $tag = '<' . $tag . $attributes . '>';
  1038. //If already queuing a close tag, then put this tag on, too
  1039. if ( !empty($tagqueue) ) {
  1040. $tagqueue .= $tag;
  1041. $tag = '';
  1042. }
  1043. }
  1044. $newtext .= substr($text, 0, $i) . $tag;
  1045. $text = substr($text, $i + $l);
  1046. }
  1047. // Clear Tag Queue
  1048. $newtext .= $tagqueue;
  1049. // Add Remaining text
  1050. $newtext .= $text;
  1051. // Empty Stack
  1052. while( $x = array_pop($tagstack) )
  1053. $newtext .= '</' . $x . '>'; // Add remaining tags to close
  1054. // WP fix for the bug with HTML comments
  1055. $newtext = str_replace("< !--","<!--",$newtext);
  1056. $newtext = str_replace("< !--","< !--",$newtext);
  1057. return $newtext;
  1058. }
  1059. /**
  1060. * Acts on text which is about to be edited.
  1061. *
  1062. * The $content is run through esc_textarea(), which uses htmlspecialchars()
  1063. * to convert special characters to HTML entities. If $richedit is set to true,
  1064. * it is simply a holder for the 'format_to_edit' filter.
  1065. *
  1066. * @since 0.71
  1067. *
  1068. * @param string $content The text about to be edited.
  1069. * @param bool $richedit Whether the $content should not pass through htmlspecialchars(). Default false (meaning it will be passed).
  1070. * @return string The text after the filter (and possibly htmlspecialchars()) has been run.
  1071. */
  1072. function format_to_edit( $content, $richedit = false ) {
  1073. $content = apply_filters( 'format_to_edit', $content );
  1074. if ( ! $richedit )
  1075. $content = esc_textarea( $content );
  1076. return $content;
  1077. }
  1078. /**
  1079. * Holder for the 'format_to_post' filter.
  1080. *
  1081. * @since 0.71
  1082. *
  1083. * @param string $content The text to pass through the filter.
  1084. * @return string Text returned from the 'format_to_post' filter.
  1085. */
  1086. function format_to_post($content) {
  1087. $content = apply_filters('format_to_post', $content);
  1088. return $content;
  1089. }
  1090. /**
  1091. * Add leading zeros when necessary.
  1092. *
  1093. * If you set the threshold to '4' and the number is '10', then you will get
  1094. * back '0010'. If you set the threshold to '4' and the number is '5000', then you
  1095. * will get back '5000'.
  1096. *
  1097. * Uses sprintf to append the amount of zeros based on the $threshold parameter
  1098. * and the size of the number. If the number is large enough, then no zeros will
  1099. * be appended.
  1100. *
  1101. * @since 0.71
  1102. *
  1103. * @param mixed $number Number to append zeros to if not greater than threshold.
  1104. * @param int $threshold Digit places number needs to be to not have zeros added.
  1105. * @return string Adds leading zeros to number if needed.
  1106. */
  1107. function zeroise($number, $threshold) {
  1108. return sprintf('%0'.$threshold.'s', $number);
  1109. }
  1110. /**
  1111. * Adds backslashes before letters and before a number at the start of a string.
  1112. *
  1113. * @since 0.71
  1114. *
  1115. * @param string $string Value to which backslashes will be added.
  1116. * @return string String with backslashes inserted.
  1117. */
  1118. function backslashit($string) {
  1119. $string = preg_replace('/^([0-9])/', '\\\\\\\\\1', $string);
  1120. $string = preg_replace('/([a-z])/i', '\\\\\1', $string);
  1121. return $string;
  1122. }
  1123. /**
  1124. * Appends a trailing slash.
  1125. *
  1126. * Will remove trailing slash if it exists already before adding a trailing
  1127. * slash. This prevents double slashing a string or path.
  1128. *
  1129. * The primary use of this is for paths and thus should be used for paths. It is
  1130. * not restricted to paths and offers no specific path support.
  1131. *
  1132. * @since 1.2.0
  1133. * @uses untrailingslashit() Unslashes string if it was slashed already.
  1134. *
  1135. * @param string $string What to add the trailing slash to.
  1136. * @return string String with trailing slash added.
  1137. */
  1138. function trailingslashit($string) {
  1139. return untrailingslashit($string) . '/';
  1140. }
  1141. /**
  1142. * Removes trailing slash if it exists.
  1143. *
  1144. * The primary use of this is for paths and thus should be used for paths. It is
  1145. * not restricted to paths and offers no specific path support.
  1146. *
  1147. * @since 2.2.0
  1148. *
  1149. * @param string $string What to remove the trailing slash from.
  1150. * @return string String without the trailing slash.
  1151. */
  1152. function untrailingslashit($string) {
  1153. return rtrim($string, '/');
  1154. }
  1155. /**
  1156. * Adds slashes to escape strings.
  1157. *
  1158. * Slashes will first be removed if magic_quotes_gpc is set, see {@link
  1159. * http://www.php.net/magic_quotes} for more details.
  1160. *
  1161. * @since 0.71
  1162. *
  1163. * @param string $gpc The string returned from HTTP request data.
  1164. * @return string Returns a string escaped with slashes.
  1165. */
  1166. function addslashes_gpc($gpc) {
  1167. if ( get_magic_quotes_gpc() )
  1168. $gpc = stripslashes($gpc);
  1169. return esc_sql($gpc);
  1170. }
  1171. /**
  1172. * Navigates through an array and removes slashes from the values.
  1173. *
  1174. * If an array is passed, the array_map() function causes a callback to pass the
  1175. * value back to the function. The slashes from this value will removed.
  1176. *
  1177. * @since 2.0.0
  1178. *
  1179. * @param array|string $value The array or string to be stripped.
  1180. * @return array|string Stripped array (or string in the callback).
  1181. */
  1182. function stripslashes_deep($value) {
  1183. if ( is_array($value) ) {
  1184. $value = array_map('stripslashes_deep', $value);
  1185. } elseif ( is_object($value) ) {
  1186. $vars = get_object_vars( $value );
  1187. foreach ($vars as $key=>$data) {
  1188. $value->{$key} = stripslashes_deep( $data );
  1189. }
  1190. } else {
  1191. $value = stripslashes($value);
  1192. }
  1193. return $value;
  1194. }
  1195. /**
  1196. * Navigates through an array and encodes the values to be used in a URL.
  1197. *
  1198. * Uses a callback to pass the value of the array back to the function as a
  1199. * string.
  1200. *
  1201. * @since 2.2.0
  1202. *
  1203. * @param array|string $value The array or string to be encoded.
  1204. * @return array|string $value The encoded array (or string from the callback).
  1205. */
  1206. function urlencode_deep($value) {
  1207. $value = is_array($value) ? array_map('urlencode_deep', $value) : urlencode($value);
  1208. return $value;
  1209. }
  1210. /**
  1211. * Converts email addresses characters to HTML entities to block spam bots.
  1212. *
  1213. * @since 0.71
  1214. *
  1215. * @param string $emailaddy Email address.
  1216. * @param int $mailto Optional. Range from 0 to 1. Used for encoding.
  1217. * @return string Converted email address.
  1218. */
  1219. function antispambot($emailaddy, $mailto=0) {
  1220. $emailNOSPAMaddy = '';
  1221. srand ((float) microtime() * 1000000);
  1222. for ($i = 0; $i < strlen($emailaddy); $i = $i + 1) {
  1223. $j = floor(rand(0, 1+$mailto));
  1224. if ($j==0) {
  1225. $emailNOSPAMaddy .= '&#'.ord(substr($emailaddy,$i,1)).';';
  1226. } elseif ($j==1) {
  1227. $emailNOSPAMaddy .= substr($emailaddy,$i,1);
  1228. } elseif ($j==2) {
  1229. $emailNOSPAMaddy .= '%'.zeroise(dechex(ord(substr($emailaddy, $i, 1))), 2);
  1230. }
  1231. }
  1232. $emailNOSPAMaddy = str_replace('@','&#64;',$emailNOSPAMaddy);
  1233. return $emailNOSPAMaddy;
  1234. }
  1235. /**
  1236. * Callback to convert URI match to HTML A element.
  1237. *
  1238. * This function was backported from 2.5.0 to 2.3.2. Regex callback for {@link
  1239. * make_clickable()}.
  1240. *
  1241. * @since 2.3.2
  1242. * @access private
  1243. *
  1244. * @param array $matches Single Regex Match.
  1245. * @return string HTML A element with URI address.
  1246. */

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