PageRenderTime 60ms CodeModel.GetById 16ms RepoModel.GetById 0ms app.codeStats 1ms

/wp-includes/formatting.php

https://bitbucket.org/crafttheweb/wordpress-fold
PHP | 3246 lines | 1970 code | 266 blank | 1010 comment | 257 complexity | 4fdcfcc25862c39f89aaf7b92c6fc988 MD5 | raw file
Possible License(s): GPL-2.0, AGPL-1.0, LGPL-2.1
  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. * @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 $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|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. * @param array $matches preg_replace_callback matches array
  233. * @return string
  234. */
  235. function _autop_newline_preservation_helper( $matches ) {
  236. return str_replace("\n", "<WPPreserveNewline />", $matches[0]);
  237. }
  238. /**
  239. * Don't auto-p wrap shortcodes that stand alone
  240. *
  241. * Ensures that shortcodes are not wrapped in <<p>>...<</p>>.
  242. *
  243. * @since 2.9.0
  244. *
  245. * @param string $pee The content.
  246. * @return string The filtered content.
  247. */
  248. function shortcode_unautop( $pee ) {
  249. global $shortcode_tags;
  250. if ( empty( $shortcode_tags ) || !is_array( $shortcode_tags ) ) {
  251. return $pee;
  252. }
  253. $tagregexp = join( '|', array_map( 'preg_quote', array_keys( $shortcode_tags ) ) );
  254. $pattern =
  255. '/'
  256. . '<p>' // Opening paragraph
  257. . '\\s*+' // Optional leading whitespace
  258. . '(' // 1: The shortcode
  259. . '\\[' // Opening bracket
  260. . "($tagregexp)" // 2: Shortcode name
  261. . '\\b' // Word boundary
  262. // Unroll the loop: Inside the opening shortcode tag
  263. . '[^\\]\\/]*' // Not a closing bracket or forward slash
  264. . '(?:'
  265. . '\\/(?!\\])' // A forward slash not followed by a closing bracket
  266. . '[^\\]\\/]*' // Not a closing bracket or forward slash
  267. . ')*?'
  268. . '(?:'
  269. . '\\/\\]' // Self closing tag and closing bracket
  270. . '|'
  271. . '\\]' // Closing bracket
  272. . '(?:' // Unroll the loop: Optionally, anything between the opening and closing shortcode tags
  273. . '[^\\[]*+' // Not an opening bracket
  274. . '(?:'
  275. . '\\[(?!\\/\\2\\])' // An opening bracket not followed by the closing shortcode tag
  276. . '[^\\[]*+' // Not an opening bracket
  277. . ')*+'
  278. . '\\[\\/\\2\\]' // Closing shortcode tag
  279. . ')?'
  280. . ')'
  281. . ')'
  282. . '\\s*+' // optional trailing whitespace
  283. . '<\\/p>' // closing paragraph
  284. . '/s';
  285. return preg_replace( $pattern, '$1', $pee );
  286. }
  287. /**
  288. * Checks to see if a string is utf8 encoded.
  289. *
  290. * NOTE: This function checks for 5-Byte sequences, UTF8
  291. * has Bytes Sequences with a maximum length of 4.
  292. *
  293. * @author bmorel at ssi dot fr (modified)
  294. * @since 1.2.1
  295. *
  296. * @param string $str The string to be checked
  297. * @return bool True if $str fits a UTF-8 model, false otherwise.
  298. */
  299. function seems_utf8($str) {
  300. $length = strlen($str);
  301. for ($i=0; $i < $length; $i++) {
  302. $c = ord($str[$i]);
  303. if ($c < 0x80) $n = 0; # 0bbbbbbb
  304. elseif (($c & 0xE0) == 0xC0) $n=1; # 110bbbbb
  305. elseif (($c & 0xF0) == 0xE0) $n=2; # 1110bbbb
  306. elseif (($c & 0xF8) == 0xF0) $n=3; # 11110bbb
  307. elseif (($c & 0xFC) == 0xF8) $n=4; # 111110bb
  308. elseif (($c & 0xFE) == 0xFC) $n=5; # 1111110b
  309. else return false; # Does not match any model
  310. for ($j=0; $j<$n; $j++) { # n bytes matching 10bbbbbb follow ?
  311. if ((++$i == $length) || ((ord($str[$i]) & 0xC0) != 0x80))
  312. return false;
  313. }
  314. }
  315. return true;
  316. }
  317. /**
  318. * Converts a number of special characters into their HTML entities.
  319. *
  320. * Specifically deals with: &, <, >, ", and '.
  321. *
  322. * $quote_style can be set to ENT_COMPAT to encode " to
  323. * &quot;, or ENT_QUOTES to do both. Default is ENT_NOQUOTES where no quotes are encoded.
  324. *
  325. * @since 1.2.2
  326. *
  327. * @param string $string The text which is to be encoded.
  328. * @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.
  329. * @param string $charset Optional. The character encoding of the string. Default is false.
  330. * @param boolean $double_encode Optional. Whether to encode existing html entities. Default is false.
  331. * @return string The encoded text with HTML entities.
  332. */
  333. function _wp_specialchars( $string, $quote_style = ENT_NOQUOTES, $charset = false, $double_encode = false ) {
  334. $string = (string) $string;
  335. if ( 0 === strlen( $string ) )
  336. return '';
  337. // Don't bother if there are no specialchars - saves some processing
  338. if ( ! preg_match( '/[&<>"\']/', $string ) )
  339. return $string;
  340. // Account for the previous behaviour of the function when the $quote_style is not an accepted value
  341. if ( empty( $quote_style ) )
  342. $quote_style = ENT_NOQUOTES;
  343. elseif ( ! in_array( $quote_style, array( 0, 2, 3, 'single', 'double' ), true ) )
  344. $quote_style = ENT_QUOTES;
  345. // Store the site charset as a static to avoid multiple calls to wp_load_alloptions()
  346. if ( ! $charset ) {
  347. static $_charset;
  348. if ( ! isset( $_charset ) ) {
  349. $alloptions = wp_load_alloptions();
  350. $_charset = isset( $alloptions['blog_charset'] ) ? $alloptions['blog_charset'] : '';
  351. }
  352. $charset = $_charset;
  353. }
  354. if ( in_array( $charset, array( 'utf8', 'utf-8', 'UTF8' ) ) )
  355. $charset = 'UTF-8';
  356. $_quote_style = $quote_style;
  357. if ( $quote_style === 'double' ) {
  358. $quote_style = ENT_COMPAT;
  359. $_quote_style = ENT_COMPAT;
  360. } elseif ( $quote_style === 'single' ) {
  361. $quote_style = ENT_NOQUOTES;
  362. }
  363. // Handle double encoding ourselves
  364. if ( $double_encode ) {
  365. $string = @htmlspecialchars( $string, $quote_style, $charset );
  366. } else {
  367. // Decode &amp; into &
  368. $string = wp_specialchars_decode( $string, $_quote_style );
  369. // Guarantee every &entity; is valid or re-encode the &
  370. $string = wp_kses_normalize_entities( $string );
  371. // Now re-encode everything except &entity;
  372. $string = preg_split( '/(&#?x?[0-9a-z]+;)/i', $string, -1, PREG_SPLIT_DELIM_CAPTURE );
  373. for ( $i = 0; $i < count( $string ); $i += 2 )
  374. $string[$i] = @htmlspecialchars( $string[$i], $quote_style, $charset );
  375. $string = implode( '', $string );
  376. }
  377. // Backwards compatibility
  378. if ( 'single' === $_quote_style )
  379. $string = str_replace( "'", '&#039;', $string );
  380. return $string;
  381. }
  382. /**
  383. * Converts a number of HTML entities into their special characters.
  384. *
  385. * Specifically deals with: &, <, >, ", and '.
  386. *
  387. * $quote_style can be set to ENT_COMPAT to decode " entities,
  388. * or ENT_QUOTES to do both " and '. Default is ENT_NOQUOTES where no quotes are decoded.
  389. *
  390. * @since 2.8
  391. *
  392. * @param string $string The text which is to be decoded.
  393. * @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.
  394. * @return string The decoded text without HTML entities.
  395. */
  396. function wp_specialchars_decode( $string, $quote_style = ENT_NOQUOTES ) {
  397. $string = (string) $string;
  398. if ( 0 === strlen( $string ) ) {
  399. return '';
  400. }
  401. // Don't bother if there are no entities - saves a lot of processing
  402. if ( strpos( $string, '&' ) === false ) {
  403. return $string;
  404. }
  405. // Match the previous behaviour of _wp_specialchars() when the $quote_style is not an accepted value
  406. if ( empty( $quote_style ) ) {
  407. $quote_style = ENT_NOQUOTES;
  408. } elseif ( !in_array( $quote_style, array( 0, 2, 3, 'single', 'double' ), true ) ) {
  409. $quote_style = ENT_QUOTES;
  410. }
  411. // More complete than get_html_translation_table( HTML_SPECIALCHARS )
  412. $single = array( '&#039;' => '\'', '&#x27;' => '\'' );
  413. $single_preg = array( '/&#0*39;/' => '&#039;', '/&#x0*27;/i' => '&#x27;' );
  414. $double = array( '&quot;' => '"', '&#034;' => '"', '&#x22;' => '"' );
  415. $double_preg = array( '/&#0*34;/' => '&#034;', '/&#x0*22;/i' => '&#x22;' );
  416. $others = array( '&lt;' => '<', '&#060;' => '<', '&gt;' => '>', '&#062;' => '>', '&amp;' => '&', '&#038;' => '&', '&#x26;' => '&' );
  417. $others_preg = array( '/&#0*60;/' => '&#060;', '/&#0*62;/' => '&#062;', '/&#0*38;/' => '&#038;', '/&#x0*26;/i' => '&#x26;' );
  418. if ( $quote_style === ENT_QUOTES ) {
  419. $translation = array_merge( $single, $double, $others );
  420. $translation_preg = array_merge( $single_preg, $double_preg, $others_preg );
  421. } elseif ( $quote_style === ENT_COMPAT || $quote_style === 'double' ) {
  422. $translation = array_merge( $double, $others );
  423. $translation_preg = array_merge( $double_preg, $others_preg );
  424. } elseif ( $quote_style === 'single' ) {
  425. $translation = array_merge( $single, $others );
  426. $translation_preg = array_merge( $single_preg, $others_preg );
  427. } elseif ( $quote_style === ENT_NOQUOTES ) {
  428. $translation = $others;
  429. $translation_preg = $others_preg;
  430. }
  431. // Remove zero padding on numeric entities
  432. $string = preg_replace( array_keys( $translation_preg ), array_values( $translation_preg ), $string );
  433. // Replace characters according to translation table
  434. return strtr( $string, $translation );
  435. }
  436. /**
  437. * Checks for invalid UTF8 in a string.
  438. *
  439. * @since 2.8
  440. *
  441. * @param string $string The text which is to be checked.
  442. * @param boolean $strip Optional. Whether to attempt to strip out invalid UTF8. Default is false.
  443. * @return string The checked text.
  444. */
  445. function wp_check_invalid_utf8( $string, $strip = false ) {
  446. $string = (string) $string;
  447. if ( 0 === strlen( $string ) ) {
  448. return '';
  449. }
  450. // Store the site charset as a static to avoid multiple calls to get_option()
  451. static $is_utf8;
  452. if ( !isset( $is_utf8 ) ) {
  453. $is_utf8 = in_array( get_option( 'blog_charset' ), array( 'utf8', 'utf-8', 'UTF8', 'UTF-8' ) );
  454. }
  455. if ( !$is_utf8 ) {
  456. return $string;
  457. }
  458. // Check for support for utf8 in the installed PCRE library once and store the result in a static
  459. static $utf8_pcre;
  460. if ( !isset( $utf8_pcre ) ) {
  461. $utf8_pcre = @preg_match( '/^./u', 'a' );
  462. }
  463. // We can't demand utf8 in the PCRE installation, so just return the string in those cases
  464. if ( !$utf8_pcre ) {
  465. return $string;
  466. }
  467. // preg_match fails when it encounters invalid UTF8 in $string
  468. if ( 1 === @preg_match( '/^./us', $string ) ) {
  469. return $string;
  470. }
  471. // Attempt to strip the bad chars if requested (not recommended)
  472. if ( $strip && function_exists( 'iconv' ) ) {
  473. return iconv( 'utf-8', 'utf-8', $string );
  474. }
  475. return '';
  476. }
  477. /**
  478. * Encode the Unicode values to be used in the URI.
  479. *
  480. * @since 1.5.0
  481. *
  482. * @param string $utf8_string
  483. * @param int $length Max length of the string
  484. * @return string String with Unicode encoded for URI.
  485. */
  486. function utf8_uri_encode( $utf8_string, $length = 0 ) {
  487. $unicode = '';
  488. $values = array();
  489. $num_octets = 1;
  490. $unicode_length = 0;
  491. $string_length = strlen( $utf8_string );
  492. for ($i = 0; $i < $string_length; $i++ ) {
  493. $value = ord( $utf8_string[ $i ] );
  494. if ( $value < 128 ) {
  495. if ( $length && ( $unicode_length >= $length ) )
  496. break;
  497. $unicode .= chr($value);
  498. $unicode_length++;
  499. } else {
  500. if ( count( $values ) == 0 ) $num_octets = ( $value < 224 ) ? 2 : 3;
  501. $values[] = $value;
  502. if ( $length && ( $unicode_length + ($num_octets * 3) ) > $length )
  503. break;
  504. if ( count( $values ) == $num_octets ) {
  505. if ($num_octets == 3) {
  506. $unicode .= '%' . dechex($values[0]) . '%' . dechex($values[1]) . '%' . dechex($values[2]);
  507. $unicode_length += 9;
  508. } else {
  509. $unicode .= '%' . dechex($values[0]) . '%' . dechex($values[1]);
  510. $unicode_length += 6;
  511. }
  512. $values = array();
  513. $num_octets = 1;
  514. }
  515. }
  516. }
  517. return $unicode;
  518. }
  519. /**
  520. * Converts all accent characters to ASCII characters.
  521. *
  522. * If there are no accent characters, then the string given is just returned.
  523. *
  524. * @since 1.2.1
  525. *
  526. * @param string $string Text that might have accent characters
  527. * @return string Filtered string with replaced "nice" characters.
  528. */
  529. function remove_accents($string) {
  530. if ( !preg_match('/[\x80-\xff]/', $string) )
  531. return $string;
  532. if (seems_utf8($string)) {
  533. $chars = array(
  534. // Decompositions for Latin-1 Supplement
  535. chr(194).chr(170) => 'a', chr(194).chr(186) => 'o',
  536. chr(195).chr(128) => 'A', chr(195).chr(129) => 'A',
  537. chr(195).chr(130) => 'A', chr(195).chr(131) => 'A',
  538. chr(195).chr(132) => 'A', chr(195).chr(133) => 'A',
  539. chr(195).chr(134) => 'AE',chr(195).chr(135) => 'C',
  540. chr(195).chr(136) => 'E', chr(195).chr(137) => 'E',
  541. chr(195).chr(138) => 'E', chr(195).chr(139) => 'E',
  542. chr(195).chr(140) => 'I', chr(195).chr(141) => 'I',
  543. chr(195).chr(142) => 'I', chr(195).chr(143) => 'I',
  544. chr(195).chr(144) => 'D', chr(195).chr(145) => 'N',
  545. chr(195).chr(146) => 'O', chr(195).chr(147) => 'O',
  546. chr(195).chr(148) => 'O', chr(195).chr(149) => 'O',
  547. chr(195).chr(150) => 'O', chr(195).chr(153) => 'U',
  548. chr(195).chr(154) => 'U', chr(195).chr(155) => 'U',
  549. chr(195).chr(156) => 'U', chr(195).chr(157) => 'Y',
  550. chr(195).chr(158) => 'TH',chr(195).chr(159) => 's',
  551. chr(195).chr(160) => 'a', chr(195).chr(161) => 'a',
  552. chr(195).chr(162) => 'a', chr(195).chr(163) => 'a',
  553. chr(195).chr(164) => 'a', chr(195).chr(165) => 'a',
  554. chr(195).chr(166) => 'ae',chr(195).chr(167) => 'c',
  555. chr(195).chr(168) => 'e', chr(195).chr(169) => 'e',
  556. chr(195).chr(170) => 'e', chr(195).chr(171) => 'e',
  557. chr(195).chr(172) => 'i', chr(195).chr(173) => 'i',
  558. chr(195).chr(174) => 'i', chr(195).chr(175) => 'i',
  559. chr(195).chr(176) => 'd', chr(195).chr(177) => 'n',
  560. chr(195).chr(178) => 'o', chr(195).chr(179) => 'o',
  561. chr(195).chr(180) => 'o', chr(195).chr(181) => 'o',
  562. chr(195).chr(182) => 'o', chr(195).chr(184) => 'o',
  563. chr(195).chr(185) => 'u', chr(195).chr(186) => 'u',
  564. chr(195).chr(187) => 'u', chr(195).chr(188) => 'u',
  565. chr(195).chr(189) => 'y', chr(195).chr(190) => 'th',
  566. chr(195).chr(191) => 'y', chr(195).chr(152) => 'O',
  567. // Decompositions for Latin Extended-A
  568. chr(196).chr(128) => 'A', chr(196).chr(129) => 'a',
  569. chr(196).chr(130) => 'A', chr(196).chr(131) => 'a',
  570. chr(196).chr(132) => 'A', chr(196).chr(133) => 'a',
  571. chr(196).chr(134) => 'C', chr(196).chr(135) => 'c',
  572. chr(196).chr(136) => 'C', chr(196).chr(137) => 'c',
  573. chr(196).chr(138) => 'C', chr(196).chr(139) => 'c',
  574. chr(196).chr(140) => 'C', chr(196).chr(141) => 'c',
  575. chr(196).chr(142) => 'D', chr(196).chr(143) => 'd',
  576. chr(196).chr(144) => 'D', chr(196).chr(145) => 'd',
  577. chr(196).chr(146) => 'E', chr(196).chr(147) => 'e',
  578. chr(196).chr(148) => 'E', chr(196).chr(149) => 'e',
  579. chr(196).chr(150) => 'E', chr(196).chr(151) => 'e',
  580. chr(196).chr(152) => 'E', chr(196).chr(153) => 'e',
  581. chr(196).chr(154) => 'E', chr(196).chr(155) => 'e',
  582. chr(196).chr(156) => 'G', chr(196).chr(157) => 'g',
  583. chr(196).chr(158) => 'G', chr(196).chr(159) => 'g',
  584. chr(196).chr(160) => 'G', chr(196).chr(161) => 'g',
  585. chr(196).chr(162) => 'G', chr(196).chr(163) => 'g',
  586. chr(196).chr(164) => 'H', chr(196).chr(165) => 'h',
  587. chr(196).chr(166) => 'H', chr(196).chr(167) => 'h',
  588. chr(196).chr(168) => 'I', chr(196).chr(169) => 'i',
  589. chr(196).chr(170) => 'I', chr(196).chr(171) => 'i',
  590. chr(196).chr(172) => 'I', chr(196).chr(173) => 'i',
  591. chr(196).chr(174) => 'I', chr(196).chr(175) => 'i',
  592. chr(196).chr(176) => 'I', chr(196).chr(177) => 'i',
  593. chr(196).chr(178) => 'IJ',chr(196).chr(179) => 'ij',
  594. chr(196).chr(180) => 'J', chr(196).chr(181) => 'j',
  595. chr(196).chr(182) => 'K', chr(196).chr(183) => 'k',
  596. chr(196).chr(184) => 'k', chr(196).chr(185) => 'L',
  597. chr(196).chr(186) => 'l', chr(196).chr(187) => 'L',
  598. chr(196).chr(188) => 'l', chr(196).chr(189) => 'L',
  599. chr(196).chr(190) => 'l', chr(196).chr(191) => 'L',
  600. chr(197).chr(128) => 'l', chr(197).chr(129) => 'L',
  601. chr(197).chr(130) => 'l', chr(197).chr(131) => 'N',
  602. chr(197).chr(132) => 'n', chr(197).chr(133) => 'N',
  603. chr(197).chr(134) => 'n', chr(197).chr(135) => 'N',
  604. chr(197).chr(136) => 'n', chr(197).chr(137) => 'N',
  605. chr(197).chr(138) => 'n', chr(197).chr(139) => 'N',
  606. chr(197).chr(140) => 'O', chr(197).chr(141) => 'o',
  607. chr(197).chr(142) => 'O', chr(197).chr(143) => 'o',
  608. chr(197).chr(144) => 'O', chr(197).chr(145) => 'o',
  609. chr(197).chr(146) => 'OE',chr(197).chr(147) => 'oe',
  610. chr(197).chr(148) => 'R',chr(197).chr(149) => 'r',
  611. chr(197).chr(150) => 'R',chr(197).chr(151) => 'r',
  612. chr(197).chr(152) => 'R',chr(197).chr(153) => 'r',
  613. chr(197).chr(154) => 'S',chr(197).chr(155) => 's',
  614. chr(197).chr(156) => 'S',chr(197).chr(157) => 's',
  615. chr(197).chr(158) => 'S',chr(197).chr(159) => 's',
  616. chr(197).chr(160) => 'S', chr(197).chr(161) => 's',
  617. chr(197).chr(162) => 'T', chr(197).chr(163) => 't',
  618. chr(197).chr(164) => 'T', chr(197).chr(165) => 't',
  619. chr(197).chr(166) => 'T', chr(197).chr(167) => 't',
  620. chr(197).chr(168) => 'U', chr(197).chr(169) => 'u',
  621. chr(197).chr(170) => 'U', chr(197).chr(171) => 'u',
  622. chr(197).chr(172) => 'U', chr(197).chr(173) => 'u',
  623. chr(197).chr(174) => 'U', chr(197).chr(175) => 'u',
  624. chr(197).chr(176) => 'U', chr(197).chr(177) => 'u',
  625. chr(197).chr(178) => 'U', chr(197).chr(179) => 'u',
  626. chr(197).chr(180) => 'W', chr(197).chr(181) => 'w',
  627. chr(197).chr(182) => 'Y', chr(197).chr(183) => 'y',
  628. chr(197).chr(184) => 'Y', chr(197).chr(185) => 'Z',
  629. chr(197).chr(186) => 'z', chr(197).chr(187) => 'Z',
  630. chr(197).chr(188) => 'z', chr(197).chr(189) => 'Z',
  631. chr(197).chr(190) => 'z', chr(197).chr(191) => 's',
  632. // Decompositions for Latin Extended-B
  633. chr(200).chr(152) => 'S', chr(200).chr(153) => 's',
  634. chr(200).chr(154) => 'T', chr(200).chr(155) => 't',
  635. // Euro Sign
  636. chr(226).chr(130).chr(172) => 'E',
  637. // GBP (Pound) Sign
  638. chr(194).chr(163) => '',
  639. // Vowels with diacritic (Vietnamese)
  640. // unmarked
  641. chr(198).chr(160) => 'O', chr(198).chr(161) => 'o',
  642. chr(198).chr(175) => 'U', chr(198).chr(176) => 'u',
  643. // grave accent
  644. chr(225).chr(186).chr(166) => 'A', chr(225).chr(186).chr(167) => 'a',
  645. chr(225).chr(186).chr(176) => 'A', chr(225).chr(186).chr(177) => 'a',
  646. chr(225).chr(187).chr(128) => 'E', chr(225).chr(187).chr(129) => 'e',
  647. chr(225).chr(187).chr(146) => 'O', chr(225).chr(187).chr(147) => 'o',
  648. chr(225).chr(187).chr(156) => 'O', chr(225).chr(187).chr(157) => 'o',
  649. chr(225).chr(187).chr(170) => 'U', chr(225).chr(187).chr(171) => 'u',
  650. chr(225).chr(187).chr(178) => 'Y', chr(225).chr(187).chr(179) => 'y',
  651. // hook
  652. chr(225).chr(186).chr(162) => 'A', chr(225).chr(186).chr(163) => 'a',
  653. chr(225).chr(186).chr(168) => 'A', chr(225).chr(186).chr(169) => 'a',
  654. chr(225).chr(186).chr(178) => 'A', chr(225).chr(186).chr(179) => 'a',
  655. chr(225).chr(186).chr(186) => 'E', chr(225).chr(186).chr(187) => 'e',
  656. chr(225).chr(187).chr(130) => 'E', chr(225).chr(187).chr(131) => 'e',
  657. chr(225).chr(187).chr(136) => 'I', chr(225).chr(187).chr(137) => 'i',
  658. chr(225).chr(187).chr(142) => 'O', chr(225).chr(187).chr(143) => 'o',
  659. chr(225).chr(187).chr(148) => 'O', chr(225).chr(187).chr(149) => 'o',
  660. chr(225).chr(187).chr(158) => 'O', chr(225).chr(187).chr(159) => 'o',
  661. chr(225).chr(187).chr(166) => 'U', chr(225).chr(187).chr(167) => 'u',
  662. chr(225).chr(187).chr(172) => 'U', chr(225).chr(187).chr(173) => 'u',
  663. chr(225).chr(187).chr(182) => 'Y', chr(225).chr(187).chr(183) => 'y',
  664. // tilde
  665. chr(225).chr(186).chr(170) => 'A', chr(225).chr(186).chr(171) => 'a',
  666. chr(225).chr(186).chr(180) => 'A', chr(225).chr(186).chr(181) => 'a',
  667. chr(225).chr(186).chr(188) => 'E', chr(225).chr(186).chr(189) => 'e',
  668. chr(225).chr(187).chr(132) => 'E', chr(225).chr(187).chr(133) => 'e',
  669. chr(225).chr(187).chr(150) => 'O', chr(225).chr(187).chr(151) => 'o',
  670. chr(225).chr(187).chr(160) => 'O', chr(225).chr(187).chr(161) => 'o',
  671. chr(225).chr(187).chr(174) => 'U', chr(225).chr(187).chr(175) => 'u',
  672. chr(225).chr(187).chr(184) => 'Y', chr(225).chr(187).chr(185) => 'y',
  673. // acute accent
  674. chr(225).chr(186).chr(164) => 'A', chr(225).chr(186).chr(165) => 'a',
  675. chr(225).chr(186).chr(174) => 'A', chr(225).chr(186).chr(175) => 'a',
  676. chr(225).chr(186).chr(190) => 'E', chr(225).chr(186).chr(191) => 'e',
  677. chr(225).chr(187).chr(144) => 'O', chr(225).chr(187).chr(145) => 'o',
  678. chr(225).chr(187).chr(154) => 'O', chr(225).chr(187).chr(155) => 'o',
  679. chr(225).chr(187).chr(168) => 'U', chr(225).chr(187).chr(169) => 'u',
  680. // dot below
  681. chr(225).chr(186).chr(160) => 'A', chr(225).chr(186).chr(161) => 'a',
  682. chr(225).chr(186).chr(172) => 'A', chr(225).chr(186).chr(173) => 'a',
  683. chr(225).chr(186).chr(182) => 'A', chr(225).chr(186).chr(183) => 'a',
  684. chr(225).chr(186).chr(184) => 'E', chr(225).chr(186).chr(185) => 'e',
  685. chr(225).chr(187).chr(134) => 'E', chr(225).chr(187).chr(135) => 'e',
  686. chr(225).chr(187).chr(138) => 'I', chr(225).chr(187).chr(139) => 'i',
  687. chr(225).chr(187).chr(140) => 'O', chr(225).chr(187).chr(141) => 'o',
  688. chr(225).chr(187).chr(152) => 'O', chr(225).chr(187).chr(153) => 'o',
  689. chr(225).chr(187).chr(162) => 'O', chr(225).chr(187).chr(163) => 'o',
  690. chr(225).chr(187).chr(164) => 'U', chr(225).chr(187).chr(165) => 'u',
  691. chr(225).chr(187).chr(176) => 'U', chr(225).chr(187).chr(177) => 'u',
  692. chr(225).chr(187).chr(180) => 'Y', chr(225).chr(187).chr(181) => 'y',
  693. );
  694. $string = strtr($string, $chars);
  695. } else {
  696. // Assume ISO-8859-1 if not UTF-8
  697. $chars['in'] = chr(128).chr(131).chr(138).chr(142).chr(154).chr(158)
  698. .chr(159).chr(162).chr(165).chr(181).chr(192).chr(193).chr(194)
  699. .chr(195).chr(196).chr(197).chr(199).chr(200).chr(201).chr(202)
  700. .chr(203).chr(204).chr(205).chr(206).chr(207).chr(209).chr(210)
  701. .chr(211).chr(212).chr(213).chr(214).chr(216).chr(217).chr(218)
  702. .chr(219).chr(220).chr(221).chr(224).chr(225).chr(226).chr(227)
  703. .chr(228).chr(229).chr(231).chr(232).chr(233).chr(234).chr(235)
  704. .chr(236).chr(237).chr(238).chr(239).chr(241).chr(242).chr(243)
  705. .chr(244).chr(245).chr(246).chr(248).chr(249).chr(250).chr(251)
  706. .chr(252).chr(253).chr(255);
  707. $chars['out'] = "EfSZszYcYuAAAAAACEEEEIIIINOOOOOOUUUUYaaaaaaceeeeiiiinoooooouuuuyy";
  708. $string = strtr($string, $chars['in'], $chars['out']);
  709. $double_chars['in'] = array(chr(140), chr(156), chr(198), chr(208), chr(222), chr(223), chr(230), chr(240), chr(254));
  710. $double_chars['out'] = array('OE', 'oe', 'AE', 'DH', 'TH', 'ss', 'ae', 'dh', 'th');
  711. $string = str_replace($double_chars['in'], $double_chars['out'], $string);
  712. }
  713. return $string;
  714. }
  715. /**
  716. * Sanitizes a filename replacing whitespace with dashes
  717. *
  718. * Removes special characters that are illegal in filenames on certain
  719. * operating systems and special characters requiring special escaping
  720. * to manipulate at the command line. Replaces spaces and consecutive
  721. * dashes with a single dash. Trim period, dash and underscore from beginning
  722. * and end of filename.
  723. *
  724. * @since 2.1.0
  725. *
  726. * @param string $filename The filename to be sanitized
  727. * @return string The sanitized filename
  728. */
  729. function sanitize_file_name( $filename ) {
  730. $filename_raw = $filename;
  731. $special_chars = array("?", "[", "]", "/", "\\", "=", "<", ">", ":", ";", ",", "'", "\"", "&", "$", "#", "*", "(", ")", "|", "~", "`", "!", "{", "}", chr(0));
  732. $special_chars = apply_filters('sanitize_file_name_chars', $special_chars, $filename_raw);
  733. $filename = str_replace($special_chars, '', $filename);
  734. $filename = preg_replace('/[\s-]+/', '-', $filename);
  735. $filename = trim($filename, '.-_');
  736. // Split the filename into a base and extension[s]
  737. $parts = explode('.', $filename);
  738. // Return if only one extension
  739. if ( count($parts) <= 2 )
  740. return apply_filters('sanitize_file_name', $filename, $filename_raw);
  741. // Process multiple extensions
  742. $filename = array_shift($parts);
  743. $extension = array_pop($parts);
  744. $mimes = get_allowed_mime_types();
  745. // Loop over any intermediate extensions. Munge them with a trailing underscore if they are a 2 - 5 character
  746. // long alpha string not in the extension whitelist.
  747. foreach ( (array) $parts as $part) {
  748. $filename .= '.' . $part;
  749. if ( preg_match("/^[a-zA-Z]{2,5}\d?$/", $part) ) {
  750. $allowed = false;
  751. foreach ( $mimes as $ext_preg => $mime_match ) {
  752. $ext_preg = '!^(' . $ext_preg . ')$!i';
  753. if ( preg_match( $ext_preg, $part ) ) {
  754. $allowed = true;
  755. break;
  756. }
  757. }
  758. if ( !$allowed )
  759. $filename .= '_';
  760. }
  761. }
  762. $filename .= '.' . $extension;
  763. return apply_filters('sanitize_file_name', $filename, $filename_raw);
  764. }
  765. /**
  766. * Sanitize username stripping out unsafe characters.
  767. *
  768. * Removes tags, octets, entities, and if strict is enabled, will only keep
  769. * alphanumeric, _, space, ., -, @. After sanitizing, it passes the username,
  770. * raw username (the username in the parameter), and the value of $strict as
  771. * parameters for the 'sanitize_user' filter.
  772. *
  773. * @since 2.0.0
  774. * @uses apply_filters() Calls 'sanitize_user' hook on username, raw username,
  775. * and $strict parameter.
  776. *
  777. * @param string $username The username to be sanitized.
  778. * @param bool $strict If set limits $username to specific characters. Default false.
  779. * @return string The sanitized username, after passing through filters.
  780. */
  781. function sanitize_user( $username, $strict = false ) {
  782. $raw_username = $username;
  783. $username = wp_strip_all_tags( $username );
  784. $username = remove_accents( $username );
  785. // Kill octets
  786. $username = preg_replace( '|%([a-fA-F0-9][a-fA-F0-9])|', '', $username );
  787. $username = preg_replace( '/&.+?;/', '', $username ); // Kill entities
  788. // If strict, reduce to ASCII for max portability.
  789. if ( $strict )
  790. $username = preg_replace( '|[^a-z0-9 _.\-@]|i', '', $username );
  791. $username = trim( $username );
  792. // Consolidate contiguous whitespace
  793. $username = preg_replace( '|\s+|', ' ', $username );
  794. return apply_filters( 'sanitize_user', $username, $raw_username, $strict );
  795. }
  796. /**
  797. * Sanitize a string key.
  798. *
  799. * Keys are used as internal identifiers. Lowercase alphanumeric characters, dashes and underscores are allowed.
  800. *
  801. * @since 3.0.0
  802. *
  803. * @param string $key String key
  804. * @return string Sanitized key
  805. */
  806. function sanitize_key( $key ) {
  807. $raw_key = $key;
  808. $key = strtolower( $key );
  809. $key = preg_replace( '/[^a-z0-9_\-]/', '', $key );
  810. return apply_filters( 'sanitize_key', $key, $raw_key );
  811. }
  812. /**
  813. * Sanitizes title or use fallback title.
  814. *
  815. * Specifically, HTML and PHP tags are stripped. Further actions can be added
  816. * via the plugin API. If $title is empty and $fallback_title is set, the latter
  817. * will be used.
  818. *
  819. * @since 1.0.0
  820. *
  821. * @param string $title The string to be sanitized.
  822. * @param string $fallback_title Optional. A title to use if $title is empty.
  823. * @param string $context Optional. The operation for which the string is sanitized
  824. * @return string The sanitized string.
  825. */
  826. function sanitize_title($title, $fallback_title = '', $context = 'save') {
  827. $raw_title = $title;
  828. if ( 'save' == $context )
  829. $title = remove_accents($title);
  830. $title = apply_filters('sanitize_title', $title, $raw_title, $context);
  831. if ( '' === $title || false === $title )
  832. $title = $fallback_title;
  833. return $title;
  834. }
  835. function sanitize_title_for_query($title) {
  836. return sanitize_title($title, '', 'query');
  837. }
  838. /**
  839. * Sanitizes title, replacing whitespace and a few other characters with dashes.
  840. *
  841. * Limits the output to alphanumeric characters, underscore (_) and dash (-).
  842. * Whitespace becomes a dash.
  843. *
  844. * @since 1.2.0
  845. *
  846. * @param string $title The title to be sanitized.
  847. * @param string $raw_title Optional. Not used.
  848. * @param string $context Optional. The operation for which the string is sanitized.
  849. * @return string The sanitized title.
  850. */
  851. function sanitize_title_with_dashes($title, $raw_title = '', $context = 'display') {
  852. $title = strip_tags($title);
  853. // Preserve escaped octets.
  854. $title = preg_replace('|%([a-fA-F0-9][a-fA-F0-9])|', '---$1---', $title);
  855. // Remove percent signs that are not part of an octet.
  856. $title = str_replace('%', '', $title);
  857. // Restore octets.
  858. $title = preg_replace('|---([a-fA-F0-9][a-fA-F0-9])---|', '%$1', $title);
  859. if (seems_utf8($title)) {
  860. if (function_exists('mb_strtolower')) {
  861. $title = mb_strtolower($title, 'UTF-8');
  862. }
  863. $title = utf8_uri_encode($title, 200);
  864. }
  865. $title = strtolower($title);
  866. $title = preg_replace('/&.+?;/', '', $title); // kill entities
  867. $title = str_replace('.', '-', $title);
  868. if ( 'save' == $context ) {
  869. // Convert nbsp, ndash and mdash to hyphens
  870. $title = str_replace( array( '%c2%a0', '%e2%80%93', '%e2%80%94' ), '-', $title );
  871. // Strip these characters entirely
  872. $title = str_replace( array(
  873. // iexcl and iquest
  874. '%c2%a1', '%c2%bf',
  875. // angle quotes
  876. '%c2%ab', '%c2%bb', '%e2%80%b9', '%e2%80%ba',
  877. // curly quotes
  878. '%e2%80%98', '%e2%80%99', '%e2%80%9c', '%e2%80%9d',
  879. '%e2%80%9a', '%e2%80%9b', '%e2%80%9e', '%e2%80%9f',
  880. // copy, reg, deg, hellip and trade
  881. '%c2%a9', '%c2%ae', '%c2%b0', '%e2%80%a6', '%e2%84%a2',
  882. ), '', $title );
  883. // Convert times to x
  884. $title = str_replace( '%c3%97', 'x', $title );
  885. }
  886. $title = preg_replace('/[^%a-z0-9 _-]/', '', $title);
  887. $title = preg_replace('/\s+/', '-', $title);
  888. $title = preg_replace('|-+|', '-', $title);
  889. $title = trim($title, '-');
  890. return $title;
  891. }
  892. /**
  893. * Ensures a string is a valid SQL order by clause.
  894. *
  895. * Accepts one or more columns, with or without ASC/DESC, and also accepts
  896. * RAND().
  897. *
  898. * @since 2.5.1
  899. *
  900. * @param string $orderby Order by string to be checked.
  901. * @return string|bool Returns the order by clause if it is a match, false otherwise.
  902. */
  903. function sanitize_sql_orderby( $orderby ){
  904. preg_match('/^\s*([a-z0-9_]+(\s+(ASC|DESC))?(\s*,\s*|\s*$))+|^\s*RAND\(\s*\)\s*$/i', $orderby, $obmatches);
  905. if ( !$obmatches )
  906. return false;
  907. return $orderby;
  908. }
  909. /**
  910. * Santizes a html classname to ensure it only contains valid characters
  911. *
  912. * Strips the string down to A-Z,a-z,0-9,_,-. If this results in an empty
  913. * string then it will return the alternative value supplied.
  914. *
  915. * @todo Expand to support the full range of CDATA that a class attribute can contain.
  916. *
  917. * @since 2.8.0
  918. *
  919. * @param string $class The classname to be sanitized
  920. * @param string $fallback Optional. The value to return if the sanitization end's up as an empty string.
  921. * Defaults to an empty string.
  922. * @return string The sanitized value
  923. */
  924. function sanitize_html_class( $class, $fallback = '' ) {
  925. //Strip out any % encoded octets
  926. $sanitized = preg_replace( '|%[a-fA-F0-9][a-fA-F0-9]|', '', $class );
  927. //Limit to A-Z,a-z,0-9,_,-
  928. $sanitized = preg_replace( '/[^A-Za-z0-9_-]/', '', $sanitized );
  929. if ( '' == $sanitized )
  930. $sanitized = $fallback;
  931. return apply_filters( 'sanitize_html_class', $sanitized, $class, $fallback );
  932. }
  933. /**
  934. * Converts a number of characters from a string.
  935. *
  936. * Metadata tags <<title>> and <<category>> are removed, <<br>> and <<hr>> are
  937. * converted into correct XHTML and Unicode characters are converted to the
  938. * valid range.
  939. *
  940. * @since 0.71
  941. *
  942. * @param string $content String of characters to be converted.
  943. * @param string $deprecated Not used.
  944. * @return string Converted string.
  945. */
  946. function convert_chars($content, $deprecated = '') {
  947. if ( !empty( $deprecated ) )
  948. _deprecated_argument( __FUNCTION__, '0.71' );
  949. // Translation of invalid Unicode references range to valid range
  950. $wp_htmltranswinuni = array(
  951. '&#128;' => '&#8364;', // the Euro sign
  952. '&#129;' => '',
  953. '&#130;' => '&#8218;', // these are Windows CP1252 specific characters
  954. '&#131;' => '&#402;', // they would look weird on non-Windows browsers
  955. '&#132;' => '&#8222;',
  956. '&#133;' => '&#8230;',
  957. '&#134;' => '&#8224;',
  958. '&#135;' => '&#8225;',
  959. '&#136;' => '&#710;',
  960. '&#137;' => '&#8240;',
  961. '&#138;' => '&#352;',
  962. '&#139;' => '&#8249;',
  963. '&#140;' => '&#338;',
  964. '&#141;' => '',
  965. '&#142;' => '&#381;',
  966. '&#143;' => '',
  967. '&#144;' => '',
  968. '&#145;' => '&#8216;',
  969. '&#146;' => '&#8217;',
  970. '&#147;' => '&#8220;',
  971. '&#148;' => '&#8221;',
  972. '&#149;' => '&#8226;',
  973. '&#150;' => '&#8211;',
  974. '&#151;' => '&#8212;',
  975. '&#152;' => '&#732;',
  976. '&#153;' => '&#8482;',
  977. '&#154;' => '&#353;',
  978. '&#155;' => '&#8250;',
  979. '&#156;' => '&#339;',
  980. '&#157;' => '',
  981. '&#158;' => '&#382;',
  982. '&#159;' => '&#376;'
  983. );
  984. // Remove metadata tags
  985. $content = preg_replace('/<title>(.+?)<\/title>/','',$content);
  986. $content = preg_replace('/<category>(.+?)<\/category>/','',$content);
  987. // Converts lone & characters into &#38; (a.k.a. &amp;)
  988. $content = preg_replace('/&([^#])(?![a-z1-4]{1,8};)/i', '&#038;$1', $content);
  989. // Fix Word pasting
  990. $content = strtr($content, $wp_htmltranswinuni);
  991. // Just a little XHTML help
  992. $content = str_replace('<br>', '<br />', $content);
  993. $content = str_replace('<hr>', '<hr />', $content);
  994. return $content;
  995. }
  996. /**
  997. * Will only balance the tags if forced to and the option is set to balance tags.
  998. *
  999. * The option 'use_balanceTags' is used to determine whether the tags will be balanced.
  1000. *
  1001. * @since 0.71
  1002. *
  1003. * @param string $text Text to be balanced
  1004. * @param bool $force If true, forces balancing, ignoring the value of the option. Default false.
  1005. * @return string Balanced text
  1006. */
  1007. function balanceTags( $text, $force = false ) {
  1008. if ( !$force && get_option('use_balanceTags') == 0 )
  1009. return $text;
  1010. return force_balance_tags( $text );
  1011. }
  1012. /**
  1013. * Balances tags of string using a modified stack.
  1014. *
  1015. * @since 2.0.4
  1016. *
  1017. * @author Leonard Lin <leonard@acm.org>
  1018. * @license GPL
  1019. * @copyright November 4, 2001
  1020. * @version 1.1
  1021. * @todo Make better - change loop condition to $text in 1.2
  1022. * @internal Modified by Scott Reilly (coffee2code) 02 Aug 2004
  1023. * 1.1 Fixed handling of append/stack pop order of end text
  1024. * Added Cleaning Hooks
  1025. * 1.0 First Version
  1026. *
  1027. * @param string $text Text to be balanced.
  1028. * @return string Balanced text.
  1029. */
  1030. function force_balance_tags( $text ) {
  1031. $tagstack = array();
  1032. $stacksize = 0;
  1033. $tagqueue = '';
  1034. $newtext = '';
  1035. $single_tags = array( 'br', 'hr', 'img', 'input' ); // Known single-entity/self-closing tags
  1036. $nestable_tags = array( 'blockquote', 'div', 'object', 'q', 'span' ); // Tags that can be immediately nested within themselves
  1037. // WP bug fix for comments - in case you REALLY meant to type '< !--'
  1038. $text = str_replace('< !--', '< !--', $text);
  1039. // WP bug fix for LOVE <3 (and other situations with '<' before a number)
  1040. $text = preg_replace('#<([0-9]{1})#', '&lt;$1', $text);
  1041. while ( preg_match("/<(\/?[\w:]*)\s*([^>]*)>/", $text, $regex) ) {
  1042. $newtext .= $tagqueue;
  1043. $i = strpos($text, $regex[0]);
  1044. $l = strlen($regex[0]);
  1045. // clear the shifter
  1046. $tagqueue = '';
  1047. // Pop or Push
  1048. if ( isset($regex[1][0]) && '/' == $regex[1][0] ) { // End Tag
  1049. $tag = strtolower(substr($regex[1],1));
  1050. // if too many closing tags
  1051. if( $stacksize <= 0 ) {
  1052. $tag = '';
  1053. // or close to be safe $tag = '/' . $tag;
  1054. }
  1055. // if stacktop value = tag close value then pop
  1056. else if ( $tagstack[$stacksize - 1] == $tag ) { // found closing tag
  1057. $tag = '</' . $tag . '>'; // Close Tag
  1058. // Pop
  1059. array_pop( $tagstack );
  1060. $stacksize--;
  1061. } else { // closing tag not at top, search for it
  1062. for ( $j = $stacksize-1; $j >= 0; $j-- ) {
  1063. if ( $tagstack[$j] == $tag ) {
  1064. // add tag to tagqueue
  1065. for ( $k = $stacksize-1; $k >= $j; $k--) {
  1066. $tagqueue .= '</' . array_pop( $tagstack ) . '>';
  1067. $stacksize--;
  1068. }
  1069. break;
  1070. }
  1071. }
  1072. $tag = '';
  1073. }
  1074. } else { // Begin Tag
  1075. $tag = strtolower($regex[1]);
  1076. // Tag Cleaning
  1077. // If self-closing or '', don't do anything.
  1078. if ( substr($regex[2],-1) == '/' || $tag == '' ) {
  1079. // do nothing
  1080. }
  1081. // ElseIf it's a known single-entity tag but it doesn't close itself, do so
  1082. elseif ( in_array($tag, $single_tags) ) {
  1083. $regex[2] .= '/';
  1084. } else { // Push the tag onto the stack
  1085. // If the top of the stack is the same as the tag we want to push, close previous tag
  1086. if ( $stacksize > 0 && !in_array($tag, $nestable_tags) && $tagstack[$stacksize - 1] == $tag ) {
  1087. $tagqueue = '</' . array_pop ($tagstack) . '>';
  1088. $stacksize--;
  1089. }
  1090. $stacksize = array_push ($tagstack, $tag);
  1091. }
  1092. // Attributes
  1093. $attributes = $regex[2];
  1094. if( !empty($attributes) )
  1095. $attributes = ' '.$attributes;
  1096. $tag = '<' . $tag . $attributes . '>';
  1097. //If already queuing a close tag, then put this tag on, too
  1098. if ( !empty($tagqueue) ) {
  1099. $tagqueue .= $tag;
  1100. $tag = '';
  1101. }
  1102. }
  1103. $newtext .= substr($text, 0, $i) . $tag;
  1104. $text = substr($text, $i + $l);
  1105. }
  1106. // Clear Tag Queue
  1107. $newtext .= $tagqueue;
  1108. // Add Remaining text
  1109. $newtext .= $text;
  1110. // Empty Stack
  1111. while( $x = array_pop($tagstack) )
  1112. $newtext .= '</' . $x . '>'; // Add remaining tags to close
  1113. // WP fix for the bug with HTML comments
  1114. $newtext = str_replace("< !--","<!--",$newtext);
  1115. $newtext = str_replace("< !--","< !--",$newtext);
  1116. return $newtext;
  1117. }
  1118. /**
  1119. * Acts on text which is about to be edited.
  1120. *
  1121. * The $content is run through esc_textarea(), which uses htmlspecialchars()
  1122. * to convert special characters to HTML entities. If $richedit is set to true,
  1123. * it is simply a holder for the 'format_to_edit' filter.
  1124. *
  1125. * @since 0.71
  1126. *
  1127. * @param string $content The text about to be edited.
  1128. * @param bool $richedit Whether the $content should not pass through htmlspecialchars(). Default false (meaning it will be passed).
  1129. * @return string The text after the filter (and possibly htmlspecialchars()) has been run.
  1130. */
  1131. function format_to_edit( $content, $richedit = false ) {
  1132. $content = apply_filters( 'format_to_edit', $content );
  1133. if ( ! $richedit )
  1134. $content = esc_textarea( $content );
  1135. return $content;
  1136. }
  1137. /**
  1138. * Holder for the 'format_to_post' filter.
  1139. *
  1140. * @since 0.71
  1141. *
  1142. * @param string $content The text to pass through the filter.
  1143. * @return string Text returned from the 'format_to_post' filter.
  1144. */
  1145. function format_to_post($content) {
  1146. $content = apply_filters('format_to_post', $content);
  1147. return $content;
  1148. }
  1149. /**
  1150. * Add leading zeros when necessary.
  1151. *
  1152. * If you set the threshold to '4' and the number is '10', then you will get
  1153. * back '0010'. If you set the threshold to '4' and the number is '5000', then you
  1154. * will get back '5000'.
  1155. *
  1156. * Uses sprintf to append the amount of zeros based on the $threshold parameter
  1157. * and the size of the number. If the number is large enough, then no zeros will
  1158. * be appended.
  1159. *
  1160. * @since 0.71
  1161. *
  1162. * @param mixed $number Number to append zeros to if not greater than threshold.
  1163. * @param int $threshold Digit places number needs to be to not have zeros added.
  1164. * @return string Adds leading zeros to number if needed.
  1165. */
  1166. function zeroise($number, $threshold) {
  1167. return sprintf('%0'.$threshold.'s', $number);
  1168. }
  1169. /**
  1170. * Adds backslashes before letters and before a number at the start of a string.
  1171. *
  1172. * @since 0.71
  1173. *
  1174. * @param string $string Value to which backslashes will be added.
  1175. * @return string String with backslashes inserted.
  1176. */
  1177. function backslashit($string) {
  1178. $string = preg_replace('/^([0-9])/', '\\\\\\\\\1', $string);
  1179. $string = preg_replace('/([a-z])/i', '\\\\\1', $string);
  1180. return $string;
  1181. }
  1182. /**
  1183. * Appends a trailing slash.
  1184. *
  1185. * Will remove trailing slash if it exists already before adding a trailing
  1186. * slash. This prevents double slashing a string or path.
  1187. *
  1188. * The primary use of this is for paths and thus should be used for paths. It is
  1189. * not restricted to paths and offers no specific path support.
  1190. *
  1191. * @since 1.2.0
  1192. * @uses untrailingslashit() Unslashes string if it was slashed already.
  1193. *
  1194. * @param string $string What to add the trailing slash to.
  1195. * @return string String with trailing slash added.
  1196. */
  1197. function trailingslashit($string) {
  1198. return untrailingslashit($string) . '/';
  1199. }
  1200. /**
  1201. * Removes trailing slash if it exists.
  1202. *
  1203. * The primary use of this is for paths and thus should be used for paths. It is
  1204. * not restricted to paths and offers no specific path support.
  1205. *
  1206. * @since 2.2.0
  1207. *
  1208. * @param string $string What to remove the trailing slash from.
  1209. * @return string String without the trailing slash.
  1210. */
  1211. function untrailingslashit($string) {
  1212. return rtrim($string, '/');
  1213. }
  1214. /**
  1215. * Adds slashes to escape strings.
  1216. *
  1217. * Slashes will first be removed if magic_quotes_gpc is set, see {@link
  1218. * http://www.php.net/magic_quotes} for more details.
  1219. *
  1220. * @since 0.71
  1221. *
  1222. * @param string $gpc The string returned from HTTP request data.
  1223. * @return string Returns a string escaped with slashes.
  1224. */
  1225. function addslashes_gpc($gpc) {
  1226. if ( get_magic_quotes_gpc() )
  1227. $gpc = stripslashes($gpc);
  1228. return esc_sql($gpc);
  1229. }
  1230. /**
  1231. * Navigates through an array and removes slashes from the values.
  1232. *
  1233. * If an array is passed, the array_map() function causes a callback to pass the
  1234. * value back to the function. The slashes from this value will removed.
  1235. *
  1236. * @since 2.0.0
  1237. *
  1238. * @param mixed $value The value to be stripped.
  1239. * @return mixed Stripped value.
  1240. */
  1241. function stripslashes_deep($value) {
  1242. if ( is_array($value) ) {
  1243. $value = array_map('stripslashes_deep', $value);
  1244. } elseif ( is_object($value) ) {
  1245. $vars = get_object_vars( $value );
  1246. foreach ($vars as $key=>$data) {
  1247. $value->{$key} = stripslashes_deep( $data );
  1248. }
  1249. } elseif ( is_string( $value ) ) {
  1250. $value = stripslashes($value);
  1251. }
  1252. return $value;
  1253. }
  1254. /**
  1255. * Navigates through an array and encodes the values to be used in a URL.
  1256. *
  1257. *
  1258. * @since 2.2.0
  1259. *
  1260. * @param array|string $value The array or string to be encoded.
  1261. * @return array|string $value The encoded array (or string from the callback).
  1262. */
  1263. function urlencode_deep($value) {
  1264. $value = is_array($value) ? array_map('urlencode_deep', $value) : urlencode($value);
  1265. return $value;
  1266. }
  1267. /**
  1268. * Navigates through an array and raw encodes the values to be used in a URL.
  1269. *
  1270. * @since 3.4.0
  1271. *
  1272. * @param array|string $value The array or string to be encoded.
  1273. * @return array|string $value The encoded array (or string from the callback).
  1274. */
  1275. function rawurlencode_deep( $value ) {
  1276. return is_array( $value ) ? array_map( 'rawurlencode_deep', $value ) : rawurlencode( $value );
  1277. }
  1278. /**
  1279. * Converts email addresses characters to HTML entities to block spam bots.
  1280. *
  1281. * @since 0.71
  1282. *
  1283. * @param string $emailaddy Email address.
  1284. * @param int $mailto Optional. Range from 0 to 1. Used for encoding.
  1285. * @return string Converted email address.
  1286. */
  1287. function antispambot($emailaddy, $mailto=0) {
  1288. $emailNOSPAMaddy = '';
  1289. srand ((float) microtime() * 1000000);
  1290. for ($i = 0; $i < strlen($emailaddy); $i = $i + 1) {
  1291. $j = floor(rand(0, 1+$mailto));
  1292. if ($j==0) {
  1293. $emailNOSPAMaddy .= '&#'.ord(substr($emailaddy,$i,1)).';';
  1294. } elseif ($j==1) {
  1295. $emailNOSPAMaddy .= substr($emailaddy,$i,1);
  1296. } elseif ($j==2) {
  1297. $emailNOSPAMaddy .= '%'.zeroise(dechex(ord(substr($emailaddy, $i, 1))), 2);
  1298. }
  1299. }
  1300. $emailNOSPAMaddy = str_replace('@','&#64;',$emailNOSPAMaddy);
  1301. return $emailNOSPAMaddy;
  1302. }
  1303. /**
  1304. * Callback to convert URI match to HTML A element.
  1305. *
  1306. * This function was backported from 2.5.0 to 2.3.2. Regex callback for {@link
  1307. * make_clickable()}.
  1308. *
  1309. * @since 2.3.2
  1310. * @access private
  1311. *
  1312. * @param array $matches Single Regex Match.
  1313. * @return string HTML A element with URI address.
  1314. */
  1315. function _make_url_clickable_cb($matches) {
  1316. $url = $matches[2];
  1317. if ( ')' == $matches[3] && strpos( $url, '(' ) ) {
  1318. // If the trailing character is a closing parethesis, and the URL has an opening parenthesis in it, add the closing parenthesis to the URL.
  1319. // Then we can let the parenthesis balancer do its thing below.
  1320. $url .= $matches[3];
  1321. $suffix = '';
  1322. } else {
  1323. $suffix = $matches[3];
  1324. }
  1325. // Include parentheses in the URL only if paired
  1326. while ( substr_count( $url, '(' ) < substr_count( $url, ')' ) ) {
  1327. $suffix = strrchr( $url, ')' ) . $suffix;
  1328. $url = substr( $url, 0, strrpos( $url, ')' ) );
  1329. }
  1330. $url = esc_url($url);
  1331. if ( empty($url) )
  1332. return $matches[0];
  1333. return $matches[1] . "<a href=\"$url\" rel=\"nofollow\">$url</a>" . $suffix;
  1334. }
  1335. /**
  1336. * Callback to convert URL match to HTML A element.
  1337. *
  1338. * This function was backported from 2.5.0 to 2.3.2. Regex callback for {@link
  1339. * make_clickable()}.
  1340. *
  1341. * @since 2.3.2
  1342. * @access private
  1343. *
  1344. * @param array $matches Single Regex Match.
  1345. * @return string HTML A element with URL address.
  1346. */
  1347. function _make_web_ftp_clickable_cb($matches) {
  1348. $ret = '';
  1349. $dest = $matches[2];
  1350. $dest = 'http://' . $dest;
  1351. $dest = esc_url($dest);
  1352. if ( empty($dest) )
  1353. return $matches[0];
  1354. // removed trailing [.,;:)] from URL
  1355. if ( in_array( substr($dest, -1), array('.', ',', ';', ':', ')') ) === true ) {
  1356. $ret = substr($dest, -1);
  1357. $dest = substr($dest, 0, strlen($dest)-1);
  1358. }
  1359. return $matches[1] . "<a href=\"$dest\" rel=\"nofollow\">$dest</a>$ret";
  1360. }
  1361. /**
  1362. * Callback to convert email address match to HTML A element.
  1363. *
  1364. * This function was backported from 2.5.0 to 2.3.2. Regex callback for {@link
  1365. * make_clickable()}.
  1366. *
  1367. * @since 2.3.2
  1368. * @access private
  1369. *
  1370. * @param array $matches Single Regex Match.
  1371. * @return string HTML A element with email address.
  1372. */
  1373. function _make_email_clickable_cb($matches) {
  1374. $email = $matches[2] . '@' . $matches[3];
  1375. return $matches[1] . "<a href=\"mailto:$email\">$email</a>";
  1376. }
  1377. /**
  1378. * Convert plaintext URI to HTML links.
  1379. *
  1380. * Converts URI, www and ftp, and email addresses. Finishes by fixing links
  1381. * within links.
  1382. *
  1383. * @since 0.71
  1384. *
  1385. * @param string $text Content to convert URIs.
  1386. * @return string Content with converted URIs.
  1387. */
  1388. function make_clickable( $text ) {
  1389. $r = '';
  1390. $textarr = preg_split( '/(<[^<>]+>)/', $text, -1, PREG_SPLIT_DELIM_CAPTURE ); // split out HTML tags
  1391. foreach ( $textarr as $piece ) {
  1392. if ( empty( $piece ) || ( $piece[0] == '<' && ! preg_match('|^<\s*[\w]{1,20}+://|', $piece) ) ) {
  1393. $r .= $piece;
  1394. continue;
  1395. }
  1396. // Long strings might contain expensive edge cases ...
  1397. if ( 10000 < strlen( $piece ) ) {
  1398. // ... break it up
  1399. foreach ( _split_str_by_whitespace( $piece, 2100 ) as $chunk ) { // 2100: Extra room for scheme and leading and trailing paretheses
  1400. if ( 2101 < strlen( $chunk ) ) {
  1401. $r .= $chunk; // Too big, no whitespace: bail.
  1402. } else {
  1403. $r .= make_clickable( $chunk );
  1404. }
  1405. }
  1406. } else {
  1407. $ret = " $piece "; // Pad with whitespace to simplify the regexes
  1408. $url_clickable = '~
  1409. ([\\s(<.,;:!?]) # 1: Leading whitespace, or punctuation
  1410. ( # 2: URL
  1411. [\\w]{1,20}+:// # Scheme and hier-part prefix
  1412. (?=\S{1,2000}\s) # Limit to URLs less than about 2000 characters long
  1413. [\\w\\x80-\\xff#%\\~/@\\[\\]*(+=&$-]*+ # Non-punctuation URL character
  1414. (?: # Unroll the Loop: Only allow puctuation URL character if followed by a non-punctuation URL character
  1415. [\'.,;:!?)] # Punctuation URL character
  1416. [\\w\\x80-\\xff#%\\~/@\\[\\]*(+=&$-]++ # Non-punctuation URL character
  1417. )*
  1418. )
  1419. (\)?) # 3: Trailing closing parenthesis (for parethesis balancing post processing)
  1420. ~xS'; // The regex is a non-anchored pattern and does not have a single fixed starting character.
  1421. // Tell PCRE to spend more time optimizing since, when used on a page load, it will probably be used several times.
  1422. $ret = preg_replace_callback( $url_clickable, '_make_url_clickable_cb', $ret );
  1423. $ret = preg_replace_callback( '#([\s>])((www|ftp)\.[\w\\x80-\\xff\#$%&~/.\-;:=,?@\[\]+]+)#is', '_make_web_ftp_clickable_cb', $ret );
  1424. $ret = preg_replace_callback( '#([\s>])([.0-9a-z_+-]+)@(([0-9a-z-]+\.)+[0-9a-z]{2,})#i', '_make_email_clickable_cb', $ret );
  1425. $ret = substr( $ret, 1, -1 ); // Remove our whitespace padding.
  1426. $r .= $ret;
  1427. }
  1428. }
  1429. // Cleanup of accidental links within links
  1430. $r = preg_replace( '#(<a( [^>]+?>|>))<a [^>]+?>([^>]+?)</a></a>#i', "$1$3</a>", $r );
  1431. return $r;
  1432. }
  1433. /**
  1434. * Breaks a string into chunks by splitting at whitespace characters.
  1435. * The length of each returned chunk is as close to the specified length goal as possible,
  1436. * with the caveat that each chunk includes its trailing delimiter.
  1437. * Chunks longer than the goal are guaranteed to not have any inner whitespace.
  1438. *
  1439. * Joining the returned chunks with empty delimiters reconstructs the input string losslessly.
  1440. *
  1441. * Input string must have no null characters (or eventual transformations on output chunks must not care about null characters)
  1442. *
  1443. * <code>
  1444. * _split_str_by_whitespace( "1234 67890 1234 67890a cd 1234 890 123456789 1234567890a 45678 1 3 5 7 90 ", 10 ) ==
  1445. * array (
  1446. * 0 => '1234 67890 ', // 11 characters: Perfect split
  1447. * 1 => '1234 ', // 5 characters: '1234 67890a' was too long
  1448. * 2 => '67890a cd ', // 10 characters: '67890a cd 1234' was too long
  1449. * 3 => '1234 890 ', // 11 characters: Perfect split
  1450. * 4 => '123456789 ', // 10 characters: '123456789 1234567890a' was too long
  1451. * 5 => '1234567890a ', // 12 characters: Too long, but no inner whitespace on which to split
  1452. * 6 => ' 45678 ', // 11 characters: Perfect split
  1453. * 7 => '1 3 5 7 9', // 9 characters: End of $string
  1454. * );
  1455. * </code>
  1456. *
  1457. * @since 3.4.0
  1458. * @access private
  1459. *
  1460. * @param string $string The string to split.
  1461. * @param int $goal The desired chunk length.
  1462. * @return array Numeric array of chunks.
  1463. */
  1464. function _split_str_by_whitespace( $string, $goal ) {
  1465. $chunks = array();
  1466. $string_nullspace = strtr( $string, "\r\n\t\v\f ", "\000\000\000\000\000\000" );
  1467. while ( $goal < strlen( $string_nullspace ) ) {
  1468. $pos = strrpos( substr( $string_nullspace, 0, $goal + 1 ), "\000" );
  1469. if ( false === $pos ) {
  1470. $pos = strpos( $string_nullspace, "\000", $goal + 1 );
  1471. if ( false === $pos ) {
  1472. break;
  1473. }
  1474. }
  1475. $chunks[] = substr( $string, 0, $pos + 1 );
  1476. $string = substr( $string, $pos + 1 );
  1477. $string_nullspace = substr( $string_nullspace, $pos + 1 );
  1478. }
  1479. if ( $string ) {
  1480. $chunks[] = $string;
  1481. }
  1482. return $chunks;
  1483. }
  1484. /**
  1485. * Adds rel nofollow string to all HTML A elements in content.
  1486. *
  1487. * @since 1.5.0
  1488. *
  1489. * @param string $text Content that may contain HTML A elements.
  1490. * @return string Converted content.
  1491. */
  1492. function wp_rel_nofollow( $text ) {
  1493. // This is a pre save filter, so text is already escaped.
  1494. $text = stripslashes($text);
  1495. $text = preg_replace_callback('|<a (.+?)>|i', 'wp_rel_nofollow_callback', $text);
  1496. $text = esc_sql($text);
  1497. return $text;
  1498. }
  1499. /**
  1500. * Callback to used to add rel=nofollow string to HTML A element.
  1501. *
  1502. * Will remove already existing rel="nofollow" and rel='nofollow' from the
  1503. * string to prevent from invalidating (X)HTML.
  1504. *
  1505. * @since 2.3.0
  1506. *
  1507. * @param array $matches Single Match
  1508. * @return string HTML A Element with rel nofollow.
  1509. */
  1510. function wp_rel_nofollow_callback( $matches ) {
  1511. $text = $matches[1];
  1512. $text = str_replace(array(' rel="nofollow"', " rel='nofollow'"), '', $text);
  1513. return "<a $text rel=\"nofollow\">";
  1514. }
  1515. /**
  1516. * Convert one smiley code to the icon graphic file equivalent.
  1517. *
  1518. * Looks up one smiley code in the $wpsmiliestrans global array and returns an
  1519. * <img> string for that smiley.
  1520. *
  1521. * @global array $wpsmiliestrans
  1522. * @since 2.8.0
  1523. *
  1524. * @param string $smiley Smiley code to convert to image.
  1525. * @return string Image string for smiley.
  1526. */
  1527. function translate_smiley($smiley) {
  1528. global $wpsmiliestrans;
  1529. if (count($smiley) == 0) {
  1530. return '';
  1531. }
  1532. $smiley = trim(reset($smiley));
  1533. $img = $wpsmiliestrans[$smiley];
  1534. $smiley_masked = esc_attr($smiley);
  1535. $srcurl = apply_filters('smilies_src', includes_url("images/smilies/$img"), $img, site_url());
  1536. return " <img src='$srcurl' alt='$smiley_masked' class='wp-smiley' /> ";
  1537. }
  1538. /**
  1539. * Convert text equivalent of smilies to images.
  1540. *
  1541. * Will only convert smilies if the option 'use_smilies' is true and the global
  1542. * used in the function isn't empty.
  1543. *
  1544. * @since 0.71
  1545. * @uses $wp_smiliessearch
  1546. *
  1547. * @param string $text Content to convert smilies from text.
  1548. * @return string Converted content with text smilies replaced with images.
  1549. */
  1550. function convert_smilies($text) {
  1551. global $wp_smiliessearch;
  1552. $output = '';
  1553. if ( get_option('use_smilies') && !empty($wp_smiliessearch) ) {
  1554. // HTML loop taken from texturize function, could possible be consolidated
  1555. $textarr = preg_split("/(<.*>)/U", $text, -1, PREG_SPLIT_DELIM_CAPTURE); // capture the tags as well as in between
  1556. $stop = count($textarr);// loop stuff
  1557. for ($i = 0; $i < $stop; $i++) {
  1558. $content = $textarr[$i];
  1559. if ((strlen($content) > 0) && ('<' != $content[0])) { // If it's not a tag
  1560. $content = preg_replace_callback($wp_smiliessearch, 'translate_smiley', $content);
  1561. }
  1562. $output .= $content;
  1563. }
  1564. } else {
  1565. // return default text.
  1566. $output = $text;
  1567. }
  1568. return $output;
  1569. }
  1570. /**
  1571. * Verifies that an email is valid.
  1572. *
  1573. * Does not grok i18n domains. Not RFC compliant.
  1574. *
  1575. * @since 0.71
  1576. *
  1577. * @param string $email Email address to verify.
  1578. * @param boolean $deprecated Deprecated.
  1579. * @return string|bool Either false or the valid email address.
  1580. */
  1581. function is_email( $email, $deprecated = false ) {
  1582. if ( ! empty( $deprecated ) )
  1583. _deprecated_argument( __FUNCTION__, '3.0' );
  1584. // Test for the minimum length the email can be
  1585. if ( strlen( $email ) < 3 ) {
  1586. return apply_filters( 'is_email', false, $email, 'email_too_short' );
  1587. }
  1588. // Test for an @ character after the first position
  1589. if ( strpos( $email, '@', 1 ) === false ) {
  1590. return apply_filters( 'is_email', false, $email, 'email_no_at' );
  1591. }
  1592. // Split out the local and domain parts
  1593. list( $local, $domain ) = explode( '@', $email, 2 );
  1594. // LOCAL PART
  1595. // Test for invalid characters
  1596. if ( !preg_match( '/^[a-zA-Z0-9!#$%&\'*+\/=?^_`{|}~\.-]+$/', $local ) ) {
  1597. return apply_filters( 'is_email', false, $email, 'local_invalid_chars' );
  1598. }
  1599. // DOMAIN PART
  1600. // Test for sequences of periods
  1601. if ( preg_match( '/\.{2,}/', $domain ) ) {
  1602. return apply_filters( 'is_email', false, $email, 'domain_period_sequence' );
  1603. }
  1604. // Test for leading and trailing periods and whitespace
  1605. if ( trim( $domain, " \t\n\r\0\x0B." ) !== $domain ) {
  1606. return apply_filters( 'is_email', false, $email, 'domain_period_limits' );
  1607. }
  1608. // Split the domain into subs
  1609. $subs = explode( '.', $domain );
  1610. // Assume the domain will have at least two subs
  1611. if ( 2 > count( $subs ) ) {
  1612. return apply_filters( 'is_email', false, $email, 'domain_no_periods' );
  1613. }
  1614. // Loop through each sub
  1615. foreach ( $subs as $sub ) {
  1616. // Test for leading and trailing hyphens and whitespace
  1617. if ( trim( $sub, " \t\n\r\0\x0B-" ) !== $sub ) {
  1618. return apply_filters( 'is_email', false, $email, 'sub_hyphen_limits' );
  1619. }
  1620. // Test for invalid characters
  1621. if ( !preg_match('/^[a-z0-9-]+$/i', $sub ) ) {
  1622. return apply_filters( 'is_email', false, $email, 'sub_invalid_chars' );
  1623. }
  1624. }
  1625. // Congratulations your email made it!
  1626. return apply_filters( 'is_email', $email, $email, null );
  1627. }
  1628. /**
  1629. * Convert to ASCII from email subjects.
  1630. *
  1631. * @since 1.2.0
  1632. *
  1633. * @param string $string Subject line
  1634. * @return string Converted string to ASCII
  1635. */
  1636. function wp_iso_descrambler($string) {
  1637. /* this may only work with iso-8859-1, I'm afraid */
  1638. if (!preg_match('#\=\?(.+)\?Q\?(.+)\?\=#i', $string, $matches)) {
  1639. return $string;
  1640. } else {
  1641. $subject = str_replace('_', ' ', $matches[2]);
  1642. $subject = preg_replace_callback('#\=([0-9a-f]{2})#i', '_wp_iso_convert', $subject);
  1643. return $subject;
  1644. }
  1645. }
  1646. /**
  1647. * Helper function to convert hex encoded chars to ASCII
  1648. *
  1649. * @since 3.1.0
  1650. * @access private
  1651. * @param array $match The preg_replace_callback matches array
  1652. * @return array Converted chars
  1653. */
  1654. function _wp_iso_convert( $match ) {
  1655. return chr( hexdec( strtolower( $match[1] ) ) );
  1656. }
  1657. /**
  1658. * Returns a date in the GMT equivalent.
  1659. *
  1660. * Requires and returns a date in the Y-m-d H:i:s format. Simply subtracts the
  1661. * value of the 'gmt_offset' option. Return format can be overridden using the
  1662. * $format parameter. The DateTime and DateTimeZone classes are used to respect
  1663. * time zone differences in DST.
  1664. *
  1665. * @since 1.2.0
  1666. *
  1667. * @uses get_option() to retrieve the the value of 'gmt_offset'.
  1668. * @param string $string The date to be converted.
  1669. * @param string $format The format string for the returned date (default is Y-m-d H:i:s)
  1670. * @return string GMT version of the date provided.
  1671. */
  1672. function get_gmt_from_date($string, $format = 'Y-m-d H:i:s') {
  1673. preg_match('#([0-9]{1,4})-([0-9]{1,2})-([0-9]{1,2}) ([0-9]{1,2}):([0-9]{1,2}):([0-9]{1,2})#', $string, $matches);
  1674. $tz = get_option('timezone_string');
  1675. if ( $tz ) {
  1676. date_default_timezone_set( $tz );
  1677. $datetime = new DateTime( $string );
  1678. $datetime->setTimezone( new DateTimeZone('UTC') );
  1679. $offset = $datetime->getOffset();
  1680. $datetime->modify( '+' . $offset / 3600 . ' hours');
  1681. $string_gmt = gmdate($format, $datetime->format('U'));
  1682. date_default_timezone_set('UTC');
  1683. } else {
  1684. $string_time = gmmktime($matches[4], $matches[5], $matches[6], $matches[2], $matches[3], $matches[1]);
  1685. $string_gmt = gmdate($format, $string_time - get_option('gmt_offset') * 3600);
  1686. }
  1687. return $string_gmt;
  1688. }
  1689. /**
  1690. * Converts a GMT date into the correct format for the blog.
  1691. *
  1692. * Requires and returns in the Y-m-d H:i:s format. Simply adds the value of
  1693. * gmt_offset.Return format can be overridden using the $format parameter
  1694. *
  1695. * @since 1.2.0
  1696. *
  1697. * @param string $string The date to be converted.
  1698. * @param string $format The format string for the returned date (default is Y-m-d H:i:s)
  1699. * @return string Formatted date relative to the GMT offset.
  1700. */
  1701. function get_date_from_gmt($string, $format = 'Y-m-d H:i:s') {
  1702. preg_match('#([0-9]{1,4})-([0-9]{1,2})-([0-9]{1,2}) ([0-9]{1,2}):([0-9]{1,2}):([0-9]{1,2})#', $string, $matches);
  1703. $string_time = gmmktime($matches[4], $matches[5], $matches[6], $matches[2], $matches[3], $matches[1]);
  1704. $string_localtime = gmdate($format, $string_time + get_option('gmt_offset')*3600);
  1705. return $string_localtime;
  1706. }
  1707. /**
  1708. * Computes an offset in seconds from an iso8601 timezone.
  1709. *
  1710. * @since 1.5.0
  1711. *
  1712. * @param string $timezone Either 'Z' for 0 offset or 'Â?hhmm'.
  1713. * @return int|float The offset in seconds.
  1714. */
  1715. function iso8601_timezone_to_offset($timezone) {
  1716. // $timezone is either 'Z' or '[+|-]hhmm'
  1717. if ($timezone == 'Z') {
  1718. $offset = 0;
  1719. } else {
  1720. $sign = (substr($timezone, 0, 1) == '+') ? 1 : -1;
  1721. $hours = intval(substr($timezone, 1, 2));
  1722. $minutes = intval(substr($timezone, 3, 4)) / 60;
  1723. $offset = $sign * 3600 * ($hours + $minutes);
  1724. }
  1725. return $offset;
  1726. }
  1727. /**
  1728. * Converts an iso8601 date to MySQL DateTime format used by post_date[_gmt].
  1729. *
  1730. * @since 1.5.0
  1731. *
  1732. * @param string $date_string Date and time in ISO 8601 format {@link http://en.wikipedia.org/wiki/ISO_8601}.
  1733. * @param string $timezone Optional. If set to GMT returns the time minus gmt_offset. Default is 'user'.
  1734. * @return string The date and time in MySQL DateTime format - Y-m-d H:i:s.
  1735. */
  1736. function iso8601_to_datetime($date_string, $timezone = 'user') {
  1737. $timezone = strtolower($timezone);
  1738. if ($timezone == 'gmt') {
  1739. preg_match('#([0-9]{4})([0-9]{2})([0-9]{2})T([0-9]{2}):([0-9]{2}):([0-9]{2})(Z|[\+|\-][0-9]{2,4}){0,1}#', $date_string, $date_bits);
  1740. if (!empty($date_bits[7])) { // we have a timezone, so let's compute an offset
  1741. $offset = iso8601_timezone_to_offset($date_bits[7]);
  1742. } else { // we don't have a timezone, so we assume user local timezone (not server's!)
  1743. $offset = 3600 * get_option('gmt_offset');
  1744. }
  1745. $timestamp = gmmktime($date_bits[4], $date_bits[5], $date_bits[6], $date_bits[2], $date_bits[3], $date_bits[1]);
  1746. $timestamp -= $offset;
  1747. return gmdate('Y-m-d H:i:s', $timestamp);
  1748. } else if ($timezone == 'user') {
  1749. return preg_replace('#([0-9]{4})([0-9]{2})([0-9]{2})T([0-9]{2}):([0-9]{2}):([0-9]{2})(Z|[\+|\-][0-9]{2,4}){0,1}#', '$1-$2-$3 $4:$5:$6', $date_string);
  1750. }
  1751. }
  1752. /**
  1753. * Adds a element attributes to open links in new windows.
  1754. *
  1755. * Comment text in popup windows should be filtered through this. Right now it's
  1756. * a moderately dumb function, ideally it would detect whether a target or rel
  1757. * attribute was already there and adjust its actions accordingly.
  1758. *
  1759. * @since 0.71
  1760. *
  1761. * @param string $text Content to replace links to open in a new window.
  1762. * @return string Content that has filtered links.
  1763. */
  1764. function popuplinks($text) {
  1765. $text = preg_replace('/<a (.+?)>/i', "<a $1 target='_blank' rel='external'>", $text);
  1766. return $text;
  1767. }
  1768. /**
  1769. * Strips out all characters that are not allowable in an email.
  1770. *
  1771. * @since 1.5.0
  1772. *
  1773. * @param string $email Email address to filter.
  1774. * @return string Filtered email address.
  1775. */
  1776. function sanitize_email( $email ) {
  1777. // Test for the minimum length the email can be
  1778. if ( strlen( $email ) < 3 ) {
  1779. return apply_filters( 'sanitize_email', '', $email, 'email_too_short' );
  1780. }
  1781. // Test for an @ character after the first position
  1782. if ( strpos( $email, '@', 1 ) === false ) {
  1783. return apply_filters( 'sanitize_email', '', $email, 'email_no_at' );
  1784. }
  1785. // Split out the local and domain parts
  1786. list( $local, $domain ) = explode( '@', $email, 2 );
  1787. // LOCAL PART
  1788. // Test for invalid characters
  1789. $local = preg_replace( '/[^a-zA-Z0-9!#$%&\'*+\/=?^_`{|}~\.-]/', '', $local );
  1790. if ( '' === $local ) {
  1791. return apply_filters( 'sanitize_email', '', $email, 'local_invalid_chars' );
  1792. }
  1793. // DOMAIN PART
  1794. // Test for sequences of periods
  1795. $domain = preg_replace( '/\.{2,}/', '', $domain );
  1796. if ( '' === $domain ) {
  1797. return apply_filters( 'sanitize_email', '', $email, 'domain_period_sequence' );
  1798. }
  1799. // Test for leading and trailing periods and whitespace
  1800. $domain = trim( $domain, " \t\n\r\0\x0B." );
  1801. if ( '' === $domain ) {
  1802. return apply_filters( 'sanitize_email', '', $email, 'domain_period_limits' );
  1803. }
  1804. // Split the domain into subs
  1805. $subs = explode( '.', $domain );
  1806. // Assume the domain will have at least two subs
  1807. if ( 2 > count( $subs ) ) {
  1808. return apply_filters( 'sanitize_email', '', $email, 'domain_no_periods' );
  1809. }
  1810. // Create an array that will contain valid subs
  1811. $new_subs = array();
  1812. // Loop through each sub
  1813. foreach ( $subs as $sub ) {
  1814. // Test for leading and trailing hyphens
  1815. $sub = trim( $sub, " \t\n\r\0\x0B-" );
  1816. // Test for invalid characters
  1817. $sub = preg_replace( '/[^a-z0-9-]+/i', '', $sub );
  1818. // If there's anything left, add it to the valid subs
  1819. if ( '' !== $sub ) {
  1820. $new_subs[] = $sub;
  1821. }
  1822. }
  1823. // If there aren't 2 or more valid subs
  1824. if ( 2 > count( $new_subs ) ) {
  1825. return apply_filters( 'sanitize_email', '', $email, 'domain_no_valid_subs' );
  1826. }
  1827. // Join valid subs into the new domain
  1828. $domain = join( '.', $new_subs );
  1829. // Put the email back together
  1830. $email = $local . '@' . $domain;
  1831. // Congratulations your email made it!
  1832. return apply_filters( 'sanitize_email', $email, $email, null );
  1833. }
  1834. /**
  1835. * Determines the difference between two timestamps.
  1836. *
  1837. * The difference is returned in a human readable format such as "1 hour",
  1838. * "5 mins", "2 days".
  1839. *
  1840. * @since 1.5.0
  1841. *
  1842. * @param int $from Unix timestamp from which the difference begins.
  1843. * @param int $to Optional. Unix timestamp to end the time difference. Default becomes time() if not set.
  1844. * @return string Human readable time difference.
  1845. */
  1846. function human_time_diff( $from, $to = '' ) {
  1847. if ( empty($to) )
  1848. $to = time();
  1849. $diff = (int) abs($to - $from);
  1850. if ($diff <= 3600) {
  1851. $mins = round($diff / 60);
  1852. if ($mins <= 1) {
  1853. $mins = 1;
  1854. }
  1855. /* translators: min=minute */
  1856. $since = sprintf(_n('%s min', '%s mins', $mins), $mins);
  1857. } else if (($diff <= 86400) && ($diff > 3600)) {
  1858. $hours = round($diff / 3600);
  1859. if ($hours <= 1) {
  1860. $hours = 1;
  1861. }
  1862. $since = sprintf(_n('%s hour', '%s hours', $hours), $hours);
  1863. } elseif ($diff >= 86400) {
  1864. $days = round($diff / 86400);
  1865. if ($days <= 1) {
  1866. $days = 1;
  1867. }
  1868. $since = sprintf(_n('%s day', '%s days', $days), $days);
  1869. }
  1870. return $since;
  1871. }
  1872. /**
  1873. * Generates an excerpt from the content, if needed.
  1874. *
  1875. * The excerpt word amount will be 55 words and if the amount is greater than
  1876. * that, then the string ' [...]' will be appended to the excerpt. If the string
  1877. * is less than 55 words, then the content will be returned as is.
  1878. *
  1879. * The 55 word limit can be modified by plugins/themes using the excerpt_length filter
  1880. * The ' [...]' string can be modified by plugins/themes using the excerpt_more filter
  1881. *
  1882. * @since 1.5.0
  1883. *
  1884. * @param string $text Optional. The excerpt. If set to empty, an excerpt is generated.
  1885. * @return string The excerpt.
  1886. */
  1887. function wp_trim_excerpt($text = '') {
  1888. $raw_excerpt = $text;
  1889. if ( '' == $text ) {
  1890. $text = get_the_content('');
  1891. $text = strip_shortcodes( $text );
  1892. $text = apply_filters('the_content', $text);
  1893. $text = str_replace(']]>', ']]&gt;', $text);
  1894. $excerpt_length = apply_filters('excerpt_length', 55);
  1895. $excerpt_more = apply_filters('excerpt_more', ' ' . '[...]');
  1896. $text = wp_trim_words( $text, $excerpt_length, $excerpt_more );
  1897. }
  1898. return apply_filters('wp_trim_excerpt', $text, $raw_excerpt);
  1899. }
  1900. /**
  1901. * Trims text to a certain number of words.
  1902. *
  1903. * This function is localized. For languages that count 'words' by the individual
  1904. * character (such as East Asian languages), the $num_words argument will apply
  1905. * to the number of individual characters.
  1906. *
  1907. * @since 3.3.0
  1908. *
  1909. * @param string $text Text to trim.
  1910. * @param int $num_words Number of words. Default 55.
  1911. * @param string $more What to append if $text needs to be trimmed. Default '&hellip;'.
  1912. * @return string Trimmed text.
  1913. */
  1914. function wp_trim_words( $text, $num_words = 55, $more = null ) {
  1915. if ( null === $more )
  1916. $more = __( '&hellip;' );
  1917. $original_text = $text;
  1918. $text = wp_strip_all_tags( $text );
  1919. /* translators: If your word count is based on single characters (East Asian characters),
  1920. enter 'characters'. Otherwise, enter 'words'. Do not translate into your own language. */
  1921. if ( 'characters' == _x( 'words', 'word count: words or characters?' ) && preg_match( '/^utf\-?8$/i', get_option( 'blog_charset' ) ) ) {
  1922. $text = trim( preg_replace( "/[\n\r\t ]+/", ' ', $text ), ' ' );
  1923. preg_match_all( '/./u', $text, $words_array );
  1924. $words_array = array_slice( $words_array[0], 0, $num_words + 1 );
  1925. $sep = '';
  1926. } else {
  1927. $words_array = preg_split( "/[\n\r\t ]+/", $text, $num_words + 1, PREG_SPLIT_NO_EMPTY );
  1928. $sep = ' ';
  1929. }
  1930. if ( count( $words_array ) > $num_words ) {
  1931. array_pop( $words_array );
  1932. $text = implode( $sep, $words_array );
  1933. $text = $text . $more;
  1934. } else {
  1935. $text = implode( $sep, $words_array );
  1936. }
  1937. return apply_filters( 'wp_trim_words', $text, $num_words, $more, $original_text );
  1938. }
  1939. /**
  1940. * Converts named entities into numbered entities.
  1941. *
  1942. * @since 1.5.1
  1943. *
  1944. * @param string $text The text within which entities will be converted.
  1945. * @return string Text with converted entities.
  1946. */
  1947. function ent2ncr($text) {
  1948. // Allow a plugin to short-circuit and override the mappings.
  1949. $filtered = apply_filters( 'pre_ent2ncr', null, $text );
  1950. if( null !== $filtered )
  1951. return $filtered;
  1952. $to_ncr = array(
  1953. '&quot;' => '&#34;',
  1954. '&amp;' => '&#38;',
  1955. '&frasl;' => '&#47;',
  1956. '&lt;' => '&#60;',
  1957. '&gt;' => '&#62;',
  1958. '|' => '&#124;',
  1959. '&nbsp;' => '&#160;',
  1960. '&iexcl;' => '&#161;',
  1961. '&cent;' => '&#162;',
  1962. '&pound;' => '&#163;',
  1963. '&curren;' => '&#164;',
  1964. '&yen;' => '&#165;',
  1965. '&brvbar;' => '&#166;',
  1966. '&brkbar;' => '&#166;',
  1967. '&sect;' => '&#167;',
  1968. '&uml;' => '&#168;',
  1969. '&die;' => '&#168;',
  1970. '&copy;' => '&#169;',
  1971. '&ordf;' => '&#170;',
  1972. '&laquo;' => '&#171;',
  1973. '&not;' => '&#172;',
  1974. '&shy;' => '&#173;',
  1975. '&reg;' => '&#174;',
  1976. '&macr;' => '&#175;',
  1977. '&hibar;' => '&#175;',
  1978. '&deg;' => '&#176;',
  1979. '&plusmn;' => '&#177;',
  1980. '&sup2;' => '&#178;',
  1981. '&sup3;' => '&#179;',
  1982. '&acute;' => '&#180;',
  1983. '&micro;' => '&#181;',
  1984. '&para;' => '&#182;',
  1985. '&middot;' => '&#183;',
  1986. '&cedil;' => '&#184;',
  1987. '&sup1;' => '&#185;',
  1988. '&ordm;' => '&#186;',
  1989. '&raquo;' => '&#187;',
  1990. '&frac14;' => '&#188;',
  1991. '&frac12;' => '&#189;',
  1992. '&frac34;' => '&#190;',
  1993. '&iquest;' => '&#191;',
  1994. '&Agrave;' => '&#192;',
  1995. '&Aacute;' => '&#193;',
  1996. '&Acirc;' => '&#194;',
  1997. '&Atilde;' => '&#195;',
  1998. '&Auml;' => '&#196;',
  1999. '&Aring;' => '&#197;',
  2000. '&AElig;' => '&#198;',
  2001. '&Ccedil;' => '&#199;',
  2002. '&Egrave;' => '&#200;',
  2003. '&Eacute;' => '&#201;',
  2004. '&Ecirc;' => '&#202;',
  2005. '&Euml;' => '&#203;',
  2006. '&Igrave;' => '&#204;',
  2007. '&Iacute;' => '&#205;',
  2008. '&Icirc;' => '&#206;',
  2009. '&Iuml;' => '&#207;',
  2010. '&ETH;' => '&#208;',
  2011. '&Ntilde;' => '&#209;',
  2012. '&Ograve;' => '&#210;',
  2013. '&Oacute;' => '&#211;',
  2014. '&Ocirc;' => '&#212;',
  2015. '&Otilde;' => '&#213;',
  2016. '&Ouml;' => '&#214;',
  2017. '&times;' => '&#215;',
  2018. '&Oslash;' => '&#216;',
  2019. '&Ugrave;' => '&#217;',
  2020. '&Uacute;' => '&#218;',
  2021. '&Ucirc;' => '&#219;',
  2022. '&Uuml;' => '&#220;',
  2023. '&Yacute;' => '&#221;',
  2024. '&THORN;' => '&#222;',
  2025. '&szlig;' => '&#223;',
  2026. '&agrave;' => '&#224;',
  2027. '&aacute;' => '&#225;',
  2028. '&acirc;' => '&#226;',
  2029. '&atilde;' => '&#227;',
  2030. '&auml;' => '&#228;',
  2031. '&aring;' => '&#229;',
  2032. '&aelig;' => '&#230;',
  2033. '&ccedil;' => '&#231;',
  2034. '&egrave;' => '&#232;',
  2035. '&eacute;' => '&#233;',
  2036. '&ecirc;' => '&#234;',
  2037. '&euml;' => '&#235;',
  2038. '&igrave;' => '&#236;',
  2039. '&iacute;' => '&#237;',
  2040. '&icirc;' => '&#238;',
  2041. '&iuml;' => '&#239;',
  2042. '&eth;' => '&#240;',
  2043. '&ntilde;' => '&#241;',
  2044. '&ograve;' => '&#242;',
  2045. '&oacute;' => '&#243;',
  2046. '&ocirc;' => '&#244;',
  2047. '&otilde;' => '&#245;',
  2048. '&ouml;' => '&#246;',
  2049. '&divide;' => '&#247;',
  2050. '&oslash;' => '&#248;',
  2051. '&ugrave;' => '&#249;',
  2052. '&uacute;' => '&#250;',
  2053. '&ucirc;' => '&#251;',
  2054. '&uuml;' => '&#252;',
  2055. '&yacute;' => '&#253;',
  2056. '&thorn;' => '&#254;',
  2057. '&yuml;' => '&#255;',
  2058. '&OElig;' => '&#338;',
  2059. '&oelig;' => '&#339;',
  2060. '&Scaron;' => '&#352;',
  2061. '&scaron;' => '&#353;',
  2062. '&Yuml;' => '&#376;',
  2063. '&fnof;' => '&#402;',
  2064. '&circ;' => '&#710;',
  2065. '&tilde;' => '&#732;',
  2066. '&Alpha;' => '&#913;',
  2067. '&Beta;' => '&#914;',
  2068. '&Gamma;' => '&#915;',
  2069. '&Delta;' => '&#916;',
  2070. '&Epsilon;' => '&#917;',
  2071. '&Zeta;' => '&#918;',
  2072. '&Eta;' => '&#919;',
  2073. '&Theta;' => '&#920;',
  2074. '&Iota;' => '&#921;',
  2075. '&Kappa;' => '&#922;',
  2076. '&Lambda;' => '&#923;',
  2077. '&Mu;' => '&#924;',
  2078. '&Nu;' => '&#925;',
  2079. '&Xi;' => '&#926;',
  2080. '&Omicron;' => '&#927;',
  2081. '&Pi;' => '&#928;',
  2082. '&Rho;' => '&#929;',
  2083. '&Sigma;' => '&#931;',
  2084. '&Tau;' => '&#932;',
  2085. '&Upsilon;' => '&#933;',
  2086. '&Phi;' => '&#934;',
  2087. '&Chi;' => '&#935;',
  2088. '&Psi;' => '&#936;',
  2089. '&Omega;' => '&#937;',
  2090. '&alpha;' => '&#945;',
  2091. '&beta;' => '&#946;',
  2092. '&gamma;' => '&#947;',
  2093. '&delta;' => '&#948;',
  2094. '&epsilon;' => '&#949;',
  2095. '&zeta;' => '&#950;',
  2096. '&eta;' => '&#951;',
  2097. '&theta;' => '&#952;',
  2098. '&iota;' => '&#953;',
  2099. '&kappa;' => '&#954;',
  2100. '&lambda;' => '&#955;',
  2101. '&mu;' => '&#956;',
  2102. '&nu;' => '&#957;',
  2103. '&xi;' => '&#958;',
  2104. '&omicron;' => '&#959;',
  2105. '&pi;' => '&#960;',
  2106. '&rho;' => '&#961;',
  2107. '&sigmaf;' => '&#962;',
  2108. '&sigma;' => '&#963;',
  2109. '&tau;' => '&#964;',
  2110. '&upsilon;' => '&#965;',
  2111. '&phi;' => '&#966;',
  2112. '&chi;' => '&#967;',
  2113. '&psi;' => '&#968;',
  2114. '&omega;' => '&#969;',
  2115. '&thetasym;' => '&#977;',
  2116. '&upsih;' => '&#978;',
  2117. '&piv;' => '&#982;',
  2118. '&ensp;' => '&#8194;',
  2119. '&emsp;' => '&#8195;',
  2120. '&thinsp;' => '&#8201;',
  2121. '&zwnj;' => '&#8204;',
  2122. '&zwj;' => '&#8205;',
  2123. '&lrm;' => '&#8206;',
  2124. '&rlm;' => '&#8207;',
  2125. '&ndash;' => '&#8211;',
  2126. '&mdash;' => '&#8212;',
  2127. '&lsquo;' => '&#8216;',
  2128. '&rsquo;' => '&#8217;',
  2129. '&sbquo;' => '&#8218;',
  2130. '&ldquo;' => '&#8220;',
  2131. '&rdquo;' => '&#8221;',
  2132. '&bdquo;' => '&#8222;',
  2133. '&dagger;' => '&#8224;',
  2134. '&Dagger;' => '&#8225;',
  2135. '&bull;' => '&#8226;',
  2136. '&hellip;' => '&#8230;',
  2137. '&permil;' => '&#8240;',
  2138. '&prime;' => '&#8242;',
  2139. '&Prime;' => '&#8243;',
  2140. '&lsaquo;' => '&#8249;',
  2141. '&rsaquo;' => '&#8250;',
  2142. '&oline;' => '&#8254;',
  2143. '&frasl;' => '&#8260;',
  2144. '&euro;' => '&#8364;',
  2145. '&image;' => '&#8465;',
  2146. '&weierp;' => '&#8472;',
  2147. '&real;' => '&#8476;',
  2148. '&trade;' => '&#8482;',
  2149. '&alefsym;' => '&#8501;',
  2150. '&crarr;' => '&#8629;',
  2151. '&lArr;' => '&#8656;',
  2152. '&uArr;' => '&#8657;',
  2153. '&rArr;' => '&#8658;',
  2154. '&dArr;' => '&#8659;',
  2155. '&hArr;' => '&#8660;',
  2156. '&forall;' => '&#8704;',
  2157. '&part;' => '&#8706;',
  2158. '&exist;' => '&#8707;',
  2159. '&empty;' => '&#8709;',
  2160. '&nabla;' => '&#8711;',
  2161. '&isin;' => '&#8712;',
  2162. '&notin;' => '&#8713;',
  2163. '&ni;' => '&#8715;',
  2164. '&prod;' => '&#8719;',
  2165. '&sum;' => '&#8721;',
  2166. '&minus;' => '&#8722;',
  2167. '&lowast;' => '&#8727;',
  2168. '&radic;' => '&#8730;',
  2169. '&prop;' => '&#8733;',
  2170. '&infin;' => '&#8734;',
  2171. '&ang;' => '&#8736;',
  2172. '&and;' => '&#8743;',
  2173. '&or;' => '&#8744;',
  2174. '&cap;' => '&#8745;',
  2175. '&cup;' => '&#8746;',
  2176. '&int;' => '&#8747;',
  2177. '&there4;' => '&#8756;',
  2178. '&sim;' => '&#8764;',
  2179. '&cong;' => '&#8773;',
  2180. '&asymp;' => '&#8776;',
  2181. '&ne;' => '&#8800;',
  2182. '&equiv;' => '&#8801;',
  2183. '&le;' => '&#8804;',
  2184. '&ge;' => '&#8805;',
  2185. '&sub;' => '&#8834;',
  2186. '&sup;' => '&#8835;',
  2187. '&nsub;' => '&#8836;',
  2188. '&sube;' => '&#8838;',
  2189. '&supe;' => '&#8839;',
  2190. '&oplus;' => '&#8853;',
  2191. '&otimes;' => '&#8855;',
  2192. '&perp;' => '&#8869;',
  2193. '&sdot;' => '&#8901;',
  2194. '&lceil;' => '&#8968;',
  2195. '&rceil;' => '&#8969;',
  2196. '&lfloor;' => '&#8970;',
  2197. '&rfloor;' => '&#8971;',
  2198. '&lang;' => '&#9001;',
  2199. '&rang;' => '&#9002;',
  2200. '&larr;' => '&#8592;',
  2201. '&uarr;' => '&#8593;',
  2202. '&rarr;' => '&#8594;',
  2203. '&darr;' => '&#8595;',
  2204. '&harr;' => '&#8596;',
  2205. '&loz;' => '&#9674;',
  2206. '&spades;' => '&#9824;',
  2207. '&clubs;' => '&#9827;',
  2208. '&hearts;' => '&#9829;',
  2209. '&diams;' => '&#9830;'
  2210. );
  2211. return str_replace( array_keys($to_ncr), array_values($to_ncr), $text );
  2212. }
  2213. /**
  2214. * Formats text for the rich text editor.
  2215. *
  2216. * The filter 'richedit_pre' is applied here. If $text is empty the filter will
  2217. * be applied to an empty string.
  2218. *
  2219. * @since 2.0.0
  2220. *
  2221. * @param string $text The text to be formatted.
  2222. * @return string The formatted text after filter is applied.
  2223. */
  2224. function wp_richedit_pre($text) {
  2225. // Filtering a blank results in an annoying <br />\n
  2226. if ( empty($text) ) return apply_filters('richedit_pre', '');
  2227. $output = convert_chars($text);
  2228. $output = wpautop($output);
  2229. $output = htmlspecialchars($output, ENT_NOQUOTES);
  2230. return apply_filters('richedit_pre', $output);
  2231. }
  2232. /**
  2233. * Formats text for the HTML editor.
  2234. *
  2235. * Unless $output is empty it will pass through htmlspecialchars before the
  2236. * 'htmledit_pre' filter is applied.
  2237. *
  2238. * @since 2.5.0
  2239. *
  2240. * @param string $output The text to be formatted.
  2241. * @return string Formatted text after filter applied.
  2242. */
  2243. function wp_htmledit_pre($output) {
  2244. if ( !empty($output) )
  2245. $output = htmlspecialchars($output, ENT_NOQUOTES); // convert only < > &
  2246. return apply_filters('htmledit_pre', $output);
  2247. }
  2248. /**
  2249. * Perform a deep string replace operation to ensure the values in $search are no longer present
  2250. *
  2251. * Repeats the replacement operation until it no longer replaces anything so as to remove "nested" values
  2252. * e.g. $subject = '%0%0%0DDD', $search ='%0D', $result ='' rather than the '%0%0DD' that
  2253. * str_replace would return
  2254. *
  2255. * @since 2.8.1
  2256. * @access private
  2257. *
  2258. * @param string|array $search
  2259. * @param string $subject
  2260. * @return string The processed string
  2261. */
  2262. function _deep_replace( $search, $subject ) {
  2263. $found = true;
  2264. $subject = (string) $subject;
  2265. while ( $found ) {
  2266. $found = false;
  2267. foreach ( (array) $search as $val ) {
  2268. while ( strpos( $subject, $val ) !== false ) {
  2269. $found = true;
  2270. $subject = str_replace( $val, '', $subject );
  2271. }
  2272. }
  2273. }
  2274. return $subject;
  2275. }
  2276. /**
  2277. * Escapes data for use in a MySQL query
  2278. *
  2279. * This is just a handy shortcut for $wpdb->escape(), for completeness' sake
  2280. *
  2281. * @since 2.8.0
  2282. * @param string $sql Unescaped SQL data
  2283. * @return string The cleaned $sql
  2284. */
  2285. function esc_sql( $sql ) {
  2286. global $wpdb;
  2287. return $wpdb->escape( $sql );
  2288. }
  2289. /**
  2290. * Checks and cleans a URL.
  2291. *
  2292. * A number of characters are removed from the URL. If the URL is for displaying
  2293. * (the default behaviour) ampersands are also replaced. The 'clean_url' filter
  2294. * is applied to the returned cleaned URL.
  2295. *
  2296. * @since 2.8.0
  2297. * @uses wp_kses_bad_protocol() To only permit protocols in the URL set
  2298. * via $protocols or the common ones set in the function.
  2299. *
  2300. * @param string $url The URL to be cleaned.
  2301. * @param array $protocols Optional. An array of acceptable protocols.
  2302. * Defaults to 'http', 'https', 'ftp', 'ftps', 'mailto', 'news', 'irc', 'gopher', 'nntp', 'feed', 'telnet', 'mms', 'rtsp', 'svn' if not set.
  2303. * @param string $_context Private. Use esc_url_raw() for database usage.
  2304. * @return string The cleaned $url after the 'clean_url' filter is applied.
  2305. */
  2306. function esc_url( $url, $protocols = null, $_context = 'display' ) {
  2307. $original_url = $url;
  2308. if ( '' == $url )
  2309. return $url;
  2310. $url = preg_replace('|[^a-z0-9-~+_.?#=!&;,/:%@$\|*\'()\\x80-\\xff]|i', '', $url);
  2311. $strip = array('%0d', '%0a', '%0D', '%0A');
  2312. $url = _deep_replace($strip, $url);
  2313. $url = str_replace(';//', '://', $url);
  2314. /* If the URL doesn't appear to contain a scheme, we
  2315. * presume it needs http:// appended (unless a relative
  2316. * link starting with /, # or ? or a php file).
  2317. */
  2318. if ( strpos($url, ':') === false && ! in_array( $url[0], array( '/', '#', '?' ) ) &&
  2319. ! preg_match('/^[a-z0-9-]+?\.php/i', $url) )
  2320. $url = 'http://' . $url;
  2321. // Replace ampersands and single quotes only when displaying.
  2322. if ( 'display' == $_context ) {
  2323. $url = wp_kses_normalize_entities( $url );
  2324. $url = str_replace( '&amp;', '&#038;', $url );
  2325. $url = str_replace( "'", '&#039;', $url );
  2326. }
  2327. if ( ! is_array( $protocols ) )
  2328. $protocols = wp_allowed_protocols();
  2329. if ( wp_kses_bad_protocol( $url, $protocols ) != $url )
  2330. return '';
  2331. return apply_filters('clean_url', $url, $original_url, $_context);
  2332. }
  2333. /**
  2334. * Performs esc_url() for database usage.
  2335. *
  2336. * @since 2.8.0
  2337. * @uses esc_url()
  2338. *
  2339. * @param string $url The URL to be cleaned.
  2340. * @param array $protocols An array of acceptable protocols.
  2341. * @return string The cleaned URL.
  2342. */
  2343. function esc_url_raw( $url, $protocols = null ) {
  2344. return esc_url( $url, $protocols, 'db' );
  2345. }
  2346. /**
  2347. * Convert entities, while preserving already-encoded entities.
  2348. *
  2349. * @link http://www.php.net/htmlentities Borrowed from the PHP Manual user notes.
  2350. *
  2351. * @since 1.2.2
  2352. *
  2353. * @param string $myHTML The text to be converted.
  2354. * @return string Converted text.
  2355. */
  2356. function htmlentities2($myHTML) {
  2357. $translation_table = get_html_translation_table( HTML_ENTITIES, ENT_QUOTES );
  2358. $translation_table[chr(38)] = '&';
  2359. return preg_replace( "/&(?![A-Za-z]{0,4}\w{2,3};|#[0-9]{2,3};)/", "&amp;", strtr($myHTML, $translation_table) );
  2360. }
  2361. /**
  2362. * Escape single quotes, htmlspecialchar " < > &, and fix line endings.
  2363. *
  2364. * Escapes text strings for echoing in JS. It is intended to be used for inline JS
  2365. * (in a tag attribute, for example onclick="..."). Note that the strings have to
  2366. * be in single quotes. The filter 'js_escape' is also applied here.
  2367. *
  2368. * @since 2.8.0
  2369. *
  2370. * @param string $text The text to be escaped.
  2371. * @return string Escaped text.
  2372. */
  2373. function esc_js( $text ) {
  2374. $safe_text = wp_check_invalid_utf8( $text );
  2375. $safe_text = _wp_specialchars( $safe_text, ENT_COMPAT );
  2376. $safe_text = preg_replace( '/&#(x)?0*(?(1)27|39);?/i', "'", stripslashes( $safe_text ) );
  2377. $safe_text = str_replace( "\r", '', $safe_text );
  2378. $safe_text = str_replace( "\n", '\\n', addslashes( $safe_text ) );
  2379. return apply_filters( 'js_escape', $safe_text, $text );
  2380. }
  2381. /**
  2382. * Escaping for HTML blocks.
  2383. *
  2384. * @since 2.8.0
  2385. *
  2386. * @param string $text
  2387. * @return string
  2388. */
  2389. function esc_html( $text ) {
  2390. $safe_text = wp_check_invalid_utf8( $text );
  2391. $safe_text = _wp_specialchars( $safe_text, ENT_QUOTES );
  2392. return apply_filters( 'esc_html', $safe_text, $text );
  2393. }
  2394. /**
  2395. * Escaping for HTML attributes.
  2396. *
  2397. * @since 2.8.0
  2398. *
  2399. * @param string $text
  2400. * @return string
  2401. */
  2402. function esc_attr( $text ) {
  2403. $safe_text = wp_check_invalid_utf8( $text );
  2404. $safe_text = _wp_specialchars( $safe_text, ENT_QUOTES );
  2405. return apply_filters( 'attribute_escape', $safe_text, $text );
  2406. }
  2407. /**
  2408. * Escaping for textarea values.
  2409. *
  2410. * @since 3.1
  2411. *
  2412. * @param string $text
  2413. * @return string
  2414. */
  2415. function esc_textarea( $text ) {
  2416. $safe_text = htmlspecialchars( $text, ENT_QUOTES );
  2417. return apply_filters( 'esc_textarea', $safe_text, $text );
  2418. }
  2419. /**
  2420. * Escape a HTML tag name.
  2421. *
  2422. * @since 2.5.0
  2423. *
  2424. * @param string $tag_name
  2425. * @return string
  2426. */
  2427. function tag_escape($tag_name) {
  2428. $safe_tag = strtolower( preg_replace('/[^a-zA-Z0-9_:]/', '', $tag_name) );
  2429. return apply_filters('tag_escape', $safe_tag, $tag_name);
  2430. }
  2431. /**
  2432. * Escapes text for SQL LIKE special characters % and _.
  2433. *
  2434. * @since 2.5.0
  2435. *
  2436. * @param string $text The text to be escaped.
  2437. * @return string text, safe for inclusion in LIKE query.
  2438. */
  2439. function like_escape($text) {
  2440. return str_replace(array("%", "_"), array("\\%", "\\_"), $text);
  2441. }
  2442. /**
  2443. * Convert full URL paths to absolute paths.
  2444. *
  2445. * Removes the http or https protocols and the domain. Keeps the path '/' at the
  2446. * beginning, so it isn't a true relative link, but from the web root base.
  2447. *
  2448. * @since 2.1.0
  2449. *
  2450. * @param string $link Full URL path.
  2451. * @return string Absolute path.
  2452. */
  2453. function wp_make_link_relative( $link ) {
  2454. return preg_replace( '|https?://[^/]+(/.*)|i', '$1', $link );
  2455. }
  2456. /**
  2457. * Sanitises various option values based on the nature of the option.
  2458. *
  2459. * This is basically a switch statement which will pass $value through a number
  2460. * of functions depending on the $option.
  2461. *
  2462. * @since 2.0.5
  2463. *
  2464. * @param string $option The name of the option.
  2465. * @param string $value The unsanitised value.
  2466. * @return string Sanitized value.
  2467. */
  2468. function sanitize_option($option, $value) {
  2469. switch ( $option ) {
  2470. case 'admin_email' :
  2471. case 'new_admin_email' :
  2472. $value = sanitize_email( $value );
  2473. if ( ! is_email( $value ) ) {
  2474. $value = get_option( $option ); // Resets option to stored value in the case of failed sanitization
  2475. if ( function_exists( 'add_settings_error' ) )
  2476. add_settings_error( $option, 'invalid_admin_email', __( 'The email address entered did not appear to be a valid email address. Please enter a valid email address.' ) );
  2477. }
  2478. break;
  2479. case 'thumbnail_size_w':
  2480. case 'thumbnail_size_h':
  2481. case 'medium_size_w':
  2482. case 'medium_size_h':
  2483. case 'large_size_w':
  2484. case 'large_size_h':
  2485. case 'embed_size_h':
  2486. case 'default_post_edit_rows':
  2487. case 'mailserver_port':
  2488. case 'comment_max_links':
  2489. case 'page_on_front':
  2490. case 'page_for_posts':
  2491. case 'rss_excerpt_length':
  2492. case 'default_category':
  2493. case 'default_email_category':
  2494. case 'default_link_category':
  2495. case 'close_comments_days_old':
  2496. case 'comments_per_page':
  2497. case 'thread_comments_depth':
  2498. case 'users_can_register':
  2499. case 'start_of_week':
  2500. $value = absint( $value );
  2501. break;
  2502. case 'embed_size_w':
  2503. if ( '' !== $value )
  2504. $value = absint( $value );
  2505. break;
  2506. case 'posts_per_page':
  2507. case 'posts_per_rss':
  2508. $value = (int) $value;
  2509. if ( empty($value) )
  2510. $value = 1;
  2511. if ( $value < -1 )
  2512. $value = abs($value);
  2513. break;
  2514. case 'default_ping_status':
  2515. case 'default_comment_status':
  2516. // Options that if not there have 0 value but need to be something like "closed"
  2517. if ( $value == '0' || $value == '')
  2518. $value = 'closed';
  2519. break;
  2520. case 'blogdescription':
  2521. case 'blogname':
  2522. $value = addslashes($value);
  2523. $value = wp_filter_post_kses( $value ); // calls stripslashes then addslashes
  2524. $value = stripslashes($value);
  2525. $value = esc_html( $value );
  2526. break;
  2527. case 'blog_charset':
  2528. $value = preg_replace('/[^a-zA-Z0-9_-]/', '', $value); // strips slashes
  2529. break;
  2530. case 'date_format':
  2531. case 'time_format':
  2532. case 'mailserver_url':
  2533. case 'mailserver_login':
  2534. case 'mailserver_pass':
  2535. case 'ping_sites':
  2536. case 'upload_path':
  2537. $value = strip_tags($value);
  2538. $value = addslashes($value);
  2539. $value = wp_filter_kses($value); // calls stripslashes then addslashes
  2540. $value = stripslashes($value);
  2541. break;
  2542. case 'gmt_offset':
  2543. $value = preg_replace('/[^0-9:.-]/', '', $value); // strips slashes
  2544. break;
  2545. case 'siteurl':
  2546. if ( (bool)preg_match( '#http(s?)://(.+)#i', $value) ) {
  2547. $value = esc_url_raw($value);
  2548. } else {
  2549. $value = get_option( $option ); // Resets option to stored value in the case of failed sanitization
  2550. if ( function_exists('add_settings_error') )
  2551. add_settings_error('siteurl', 'invalid_siteurl', __('The WordPress address you entered did not appear to be a valid URL. Please enter a valid URL.'));
  2552. }
  2553. break;
  2554. case 'home':
  2555. if ( (bool)preg_match( '#http(s?)://(.+)#i', $value) ) {
  2556. $value = esc_url_raw($value);
  2557. } else {
  2558. $value = get_option( $option ); // Resets option to stored value in the case of failed sanitization
  2559. if ( function_exists('add_settings_error') )
  2560. add_settings_error('home', 'invalid_home', __('The Site address you entered did not appear to be a valid URL. Please enter a valid URL.'));
  2561. }
  2562. break;
  2563. case 'WPLANG':
  2564. $allowed = get_available_languages();
  2565. if ( ! in_array( $value, $allowed ) && ! empty( $value ) )
  2566. $value = get_option( $option );
  2567. break;
  2568. case 'timezone_string':
  2569. $allowed_zones = timezone_identifiers_list();
  2570. if ( ! in_array( $value, $allowed_zones ) && ! empty( $value ) ) {
  2571. $value = get_option( $option ); // Resets option to stored value in the case of failed sanitization
  2572. if ( function_exists('add_settings_error') )
  2573. add_settings_error('timezone_string', 'invalid_timezone_string', __('The timezone you have entered is not valid. Please select a valid timezone.') );
  2574. }
  2575. break;
  2576. case 'permalink_structure':
  2577. case 'category_base':
  2578. case 'tag_base':
  2579. $value = esc_url_raw( $value );
  2580. $value = str_replace( 'http://', '', $value );
  2581. break;
  2582. }
  2583. $value = apply_filters("sanitize_option_{$option}", $value, $option);
  2584. return $value;
  2585. }
  2586. /**
  2587. * Parses a string into variables to be stored in an array.
  2588. *
  2589. * Uses {@link http://www.php.net/parse_str parse_str()} and stripslashes if
  2590. * {@link http://www.php.net/magic_quotes magic_quotes_gpc} is on.
  2591. *
  2592. * @since 2.2.1
  2593. * @uses apply_filters() for the 'wp_parse_str' filter.
  2594. *
  2595. * @param string $string The string to be parsed.
  2596. * @param array $array Variables will be stored in this array.
  2597. */
  2598. function wp_parse_str( $string, &$array ) {
  2599. parse_str( $string, $array );
  2600. if ( get_magic_quotes_gpc() )
  2601. $array = stripslashes_deep( $array );
  2602. $array = apply_filters( 'wp_parse_str', $array );
  2603. }
  2604. /**
  2605. * Convert lone less than signs.
  2606. *
  2607. * KSES already converts lone greater than signs.
  2608. *
  2609. * @uses wp_pre_kses_less_than_callback in the callback function.
  2610. * @since 2.3.0
  2611. *
  2612. * @param string $text Text to be converted.
  2613. * @return string Converted text.
  2614. */
  2615. function wp_pre_kses_less_than( $text ) {
  2616. return preg_replace_callback('%<[^>]*?((?=<)|>|$)%', 'wp_pre_kses_less_than_callback', $text);
  2617. }
  2618. /**
  2619. * Callback function used by preg_replace.
  2620. *
  2621. * @uses esc_html to format the $matches text.
  2622. * @since 2.3.0
  2623. *
  2624. * @param array $matches Populated by matches to preg_replace.
  2625. * @return string The text returned after esc_html if needed.
  2626. */
  2627. function wp_pre_kses_less_than_callback( $matches ) {
  2628. if ( false === strpos($matches[0], '>') )
  2629. return esc_html($matches[0]);
  2630. return $matches[0];
  2631. }
  2632. /**
  2633. * WordPress implementation of PHP sprintf() with filters.
  2634. *
  2635. * @since 2.5.0
  2636. * @link http://www.php.net/sprintf
  2637. *
  2638. * @param string $pattern The string which formatted args are inserted.
  2639. * @param mixed $args,... Arguments to be formatted into the $pattern string.
  2640. * @return string The formatted string.
  2641. */
  2642. function wp_sprintf( $pattern ) {
  2643. $args = func_get_args( );
  2644. $len = strlen($pattern);
  2645. $start = 0;
  2646. $result = '';
  2647. $arg_index = 0;
  2648. while ( $len > $start ) {
  2649. // Last character: append and break
  2650. if ( strlen($pattern) - 1 == $start ) {
  2651. $result .= substr($pattern, -1);
  2652. break;
  2653. }
  2654. // Literal %: append and continue
  2655. if ( substr($pattern, $start, 2) == '%%' ) {
  2656. $start += 2;
  2657. $result .= '%';
  2658. continue;
  2659. }
  2660. // Get fragment before next %
  2661. $end = strpos($pattern, '%', $start + 1);
  2662. if ( false === $end )
  2663. $end = $len;
  2664. $fragment = substr($pattern, $start, $end - $start);
  2665. // Fragment has a specifier
  2666. if ( $pattern[$start] == '%' ) {
  2667. // Find numbered arguments or take the next one in order
  2668. if ( preg_match('/^%(\d+)\$/', $fragment, $matches) ) {
  2669. $arg = isset($args[$matches[1]]) ? $args[$matches[1]] : '';
  2670. $fragment = str_replace("%{$matches[1]}$", '%', $fragment);
  2671. } else {
  2672. ++$arg_index;
  2673. $arg = isset($args[$arg_index]) ? $args[$arg_index] : '';
  2674. }
  2675. // Apply filters OR sprintf
  2676. $_fragment = apply_filters( 'wp_sprintf', $fragment, $arg );
  2677. if ( $_fragment != $fragment )
  2678. $fragment = $_fragment;
  2679. else
  2680. $fragment = sprintf($fragment, strval($arg) );
  2681. }
  2682. // Append to result and move to next fragment
  2683. $result .= $fragment;
  2684. $start = $end;
  2685. }
  2686. return $result;
  2687. }
  2688. /**
  2689. * Localize list items before the rest of the content.
  2690. *
  2691. * The '%l' must be at the first characters can then contain the rest of the
  2692. * content. The list items will have ', ', ', and', and ' and ' added depending
  2693. * on the amount of list items in the $args parameter.
  2694. *
  2695. * @since 2.5.0
  2696. *
  2697. * @param string $pattern Content containing '%l' at the beginning.
  2698. * @param array $args List items to prepend to the content and replace '%l'.
  2699. * @return string Localized list items and rest of the content.
  2700. */
  2701. function wp_sprintf_l($pattern, $args) {
  2702. // Not a match
  2703. if ( substr($pattern, 0, 2) != '%l' )
  2704. return $pattern;
  2705. // Nothing to work with
  2706. if ( empty($args) )
  2707. return '';
  2708. // Translate and filter the delimiter set (avoid ampersands and entities here)
  2709. $l = apply_filters('wp_sprintf_l', array(
  2710. /* translators: used between list items, there is a space after the comma */
  2711. 'between' => __(', '),
  2712. /* translators: used between list items, there is a space after the and */
  2713. 'between_last_two' => __(', and '),
  2714. /* translators: used between only two list items, there is a space after the and */
  2715. 'between_only_two' => __(' and '),
  2716. ));
  2717. $args = (array) $args;
  2718. $result = array_shift($args);
  2719. if ( count($args) == 1 )
  2720. $result .= $l['between_only_two'] . array_shift($args);
  2721. // Loop when more than two args
  2722. $i = count($args);
  2723. while ( $i ) {
  2724. $arg = array_shift($args);
  2725. $i--;
  2726. if ( 0 == $i )
  2727. $result .= $l['between_last_two'] . $arg;
  2728. else
  2729. $result .= $l['between'] . $arg;
  2730. }
  2731. return $result . substr($pattern, 2);
  2732. }
  2733. /**
  2734. * Safely extracts not more than the first $count characters from html string.
  2735. *
  2736. * UTF-8, tags and entities safe prefix extraction. Entities inside will *NOT*
  2737. * be counted as one character. For example &amp; will be counted as 4, &lt; as
  2738. * 3, etc.
  2739. *
  2740. * @since 2.5.0
  2741. *
  2742. * @param integer $str String to get the excerpt from.
  2743. * @param integer $count Maximum number of characters to take.
  2744. * @return string The excerpt.
  2745. */
  2746. function wp_html_excerpt( $str, $count ) {
  2747. $str = wp_strip_all_tags( $str, true );
  2748. $str = mb_substr( $str, 0, $count );
  2749. // remove part of an entity at the end
  2750. $str = preg_replace( '/&[^;\s]{0,6}$/', '', $str );
  2751. return $str;
  2752. }
  2753. /**
  2754. * Add a Base url to relative links in passed content.
  2755. *
  2756. * By default it supports the 'src' and 'href' attributes. However this can be
  2757. * changed via the 3rd param.
  2758. *
  2759. * @since 2.7.0
  2760. *
  2761. * @param string $content String to search for links in.
  2762. * @param string $base The base URL to prefix to links.
  2763. * @param array $attrs The attributes which should be processed.
  2764. * @return string The processed content.
  2765. */
  2766. function links_add_base_url( $content, $base, $attrs = array('src', 'href') ) {
  2767. global $_links_add_base;
  2768. $_links_add_base = $base;
  2769. $attrs = implode('|', (array)$attrs);
  2770. return preg_replace_callback( "!($attrs)=(['\"])(.+?)\\2!i", '_links_add_base', $content );
  2771. }
  2772. /**
  2773. * Callback to add a base url to relative links in passed content.
  2774. *
  2775. * @since 2.7.0
  2776. * @access private
  2777. *
  2778. * @param string $m The matched link.
  2779. * @return string The processed link.
  2780. */
  2781. function _links_add_base($m) {
  2782. global $_links_add_base;
  2783. //1 = attribute name 2 = quotation mark 3 = URL
  2784. return $m[1] . '=' . $m[2] .
  2785. ( preg_match( '#^(\w{1,20}):#', $m[3], $protocol ) && in_array( $protocol[1], wp_allowed_protocols() ) ?
  2786. $m[3] :
  2787. path_join( $_links_add_base, $m[3] ) )
  2788. . $m[2];
  2789. }
  2790. /**
  2791. * Adds a Target attribute to all links in passed content.
  2792. *
  2793. * This function by default only applies to <a> tags, however this can be
  2794. * modified by the 3rd param.
  2795. *
  2796. * <b>NOTE:</b> Any current target attributed will be stripped and replaced.
  2797. *
  2798. * @since 2.7.0
  2799. *
  2800. * @param string $content String to search for links in.
  2801. * @param string $target The Target to add to the links.
  2802. * @param array $tags An array of tags to apply to.
  2803. * @return string The processed content.
  2804. */
  2805. function links_add_target( $content, $target = '_blank', $tags = array('a') ) {
  2806. global $_links_add_target;
  2807. $_links_add_target = $target;
  2808. $tags = implode('|', (array)$tags);
  2809. return preg_replace_callback( "!<($tags)(.+?)>!i", '_links_add_target', $content );
  2810. }
  2811. /**
  2812. * Callback to add a target attribute to all links in passed content.
  2813. *
  2814. * @since 2.7.0
  2815. * @access private
  2816. *
  2817. * @param string $m The matched link.
  2818. * @return string The processed link.
  2819. */
  2820. function _links_add_target( $m ) {
  2821. global $_links_add_target;
  2822. $tag = $m[1];
  2823. $link = preg_replace('|(target=[\'"](.*?)[\'"])|i', '', $m[2]);
  2824. return '<' . $tag . $link . ' target="' . esc_attr( $_links_add_target ) . '">';
  2825. }
  2826. // normalize EOL characters and strip duplicate whitespace
  2827. function normalize_whitespace( $str ) {
  2828. $str = trim($str);
  2829. $str = str_replace("\r", "\n", $str);
  2830. $str = preg_replace( array( '/\n+/', '/[ \t]+/' ), array( "\n", ' ' ), $str );
  2831. return $str;
  2832. }
  2833. /**
  2834. * Properly strip all HTML tags including script and style
  2835. *
  2836. * @since 2.9.0
  2837. *
  2838. * @param string $string String containing HTML tags
  2839. * @param bool $remove_breaks optional Whether to remove left over line breaks and white space chars
  2840. * @return string The processed string.
  2841. */
  2842. function wp_strip_all_tags($string, $remove_breaks = false) {
  2843. $string = preg_replace( '@<(script|style)[^>]*?>.*?</\\1>@si', '', $string );
  2844. $string = strip_tags($string);
  2845. if ( $remove_breaks )
  2846. $string = preg_replace('/[\r\n\t ]+/', ' ', $string);
  2847. return trim( $string );
  2848. }
  2849. /**
  2850. * Sanitize a string from user input or from the db
  2851. *
  2852. * check for invalid UTF-8,
  2853. * Convert single < characters to entity,
  2854. * strip all tags,
  2855. * remove line breaks, tabs and extra white space,
  2856. * strip octets.
  2857. *
  2858. * @since 2.9.0
  2859. *
  2860. * @param string $str
  2861. * @return string
  2862. */
  2863. function sanitize_text_field($str) {
  2864. $filtered = wp_check_invalid_utf8( $str );
  2865. if ( strpos($filtered, '<') !== false ) {
  2866. $filtered = wp_pre_kses_less_than( $filtered );
  2867. // This will strip extra whitespace for us.
  2868. $filtered = wp_strip_all_tags( $filtered, true );
  2869. } else {
  2870. $filtered = trim( preg_replace('/[\r\n\t ]+/', ' ', $filtered) );
  2871. }
  2872. $match = array();
  2873. $found = false;
  2874. while ( preg_match('/%[a-f0-9]{2}/i', $filtered, $match) ) {
  2875. $filtered = str_replace($match[0], '', $filtered);
  2876. $found = true;
  2877. }
  2878. if ( $found ) {
  2879. // Strip out the whitespace that may now exist after removing the octets.
  2880. $filtered = trim( preg_replace('/ +/', ' ', $filtered) );
  2881. }
  2882. return apply_filters('sanitize_text_field', $filtered, $str);
  2883. }
  2884. /**
  2885. * i18n friendly version of basename()
  2886. *
  2887. * @since 3.1.0
  2888. *
  2889. * @param string $path A path.
  2890. * @param string $suffix If the filename ends in suffix this will also be cut off.
  2891. * @return string
  2892. */
  2893. function wp_basename( $path, $suffix = '' ) {
  2894. return urldecode( basename( str_replace( '%2F', '/', urlencode( $path ) ), $suffix ) );
  2895. }
  2896. /**
  2897. * Forever eliminate "Wordpress" from the planet (or at least the little bit we can influence).
  2898. *
  2899. * Violating our coding standards for a good function name.
  2900. *
  2901. * @since 3.0.0
  2902. */
  2903. function capital_P_dangit( $text ) {
  2904. // Simple replacement for titles
  2905. if ( 'the_title' === current_filter() )
  2906. return str_replace( 'Wordpress', 'WordPress', $text );
  2907. // Still here? Use the more judicious replacement
  2908. static $dblq = false;
  2909. if ( false === $dblq )
  2910. $dblq = _x( '&#8220;', 'opening curly double quote' );
  2911. return str_replace(
  2912. array( ' Wordpress', '&#8216;Wordpress', $dblq . 'Wordpress', '>Wordpress', '(Wordpress' ),
  2913. array( ' WordPress', '&#8216;WordPress', $dblq . 'WordPress', '>WordPress', '(WordPress' ),
  2914. $text );
  2915. }
  2916. /**
  2917. * Sanitize a mime type
  2918. *
  2919. * @since 3.1.3
  2920. *
  2921. * @param string $mime_type Mime type
  2922. * @return string Sanitized mime type
  2923. */
  2924. function sanitize_mime_type( $mime_type ) {
  2925. $sani_mime_type = preg_replace( '/[^-+*.a-zA-Z0-9\/]/', '', $mime_type );
  2926. return apply_filters( 'sanitize_mime_type', $sani_mime_type, $mime_type );
  2927. }
  2928. /**
  2929. * Sanitize space or carriage return separated URLs that are used to send trackbacks.
  2930. *
  2931. * @since 3.4.0
  2932. *
  2933. * @param string $to_ping Space or carriage return separated URLs
  2934. * @return string URLs starting with the http or https protocol, separated by a carriage return.
  2935. */
  2936. function sanitize_trackback_urls( $to_ping ) {
  2937. $urls_to_ping = preg_split( '/\r\n\t /', trim( $to_ping ), -1, PREG_SPLIT_NO_EMPTY );
  2938. foreach ( $urls_to_ping as $k => $url ) {
  2939. if ( !preg_match( '#^https?://.#i', $url ) )
  2940. unset( $urls_to_ping[$k] );
  2941. }
  2942. $urls_to_ping = array_map( 'esc_url_raw', $urls_to_ping );
  2943. $urls_to_ping = implode( "\n", $urls_to_ping );
  2944. return apply_filters( 'sanitize_trackback_urls', $urls_to_ping, $to_ping );
  2945. }