When you need to extract one or more user-perceived characters, it helps to understand both the normal result and what changes with different inputs. This guide focuses on practical examples rather than repeating PHP background material.
grapheme_extract provides the behavior described below. A grapheme cluster is a user-perceived character, potentially consisting of more than one Unicode code point.
What Is grapheme_extract in PHP?
Extract one or more user-perceived characters. A grapheme cluster is a user-perceived character, potentially consisting of more than one Unicode code point.
Its syntax is:
grapheme_extract(...)
Parameters and return value: Read the argument names and optional values in the signature above. Methods use an existing object, while stand-alone functions take direct arguments. The examples demonstrate the relevant arguments and the value returned or the object modified.
Important: The start offset uses bytes, even when the extracted length is measured in grapheme clusters; an invalid offset can fail.
Example 1: Basic Usage
This first example demonstrates how to extract one or more user-perceived characters with a small input.
<?php
var_dump(grapheme_extract("café", 2));
The example uses the simplest useful form. A grapheme cluster is a user-perceived character, potentially consisting of more than one Unicode code point. The output may depend on the active ICU locale, PHP configuration, or input supplied to the function.
Example 2: Another Case
Here the input or option changes, making it easier to see where the behavior differs. The start offset uses bytes, even when the extracted length is measured in grapheme clusters; an invalid offset can fail.
<?php
var_dump(grapheme_extract("A🙂B", 1, GRAPHEME_EXTR_COUNT, 1));
Compare the result to the first example. Use strlen() for bytes, mb_* for code points and grapheme_* for grapheme clusters.
Practical Example: Applying the Function
This standalone example shows how the same operation fits into a small application task. The intl extension is required for this example.
<?php
$text = "Résumé";
$segment = grapheme_extract($text, 3);
echo $segment;
The example keeps the operation visible and gives you a starting point for using it in an application. The start offset uses bytes, even when the extracted length is measured in grapheme clusters; an invalid offset can fail.
Important Behavior and Edge Cases
- Core behavior: A grapheme cluster is a user-perceived character, potentially consisting of more than one Unicode code point.
- Return value: Check the result separately from changes to passed-in arrays, iterators, or object state.
- Data constraints: The start offset uses bytes, even when the extracted length is measured in grapheme clusters; an invalid offset can fail.
- Environment: The intl extension is required for this example.
Comparison With Related Functions
| Function or Approach | When to Use It |
|---|---|
grapheme_extract | Extract one or more user-perceived characters. |
| Related PHP APIs | Use strlen() for bytes, mb_* for code points and grapheme_* for grapheme clusters. |
Common Beginner Mistakes
| Mistake | Correct Approach |
|---|---|
| Assuming the function works on every kind of input | Follow the declared argument types and check the input format before calling it. |
| Ignoring the behavior of the result | The start offset uses bytes, even when the extracted length is measured in grapheme clusters; an invalid offset can fail. |
| Using the wrong related PHP API | Use strlen() for bytes, mb_* for code points and grapheme_* for grapheme clusters. |
Key Takeaways
grapheme_extracthelps you extract one or more user-perceived characters.- A grapheme cluster is a user-perceived character, potentially consisting of more than one Unicode code point.
- The start offset uses bytes, even when the extracted length is measured in grapheme clusters; an invalid offset can fail.
- Use strlen() for bytes, mb_* for code points and grapheme_* for grapheme clusters.
grapheme_extract is useful when you need to extract one or more user-perceived characters. Start with the small examples, then adapt the practical example while respecting its input and environment requirements.