spatie/emoji

Display emoji characters

Programatically work with emoji characters

, _(*1)

In PHP, you can display emoji characters just by typing them:, _(*2)

echo "😃";

This package provides some functionality to work with emojis if your IDE or used font can't render them correctly:, _(*3)

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., _(*4)

Support us

, _(*5)

We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products., _(*6)

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall., _(*7)

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., _(*8)

Our address is: Spatie, Kruikstraat 22, 2018 Antwerp, Belgium., _(*9)

The best postcards will get published on the open source page on our website., _(*10)

Install

You can install the package via composer: ``` bash composer require spatie/emoji, _(*11)

## Usage

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

```php
Emoji::CHARACTER_GRINNING_FACE;

Or you can use the shorter method by leaving off "character" and using camelCase:, _(*12)

Emoji::grinningFace();

If you want to get an array containing all emojis, you can use this method:, _(*13)

Emoji::all();
 ```

You can also use an [ISO 3166 Alpha2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code and get the appropriate flag for the country:
```php
Emoji::countryFlag('be'); // 🇧🇪

This package contains Full Emoji List v13.1 based on https://unicode.org/Public/emoji/13.1/emoji-test.txt all methods and constants are auto-generated., _(*14)

Changelog

Please see CHANGELOG for more information what has changed recently., _(*15)

Testing

bash $ composer test, _(*16)

Contributing

We are accepting PRs that add characters to the class. Please use this list to look up the unicode value and the name of the character., _(*17)

Please see CONTRIBUTING for details., _(*18)

Security

If you've found a bug regarding security please mail security@spatie.be instead of using the issue tracker., _(*19)

Credits

• Freek Van der Herten
• BoGnY
• All Contributors

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., _(*20)

License

The MIT License (MIT). Please see License File for more information., _(*21)