When building tools that inspect PHP code, ReflectionExtension::getName() helps answer a focused question: returns the canonical name of the loaded extension.
Reflection is useful in framework tooling, dependency injection, testing, code inspection and debugging.
What Is ReflectionExtension::getName()?
Returns the canonical name of the loaded extension.
Its method signature is:
public function getName(): string
This method has no required arguments.
Return value: string
Example 1: Inspect a loaded extension
Start with a self-contained PHP declaration and inspect the method result.
<?php
declare(strict_types=1);
$extensionReflection = new ReflectionExtension("json");
$result = $extensionReflection->getName();
var_dump($result);
Output:
string(4) "json"
Explanation: Returns the canonical name of the loaded extension.
Example 2: Compare extension metadata
Next, change the reflected declaration or parameter to observe a related situation.
<?php
declare(strict_types=1);
$extensionReflection = new ReflectionExtension("date");
$result = $extensionReflection->getName();
var_dump($result);
// Check the returned value type before using the result.
echo "\nResult type: " . get_debug_type($result);
Output:
string(4) "date"
Result type: string
Explanation: The runtime must actually have the extension loaded.
Practical Example: Use extension information for diagnostics
This final case shows how the same API can be used when inspecting application definitions.
<?php
declare(strict_types=1);
$extensionReflection = new ReflectionExtension("standard");
$result = $extensionReflection->getName();
var_dump($result);
// Use the reflection result in a simple decision.
if (is_bool($result)) {
echo "\nStatus: " . ($result ? "yes" : "no");
} elseif (is_array($result)) {
echo "\nEntries: " . count($result);
} elseif ($result === null) {
echo "\nNo value returned";
} else {
echo "\nReflection result available";
}
Output:
string(8) "standard"
Reflection result available
Explanation: extension_loaded checks availability without constructing a reflection object.
Important Behavior and Edge Cases
- The runtime must actually have the extension loaded.
- extension_loaded checks availability without constructing a reflection object.
- Reflection describes declarations and runtime state; requesting metadata does not automatically validate or sanitize application input.
Comparison With Related Approaches
| Approach | When to Use It |
|---|---|
ReflectionExtension::getName() | Returns the canonical name of the loaded extension. |
Related API | extension_loaded checks availability without constructing a reflection object. |
Common Beginner Mistakes
| Mistake | Correct Approach |
|---|---|
| Ignoring this condition: The runtime must actually have the extension loaded. | Handle the specific limitation: The runtime must actually have the extension loaded. |
| Confusing this method with Related API | extension_loaded checks availability without constructing a reflection object. |
Key Takeaways
- Returns the canonical name of the loaded extension.
- The runtime must actually have the extension loaded.
- extension_loaded checks availability without constructing a reflection object.
Use ReflectionExtension::getName() when you need the precise metadata or behavior demonstrated above. Keep the target declaration and relevant PHP version in mind when adapting the examples.