wp_staticize_emoji( string $text ): string

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$textstring

The content to encode.

Return value

string

The encoded content.

Performance profile

How much work a call to wp_staticize_emoji() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

9–54

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 120.

Plugin surface

2 hooks

Third-party callbacks on 'emoji_url', 'emoji_ext' run inside this call, and their cost is not bounded by anything here.

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly
• regexregular expression over the whole inputpreg_split()called directly

What one call costs · 6 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_staticize_emoji() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 2

2 hooks fire while wp_staticize_emoji() runs, in this order:

1. 1
   apply_filters( emoji_url )filterline 6067 (+30 into the body)

   Filters the URL where emoji png images are hosted.

2. 2
   apply_filters( emoji_ext )filterline 6070 (+33 into the body)

   Filters the extension of the emoji png files.

Uses · 4

• str_contains()Polyfill for `str_contains()` function added in PHP 8.0.
• wp_encode_emoji()Converts emoji characters to their equivalent HTML entity.
• _wp_emoji_list()Returns arrays of emoji data.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 1

• wp_staticize_emoji_for_email()Converts emoji in emails into static images.

Source code

View on Trac ↗View on GitHub ↗

6037function wp_staticize_emoji( $text ) {6038	if ( ! str_contains( $text, '&#x' ) ) {6039		if ( ( function_exists( 'mb_check_encoding' ) && mb_check_encoding( $text, 'ASCII' ) ) || ! preg_match( '/[^\x00-\x7F]/', $text ) ) {6040			// The text doesn't contain anything that might be emoji, so we can return early.6041			return $text;6042		} else {6043			$encoded_text = wp_encode_emoji( $text );6044			if ( $encoded_text === $text ) {6045				return $encoded_text;6046			}6047 6048			$text = $encoded_text;6049		}6050	}6051 6052	$emoji = _wp_emoji_list( 'entities' );6053 6054	// Quickly narrow down the list of emoji that might be in the text and need replacing.6055	$possible_emoji = array();6056	foreach ( $emoji as $emojum ) {6057		if ( str_contains( $text, $emojum ) ) {6058			$possible_emoji[ $emojum ] = html_entity_decode( $emojum );6059		}6060	}6061 6062	if ( ! $possible_emoji ) {6063		return $text;6064	}6065 6066	/** This filter is documented in wp-includes/formatting.php */6067	$cdn_url = apply_filters( 'emoji_url', 'https://s.w.org/images/core/emoji/17.0.2/72x72/' );6068 6069	/** This filter is documented in wp-includes/formatting.php */6070	$ext = apply_filters( 'emoji_ext', '.png' );6071 6072	$output = '';6073	/*6074	 * HTML loop taken from smiley function, which was taken from texturize function.6075	 * It'll never be consolidated.6076	 *6077	 * First, capture the tags as well as in between.6078	 */6079	$textarr = preg_split( '/(<.*>)/U', $text, -1, PREG_SPLIT_DELIM_CAPTURE );6080	$stop    = count( $textarr );6081 6082	// Ignore processing of specific tags.6083	$tags_to_ignore       = 'code|pre|style|script|textarea';6084	$ignore_block_element = '';6085 6086	for ( $i = 0; $i < $stop; $i++ ) {6087		$content = $textarr[ $i ];6088 6089		// If we're in an ignore block, wait until we find its closing tag.6090		if ( '' === $ignore_block_element && preg_match( '/^<(' . $tags_to_ignore . ')>/', $content, $matches ) ) {6091			$ignore_block_element = $matches[1];6092		}6093 6094		// If it's not a tag and not in ignore block.6095		if ( '' === $ignore_block_element && strlen( $content ) > 0 && '<' !== $content[0] && str_contains( $content, '&#x' ) ) {6096			foreach ( $possible_emoji as $emojum => $emoji_char ) {6097				if ( ! str_contains( $content, $emojum ) ) {6098					continue;6099				}6100 6101				$file = str_replace( ';&#x', '-', $emojum );6102				$file = str_replace( array( '&#x', ';' ), '', $file );6103 6104				$entity = sprintf( '<img src="%s" alt="%s" class="wp-smiley" style="height: 1em; max-height: 1em;" />', $cdn_url . $file . $ext, $emoji_char );6105 6106				$content = str_replace( $emojum, $entity, $content );6107			}6108		}6109 6110		// Did we exit ignore block?6111		if ( '' !== $ignore_block_element && '</' . $ignore_block_element . '>' === $content ) {6112			$ignore_block_element = '';6113		}6114 6115		$output .= $content;6116	}

Changelog

Introduced in 4.2.0. 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.9.7 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.