spatie/emoji

Display emoji characters

2.1.1 2019-03-22 08:34 UTC

README

Latest Version on Packagist Software License Build Status Quality Score StyleCI Total Downloads

In PHP you can display emoji characters just by typing them:

echo "😃";

This package provides some functionality to work with emoji's if your IDE or used font can't render them correctly:

Emoji::grinningFace();

Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.

Postcardware

You're free to use this package (it's MIT-licensed), but if it makes it to your production environment you are required to send us a postcard from your hometown, mentioning which of our package(s) you are using.

Our address is: Spatie, Samberstraat 69D, 2060 Antwerp, Belgium.

The best postcards will get published on the open source page on our website.

Install

You can install the package via composer:

composer require spatie/emoji

Usage

The Spatie\Emoji\Emoji-class contains character constants that may be used directly:

Emoji::CHARACTER_GRINNING_FACE;

Or your can use the shorter method by leaving off "character" and using camelCase:

Emoji::grinningFace();

You can also use an ISO 3166 Alpha2 country code and get the appropriate flag for the country:

Emoji::countryFlag('be'); // 🇧🇪

This package contains Full Emoji List v11.0 (emoji without skin-tones) based on https://www.unicode.org/emoji/charts/full-emoji-list.html (retrieval date: 2018-10-16) which include Full Emoji Modifier Sequences v11.0 (emoji with skin-tones) based on https://www.unicode.org/emoji/charts/full-emoji-modifiers.html (retrieval date: 2018-10-16)

Changelog

Please see CHANGELOG for more information what has changed recently.

Testing

$ composer test

Contributing

We are accepting PR's that add characters to the class. Please use this list to look up the unicode value and the name of the character.

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email freek@spatie.be instead of using the issue tracker.

Credits

About Spatie

Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.

License

The MIT License (MIT). Please see License File for more information.