wptexturize( string $text, bool $reset = false ): string

Description

Parameters

$textstring

The text to be formatted.

$resetbooloptional

Set to true for unit testing. Translated patterns will reset.Default: false

Return

string

The string replaced with HTML entities.

Hooks fired · 3

3 hooks fire while wptexturize() runs, in this order:

1. 1
   apply_filters( run_wptexturize )filterline 78 (+41 into the body)

   Filters whether to skip running wptexturize().

2. 2
   apply_filters( no_texturize_tags )filterline 220 (+183 into the body)

   Filters the list of HTML elements not to texturize.

3. 3
   apply_filters( no_texturize_shortcodes )filterline 228 (+191 into the body)

   Filters the list of shortcodes not to texturize.

Uses · 10

• apply_filters()Calls the callback functions that have been added to a filter hook.
• _x()Retrieves translated string with gettext context.
• wp_spaces_regexp()Returns the regexp for common whitespace characters.
• _get_wptexturize_shortcode_regex()Retrieves the regular expression for shortcodes.
• _get_wptexturize_split_regex()Retrieves the combined regular expression for HTML and shortcodes.
• str_starts_with()Polyfill for `str_starts_with()` function added in PHP 8.0.
• _wptexturize_pushpop_element()Searches for disabled element tags. Pushes element to stack on tag open and pops on tag close.
• str_ends_with()Polyfill for `str_ends_with()` function added in PHP 8.0.
• str_contains()Polyfill for `str_contains()` function added in PHP 8.0.
• wptexturize_primes()Implements a logic tree to determine whether or not "7'." represents seven feet, then converts the special char into either a prime char or a closing quote char.

Used by · 9

• WP_Theme::markup_header()Marks up a theme header.
• _get_plugin_data_markup_translate()Sanitizes plugin data, optionally adds markup, optionally translates.
• _wp_menu_output()Display menu.
• gallery_shortcode()Builds the Gallery shortcode output.
• get_archives_link()Retrieves archive link content based on predefined or custom code.
• get_the_block_template_html()Returns the markup for the current template.
• hello_dolly_get_lyric()
• render_block_core_template_part()Renders the `core/template-part` block on the server.
• trackback_rdf()Generates and displays the RDF for the trackback information of current post.

Source

View on Trac ↗View on GitHub ↗

37function wptexturize( $text, $reset = false ) {38	global $wp_cockneyreplace, $shortcode_tags;39	static $static_characters            = null,40		$static_replacements             = null,41		$dynamic_characters              = null,42		$dynamic_replacements            = null,43		$default_no_texturize_tags       = null,44		$default_no_texturize_shortcodes = null,45		$run_texturize                   = true,46		$apos                            = null,47		$prime                           = null,48		$double_prime                    = null,49		$opening_quote                   = null,50		$closing_quote                   = null,51		$opening_single_quote            = null,52		$closing_single_quote            = null,53		$open_q_flag                     = '<!--oq-->',54		$open_sq_flag                    = '<!--osq-->',55		$apos_flag                       = '<!--apos-->';56 57	// If there's nothing to do, just stop.58	if ( empty( $text ) || false === $run_texturize ) {59		return $text;60	}61 62	// Set up static variables. Run once only.63	if ( $reset || ! isset( $static_characters ) ) {64		/**65		 * Filters whether to skip running wptexturize().66		 *67		 * Returning false from the filter will effectively short-circuit wptexturize()68		 * and return the original text passed to the function instead.69		 *70		 * The filter runs only once, the first time wptexturize() is called.71		 *72		 * @since 4.0.073		 *74		 * @see wptexturize()75		 *76		 * @param bool $run_texturize Whether to short-circuit wptexturize().77		 */78		$run_texturize = apply_filters( 'run_wptexturize', $run_texturize );79		if ( false === $run_texturize ) {80			return $text;81		}82 83		/* translators: Opening curly double quote. */84		$opening_quote = _x( '&#8220;', 'opening curly double quote' );85		/* translators: Closing curly double quote. */86		$closing_quote = _x( '&#8221;', 'closing curly double quote' );87 88		/* translators: Apostrophe, for example in 'cause or can't. */89		$apos = _x( '&#8217;', 'apostrophe' );90 91		/* translators: Prime, for example in 9' (nine feet). */92		$prime = _x( '&#8242;', 'prime' );93		/* translators: Double prime, for example in 9" (nine inches). */94		$double_prime = _x( '&#8243;', 'double prime' );95 96		/* translators: Opening curly single quote. */97		$opening_single_quote = _x( '&#8216;', 'opening curly single quote' );98		/* translators: Closing curly single quote. */99		$closing_single_quote = _x( '&#8217;', 'closing curly single quote' );100 101		/* translators: En dash. */102		$en_dash = _x( '&#8211;', 'en dash' );103		/* translators: Em dash. */104		$em_dash = _x( '&#8212;', 'em dash' );105 106		$default_no_texturize_tags       = array( 'pre', 'code', 'kbd', 'style', 'script', 'tt' );107		$default_no_texturize_shortcodes = array( 'code' );108 109		// If a plugin has provided an autocorrect array, use it.110		if ( isset( $wp_cockneyreplace ) ) {111			$cockney        = array_keys( $wp_cockneyreplace );112			$cockneyreplace = array_values( $wp_cockneyreplace );113		} else {114			/*115			 * translators: This is a comma-separated list of words that defy the syntax of quotations in normal use,116			 * for example... 'We do not have enough words yet'... is a typical quoted phrase. But when we write

History

Introduced in 0.71. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.8.8 tag, from src/wp-includes/formatting.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.