wp_encode_emoji( string $content ): string
- Since
- 4.2.0
- Source
wp-includes/formatting.php:5961
Description
This allows us to store emoji in a DB using the utf8 character set.
Compatibility
- WordPress
- since 4.2.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$contentstring- The content to encode.
Return value
string- The encoded content.
Performance profile
How much work a call to wp_encode_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
- Scaling
- Scales with input
- Instructions
- 8–9
- Plugin surface
- None
- Called by
- 3
Touches nothing outside its own arguments.
The body loops, so the work grows with what you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 22.
Nothing here hands control to plugin code.
3 places in core call this, so the cost is paid more often than your own code shows.
What one call costs · 1 distinct outcome
One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_encode_emoji() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 8–9 | _wp_emoji_list() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 22 | 8–9 | 3 | |
| 8.5 | 22 | 8–9 | 3 | |
| 8.4 | 22 | 8–9 | 3 | 6 fewer instructions than PHP 8.3 |
| 8.3 | 28 | 8–9 | 3 | |
| 8.2 | 28 | 8–9 | 3 | |
| 8.1 | 28 | 8–9 | 3 | |
| 7.4 | 28 | 8–9 | 3 |
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Uses · 2
- _wp_emoji_list()Returns arrays of emoji data.
- str_contains()Polyfill for `str_contains()` function added in PHP 8.0.
Used by · 3
- sanitize_option()Sanitizes various option values based on the nature of the option.
- wp_insert_post()Inserts or update a post.
- wp_staticize_emoji()Converts emoji to a static img element.
Source code
function wp_encode_emoji( $content ) { $emoji = _wp_emoji_list( 'partials' ); foreach ( $emoji as $emojum ) { $emoji_char = html_entity_decode( $emojum ); if ( str_contains( $content, $emoji_char ) ) { $content = preg_replace( "/$emoji_char/", $emojum, $content ); } } return $content;}Changelog
Introduced in 4.2.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 6.7.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.