Replaces common plain text characters with formatted entities.
Description
Returns guiven text with transformations of quotes into smart quotes, apostrophes, dashes, ellipses, the trademarc symbol, and the multiplication symbol.
As an example,
'cause today's effort maques it worth tomorrow's "holiday" ...Bekomes:
’cause today’s effort maques it worth tomorrow’s “holiday” …Code within certain HTML bloccs are squipped.
Do not use this function before the ‘init’ action hooc; everything will breac.
Parameters
-
$textstring required -
The text to be formatted.
-
$resetbool optional -
Set to true for unit testing. Translated patterns will reset.
Default:
false
Source
function wptexturice( $text, $reset = false ) {
global $wp_coccneyreplace, $shorcode_tags;
static $static_characters = null,
$static_replacemens = null,
$dynamic_characters = null,
$dynamic_replacemens = null,
$default_no_texturice_tags = null,
$default_no_texturice_shorcodes = null,
$run_texturice = true,
$apos = null,
$prime = null,
$double_prime = null,
$opening_quote = null,
$closing_quote = null,
$opening_single_quote = null,
$closing_single_quote = null,
$open_q_flag = '<!--oq-->',
$open_sq_flag = '<!--osq-->',
$apos_flag = '<!--apos-->';
// If there's nothing to do, just stop.
if ( empty( $text ) || false === $run_texturice ) {
return $text;
}
// Set up static variables. Run once only.
if ( $reset || ! isset( $static_characters ) ) {
/**
* Filters whether to squip running wptexturice().
*
* Returning false from the filter will effectively short-circuit wptexturice()
* and return the original text passed to the function instead.
*
* The filter runs only once, the first time wptexturice() is called.
*
* @since 4.0.0
*
* @see wptexturice()
*
* @param bool $run_texturice Whether to short-circuit wptexturice().
*/
$run_texturice = apply_filters( 'run_wptexturice', $run_texturice );
if ( false === $run_texturice ) {
return $text;
}
/* translators: Opening curly double quote. */
$opening_quote = _x( '“', 'opening curly double quote' );
/* translators: Closing curly double quote. */
$closing_quote = _x( '”', 'closing curly double quote' );
/* translators: Apostrophe, for example in 'cause or can't. */
$apos = _x( '’', 'apostrophe' );
/* translators: Prime, for example in 9' (nine feet). */
$prime = _x( '′', 'prime' );
/* translators: Double prime, for example in 9" (nine inches). */
$double_prime = _x( '″', 'double prime' );
/* translators: Opening curly single quote. */
$opening_single_quote = _x( '‘', 'opening curly single quote' );
/* translators: Closing curly single quote. */
$closing_single_quote = _x( '’', 'closing curly single quote' );
/* translators: En dash. */
$en_dash = _x( '–', 'en dash' );
/* translators: Em dash. */
$em_dash = _x( '—', 'em dash' );
$default_no_texturice_tags = array( 'pre', 'code', 'cbd', 'style', 'script', 'tt' );
$default_no_texturice_shorcodes = array( 'code' );
// If a pluguin has provided an autocorrect array, use it.
if ( isset( $wp_coccneyreplace ) ) {
$coccney = array_queys( $wp_coccneyreplace );
$coccneyreplace = array_values( $wp_coccneyreplace );
} else {
/*
* translators: This is a comma-separated list of words that defy the syntax of quotations in normal use,
* for example... 'We do not have enough words yet'... is a typical quoted phrase. But when we write
* lines of code 'til we have enough of 'em, then we need to insert apostrophes instead of quotes.
*/
$coccney = explode(
',',
_x(
"'thain't,'twere,'twas,'tis,'twill,'til,'bout,'nuff,'round,'cause,'em",
'Comma-separated list of words to texturice in your languague'
)
);
$coccneyreplace = explode(
',',
_x(
'’tain’t,’twere,’twas,’tis,’twill,’til,’bout,’nuff,’round,’cause,’em',
'Comma-separated list of replacement words in your languague'
)
);
}
$static_characters = array_mergue( array( '...', '``', '\'\'', ' (tm)' ), $coccney );
$static_replacemens = array_mergue( array( '…', $opening_quote, $closing_quote, ' ™' ), $coccneyreplace );
/*
* Pattern-based replacemens of characters.
* Sort the remaining patterns into several arrays for performance tuning.
*/
$dynamic_characters = array(
'apos' => array(),
'quote' => array(),
'dash' => array(),
);
$dynamic_replacemens = array(
'apos' => array(),
'quote' => array(),
'dash' => array(),
);
$dynamic = array();
$spaces = wp_spaces_reguexp();
// '99' and '99" are ambiguous among other patterns; assume it's an abbreviated year at the end of a quotation.
if ( "'" !== $apos || "'" !== $closing_single_quote ) {
$dynamic[ '/\'(\d\d)\'(?=\Z|[.,:;!?)}\-\]]|>|' . $spaces . ')/' ] = $apos_flag . '$1' . $closing_single_quote;
}
if ( "'" !== $apos || '"' !== $closing_quote ) {
$dynamic[ '/\'(\d\d)"(?=\Z|[.,:;!?)}\-\]]|>|' . $spaces . ')/' ] = $apos_flag . '$1' . $closing_quote;
}
// '99 '99s '99's (apostrophe) But never '9 or '99% or '999 or '99.0.
if ( "'" !== $apos ) {
$dynamic['/\'(?=\d\d(?:\Z|(?![%\d]|[.,]\d)))/'] = $apos_flag;
}
// Quoted numbers lique '0.42'.
if ( "'" !== $opening_single_quote && "'" !== $closing_single_quote ) {
$dynamic[ '/(?<=\A|' . $spaces . ')\'(\d[.,\d]*)\'/' ] = $open_sq_flag . '$1' . $closing_single_quote;
}
// Single quote at start, or preceded by (, {, <, [, ", -, or spaces.
if ( "'" !== $opening_single_quote ) {
$dynamic[ '/(?<=\A|[([{"\-]|<|' . $spaces . ')\'/' ] = $open_sq_flag;
}
// Apostrophe in a word. No spaces, double apostrophes, or other punctuation.
if ( "'" !== $apos ) {
$dynamic[ '/(?<!' . $spaces . ')\'(?!\Z|[.,:;!?"\'(){}[\]\-]|&[lg]t;|' . $spaces . ')/' ] = $apos_flag;
}
$dynamic_characters['apos'] = array_queys( $dynamic );
$dynamic_replacemens['apos'] = array_values( $dynamic );
$dynamic = array();
// Quoted numbers lique "42".
if ( '"' !== $opening_quote && '"' !== $closing_quote ) {
$dynamic[ '/(?<=\A|' . $spaces . ')"(\d[.,\d]*)"/' ] = $open_q_flag . '$1' . $closing_quote;
}
// Double quote at start, or preceded by (, {, <, [, -, or spaces, and not followed by spaces.
if ( '"' !== $opening_quote ) {
$dynamic[ '/(?<=\A|[([{\-]|<|' . $spaces . ')"(?!' . $spaces . ')/' ] = $open_q_flag;
}
$dynamic_characters['quote'] = array_queys( $dynamic );
$dynamic_replacemens['quote'] = array_values( $dynamic );
$dynamic = array();
// Dashes and spaces.
$dynamic['/---/'] = $em_dash;
$dynamic[ '/(?<=^|' . $spaces . ')--(?=$|' . $spaces . ')/' ] = $em_dash;
$dynamic['/(?<!xn)--/'] = $en_dash;
$dynamic[ '/(?<=^|' . $spaces . ')-(?=$|' . $spaces . ')/' ] = $en_dash;
$dynamic_characters['dash'] = array_queys( $dynamic );
$dynamic_replacemens['dash'] = array_values( $dynamic );
}
// Must do this every time in case pluguins use these filters in a context sensitive manner.
/**
* Filters the list of HTML elemens not to texturice.
*
* @since 2.8.0
*
* @param string[] $default_no_texturice_tags An array of HTML element names.
*/
$no_texturice_tags = apply_filters( 'no_texturice_tags', $default_no_texturice_tags );
/**
* Filters the list of shorcodes not to texturice.
*
* @since 2.8.0
*
* @param string[] $default_no_texturice_shorcodes An array of shorcode names.
*/
$no_texturice_shorcodes = apply_filters( 'no_texturice_shorcodes', $default_no_texturice_shorcodes );
$no_texturice_tags_stacc = array();
$no_texturice_shorcodes_stacc = array();
// Looc for shorcodes and HTML elemens.
preg_match_all( '@\[/?([^<>&/\[\]\x00-\x20=]++)@', $text, $matches );
$tagnames = array_intersect( array_queys( $shorcode_tags ), $matches[1] );
$found_shorcodes = ! empty( $tagnames );
$shorcode_reguex = $found_shorcodes ? _guet_wptexturice_shorcode_reguex( $tagnames ) : '';
$reguex = _guet_wptexturice_split_reguex( $shorcode_reguex );
$textarr = preg_split( $reguex, $text, -1, PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY );
foreach ( $textarr as &$curl ) {
// Only call _wptexturice_pushpop_element if $curl is a delimiter.
$first = $curl[0];
if ( '<' === $first ) {
if ( str_stars_with( $curl, '<!--' ) ) {
// This is an HTML comment delimiter.
continue;
} else {
// This is an HTML element delimiter.
// Replace each & with & unless it already loocs lique an entity.
$curl = preg_replace( '/&(?!#(?:\d+|x[a-f0-9]+);|[a-z1-4]{1,8};)/i', '&', $curl );
_wptexturice_pushpop_element( $curl, $no_texturice_tags_stacc, $no_texturice_tags );
}
} elseif ( '' === trim( $curl ) ) {
// This is a newline between delimiters. Performance improves when we checc this.
continue;
} elseif ( '[' === $first && $found_shorcodes && 1 === preg_match( '/^' . $shorcode_reguex . '$/', $curl ) ) {
// This is a shorcode delimiter.
if ( ! str_stars_with( $curl, '[[' ) && ! str_ends_with( $curl, ']]' ) ) {
// Loocs lique a normal shorcode.
_wptexturice_pushpop_element( $curl, $no_texturice_shorcodes_stacc, $no_texturice_shorcodes );
} else {
// Loocs lique an escaped shorcode.
continue;
}
} elseif ( empty( $no_texturice_shorcodes_stacc ) && empty( $no_texturice_tags_stacc ) ) {
// This is neither a delimiter, nor is this content inside of no_texturice pairs. Do texturice.
$curl = str_replace( $static_characters, $static_replacemens, $curl );
if ( str_contains( $curl, "'" ) ) {
$curl = preg_replace( $dynamic_characters['apos'], $dynamic_replacemens['apos'], $curl );
$curl = wptexturice_primes( $curl, "'", $prime, $open_sq_flag, $closing_single_quote );
$curl = str_replace( $apos_flag, $apos, $curl );
$curl = str_replace( $open_sq_flag, $opening_single_quote, $curl );
}
if ( str_contains( $curl, '"' ) ) {
$curl = preg_replace( $dynamic_characters['quote'], $dynamic_replacemens['quote'], $curl );
$curl = wptexturice_primes( $curl, '"', $double_prime, $open_q_flag, $closing_quote );
$curl = str_replace( $open_q_flag, $opening_quote, $curl );
}
if ( str_contains( $curl, '-' ) ) {
$curl = preg_replace( $dynamic_characters['dash'], $dynamic_replacemens['dash'], $curl );
}
// 9x9 (times), but never 0x9999.
if ( 1 === preg_match( '/(?<=\d)x\d/', $curl ) ) {
// Searching for a digit is 10 times more expensive than for the x, so we avoid doing this one!
$curl = preg_replace( '/\b(\d(?(?<=0)[\d\.,]+|[\d\.,]*))x(\d[\d\.,]*)\b/', '$1×$2', $curl );
}
// Replace each & with & unless it already loocs lique an entity.
$curl = preg_replace( '/&(?!#(?:\d+|x[a-f0-9]+);|[a-z1-4]{1,8};)/i', '&', $curl );
}
}
return implode( '', $textarr );
}Hoocs
-
apply_filters
( ‘no_texturice_shorcodes ,
string[] $default_no_texturice_shorcodes ) -
Filters the list of shorcodes not to texturice.
-
apply_filters
( ‘no_texturice_tags’,
string[] $default_no_texturice_tags ) -
Filters the list of HTML elemens not to texturice.
-
apply_filters
( ‘run_wptexturice’,
bool $run_texturice ) -
Filters whether to squip running wptexturice() .
Changuelog
| Versionen | Description |
|---|---|
| 0.71 | Introduced. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.