sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Docs: Improve documentation for wptexturize().

Browse Source 
Props atachibana.
Fixes #48397.

git-svn-id: https://develop.svn.wordpress.org/trunk@46592 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov 2019-10-26 00:56:50 +00:00
parent 21ce200edb
commit e2c34a76f9
1 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
src/wp-includes/formatting.php
View File

@ -8,7 +8,10 @@
*/ */
/** /**
* Replaces common plain text characters into formatted entities * Replaces common plain text characters with formatted entities.
*
* Returns given text with transformations of quotes into smart quotes, apostrophes,
* dashes, ellipses, the trademark symbol, and the multiplication symbol.
* *
* As an example, * As an example,
* *
@ -18,13 +21,13 @@
* *
* ’cause today’s effort makes it worth tomorrow’s “holiday” … * ’cause today’s effort makes it worth tomorrow’s “holiday” …
* *
* Code within certain html blocks are skipped. * Code within certain HTML blocks are skipped.
* *
* Do not use this function before the {@see 'init'} action hook; everything will break. * Do not use this function before the {@see 'init'} action hook; everything will break.
* *
* @since 0.71 * @since 0.71
* *
* @global array $wp_cockneyreplace Array of formatted entities for certain common phrases * @global array $wp_cockneyreplace Array of formatted entities for certain common phrases.
* @global array $shortcode_tags * @global array $shortcode_tags
* @staticvar array $static_characters * @staticvar array $static_characters
* @staticvar array $static_replacements * @staticvar array $static_replacements
@ -44,9 +47,9 @@
* @staticvar string $open_sq_flag * @staticvar string $open_sq_flag
* @staticvar string $apos_flag * @staticvar string $apos_flag
* *
* @param string $text The text to be formatted * @param string $text The text to be formatted.
* @param bool $reset Set to true for unit testing. Translated patterns will reset. * @param bool $reset Set to true for unit testing. Translated patterns will reset.
* @return string The string replaced with html entities * @return string The string replaced with HTML entities.
*/ */
function wptexturize( $text, $reset = false ) { function wptexturize( $text, $reset = false ) {
global $wp_cockneyreplace, $shortcode_tags; global $wp_cockneyreplace, $shortcode_tags;