PHPackages                             p3k/emoji-detector - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. p3k/emoji-detector

ActiveLibrary[Utility & Helpers](/categories/utility)

p3k/emoji-detector
==================

Detect and return all emoji found in a string

1.2.0(2y ago)1471.7M—8.5%38[1 PRs](https://github.com/aaronpk/emoji-detector-php/pulls)5MITPHPPHP >=7.4

Since Feb 18Pushed 2y ago6 watchersCompare

[ Source](https://github.com/aaronpk/emoji-detector-php)[ Packagist](https://packagist.org/packages/p3k/emoji-detector)[ Docs](https://github.com/aaronpk/emoji-detector-php)[ RSS](/packages/p3k-emoji-detector/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (5)Dependencies (1)Versions (9)Used By (5)

Emoji Detection
===============

[](#emoji-detection)

This library will find all emoji in an input string and return information about each emoji character. It supports emoji with skin tone modifiers, as well as the composite emoji that are made up of multiple people.

The current version supports Emoji version 15.1 (Sept 2023)

You can see a catalog of the emoji data here:

-
-

Installation
------------

[](#installation)

```
composer require p3k/emoji-detector

```

Or include `src/Emoji.php` in your project, and make sure the `map.json` and `regexp.json` files are available in the same folder as `Emoji.php`. You don't need any of the other files for use in your own projects.

Usage
-----

[](#usage)

### Detect Emoji

[](#detect-emoji)

```
$input = "Hello 👍🏼 World 👨‍👩‍👦‍👦";
$emoji = Emoji\detect_emoji($input);

print_r($emoji);
```

The function returns an array with details about each emoji found in the string.

```
Array
(
    [0] => Array
        (
            [emoji] => 👍🏼
            [short_name] => +1
            [num_points] => 2
            [points_hex] => Array
                (
                    [0] => 1F44D
                    [1] => 1F3FC
                )
            [hex_str] => 1F44D-1F3FC
            [skin_tone] => skin-tone-3
            [byte_offset] => 6
            [grapheme_offset] => 6
        )
    [1] => Array
        (
            [emoji] => 👨‍👩‍👦‍👦
            [short_name] => man-woman-boy-boy
            [num_points] => 7
            [points_hex] => Array
                (
                    [0] => 1F468
                    [1] => 200D
                    [2] => 1F469
                    [3] => 200D
                    [4] => 1F466
                    [5] => 200D
                    [6] => 1F466
                )
            [hex_str] => 1F468-200D-1F469-200D-1F466-200D-1F466
            [skin_tone] =>
            [byte_offset] => 21
            [grapheme_offset] => 14
        )
)

```

- `emoji` - The emoji sequence found, as the original byte sequence. You can output this to show the original emoji.
- `short_name` - The short name of the emoji, as defined by [Slack's emoji data](https://github.com/iamcal/emoji-data).
- `num_points` - The number of unicode code points that this emoji is composed of.
- `points_hex` - An array of each unicode code point that makes up this emoji. These are returned as hex strings. This will also include "invisible" characters such as the ZWJ character and skin tone modifiers.
- `hex_str` - A list of all unicode code points in their hex form separated by hyphens. This string is present in the [Slack emoji data](https://github.com/iamcal/emoji-data) array.
- `skin_tone` - If a skin tone modifier was used in the emoji, this field indicates which skin tone, since the `short_name` will not include the skin tone.
- `byte_offset` - The position of the emoji in the string in bytes, used with the plain `str*` functions
- `grapheme_offset` - The position of the emoji in the string, counting each emoji as 1 char, used with the `grapheme_*` functions

You can use the `grapheme_*` functions to extract parts of the string using the `grapheme_offset` position returned. For example:

```
$string = "Trešnja 🍒";
$emoji = Emoji\detect_emoji($string);
echo '.'.grapheme_substr($string, 0, $emoji[0]['grapheme_offset']).".\n";
echo '.'.substr($string, 0, $emoji[0]['byte_offset']).".\n";
// Both output ".Trešnja ."
```

#### Replace emoji with string representations

[](#replace-emoji-with-string-representations)

```
$string = Emoji\replace_emoji('I like 🌮 and 🌯', ':', ':');
echo $string;
// I like :taco: and :burrito:
```

### Test if a string is a single emoji

[](#test-if-a-string-is-a-single-emoji)

Since simply counting the number of unicode characters in a string does not tell you how many visible emoji are in the string, determining whether a single character is an emoji is more involved. This function will return the emoji data only if the string contains a single emoji character, and false otherwise.

```
$emoji = Emoji\is_single_emoji('👨‍👩‍👦‍👦');
print_r($emoji);
```

```
Array
(
    [emoji] => 👨‍👩‍👦‍👦
    [short_name] => man-woman-boy-boy
    [num_points] => 7
    [points_hex] => Array
        (
            [0] => 1F468
            [1] => 200D
            [2] => 1F469
            [3] => 200D
            [4] => 1F466
            [5] => 200D
            [6] => 1F466
        )

    [hex_str] => 1F468-200D-1F469-200D-1F466-200D-1F466
    [skin_tone] =>
    [byte_offset] => 0
    [grapheme_offset] => 0
)

```

```
$emoji = Emoji\is_single_emoji('😻🐈');
// false
```

### Remove emoji from a string

[](#remove-emoji-from-a-string)

You can remove all emoji from a string with this function, optionally removing trailing spaces.

```
$string = "I like 🌮 and 🌯";
echo Emoji\remove_emoji($string);
// "I like  and "
echo Emoji\remove_emoji($string, ['collapse' => true]);
// "I like and";
```

Updates
-------

[](#updates)

When a new emoji set is released, this library will need to be updated with the new unicode points and names. The source of the emoji data is [iamcal/emoji-data](https://github.com/iamcal/emoji-data), so first check there for the latest updates. You can build the new source files this library uses with the following command:

```
composer build

```

Tests
-----

[](#tests)

A comprehensive set of tests is available to ensure things are working as expected, including tests for the new emoji added in new emoji versions. You can run the tests with the following command:

```
composer test

```

License
-------

[](#license)

Made with ❤️ by Aaron Parecki.

Copyright 2017-2024 by Aaron Parecki. Available under the MIT license.

Emoji data sourced from [iamcal/emoji-data](https://github.com/iamcal/emoji-data) under the MIT license.

Emoji parsing regex sourced from [EmojiOne](https://github.com/Ranks/emojione) under the MIT license.

###  Health Score

47

—

FairBetter than 94% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity58

Moderate usage in the ecosystem

Community29

Small or concentrated contributor base

Maturity68

Established project with proven stability

 Bus Factor1

Top contributor holds 78% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~365 days

Recently: every ~226 days

Total

8

Last Release

819d ago

Major Versions

0.3.1 → 1.0.02022-08-30

PHP version history (4 changes)0.1.0PHP >=5.6

0.2.1PHP >=5.3

0.3.0PHP >=7.2

1.2.0PHP >=7.4

### Community

Maintainers

![](https://www.gravatar.com/avatar/385b302aef27e9e72ddfbf65c8b15cfce5946744fe2e541c5b415665fc2351fc?d=identicon)[aaronpk](/maintainers/aaronpk)

---

Top Contributors

[![aaronpk](https://avatars.githubusercontent.com/u/113001?v=4)](https://github.com/aaronpk "aaronpk (71 commits)")[![dmongeau](https://avatars.githubusercontent.com/u/124966?v=4)](https://github.com/dmongeau "dmongeau (8 commits)")[![peter279k](https://avatars.githubusercontent.com/u/9021747?v=4)](https://github.com/peter279k "peter279k (3 commits)")[![sebsel](https://avatars.githubusercontent.com/u/16517999?v=4)](https://github.com/sebsel "sebsel (3 commits)")[![aksafan](https://avatars.githubusercontent.com/u/14964793?v=4)](https://github.com/aksafan "aksafan (2 commits)")[![twofed1](https://avatars.githubusercontent.com/u/35243523?v=4)](https://github.com/twofed1 "twofed1 (2 commits)")[![Zegnat](https://avatars.githubusercontent.com/u/490579?v=4)](https://github.com/Zegnat "Zegnat (1 commits)")[![intoeetive](https://avatars.githubusercontent.com/u/752126?v=4)](https://github.com/intoeetive "intoeetive (1 commits)")

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/p3k-emoji-detector/health.svg)

```
[![Health](https://phpackages.com/badges/p3k-emoji-detector/health.svg)](https://phpackages.com/packages/p3k-emoji-detector)
```

###  Alternatives

[jawira/case-converter

Convert strings between 13 naming conventions: Snake case, Camel case, Pascal case, Kebab case, Ada case, Train case, Cobol case, Macro case, Upper case, Lower case, Sentence case, Title case and Dot notation.

1746.9M79](/packages/jawira-case-converter)[awcodes/drop-in-action

A form component for Filamentphp allowing actions inside of forms.

8656.0k](/packages/awcodes-drop-in-action)[hubertusanton/silverstripe-seo

SEO module for Silverstripe

4823.0k2](/packages/hubertusanton-silverstripe-seo)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)