WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

wp_encode_emoji()

wp_encode_emoji( string $content ): string

In this article

Back to top

Converts emoji characters to their equivalent HTML entity.

Description

This allows us to store emoji in a DB using the utf8 character set.

Parameters

$contentstringrequired
The content to encode.

Return

string The encoded content.

Source

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;
}

View all references View on Trac View on GitHub

UsesDescription
_wp_emoji_list()wp-includes/formatting.php

Returns arrays of emoji data.

Used byDescription
wp_staticize_emoji()wp-includes/formatting.php

Converts emoji to a static img element.

sanitize_option()wp-includes/formatting.php

Sanitizes various option values based on the nature of the option.

wp_insert_post()wp-includes/post.php

Inserts or update a post.

Changelog

VersionDescription
4.2.0Introduced.

User Contributed Notes

  1. Skip to note 2 content
    Mehbub Rashid
    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note

    You can also pass text with emoji.
    You will not see any difference in output even after you use wp_encode_emoji(). Because the browser will still display the html encoded version as emoji. To see the difference, you need to View page source.

    print_r(' This is a text with emoji 🎃' ); // This is a text with emoji 🎃
print_r( wp_encode_emoji( 'This is a text with emoji 🎃' ) ); // This is a text with emoji 🎃

    To convert the html encoded version back to the unicode emoji, use html_entity_decode().

    $html_encoded = wp_encode_emoji( '🎃' );
$html_decoded = html_entity_decode( $html_encoded );

You must log in before being able to contribute a note or feedback.