When building tools that inspect PHP code, ReflectionParameter::getName() helps answer a focused question: returns the parameter identifier without its dollar sign.
Reflection is useful in framework tooling, dependency injection, testing, code inspection and debugging.
What Is ReflectionParameter::getName()?
Returns the parameter identifier without its dollar sign.
Its method signature is:
public function getName(): string
This method has no required arguments.
Return value: string
Example 1: Inspect a formal parameter
Start with a self-contained PHP declaration and inspect the method result.
<?php
declare(strict_types=1);
#[Attribute(Attribute::TARGET_PARAMETER)]
class Validated { public function __construct(public string $rule) {} }
function submitOrder(#[Validated('positive')] int $quantity, string $currency = 'USD', ?string $note = null): void {}
function updateCounter(int &$total): void { $total++; }
function collectNames(string ...$names): void {}
class OrderRequest { public function __construct(public readonly int $identifier, public string $label = 'New') {} }
$functionReflection = new ReflectionFunction("submitOrder");
$parameterReflection = $functionReflection->getParameters()[0];
$result = $parameterReflection->getName();
var_dump($result);
Output:
string(8) "quantity"
Explanation: Returns the parameter identifier without its dollar sign.
Example 2: Compare another parameter position
Next, change the reflected declaration or parameter to observe a related situation.
<?php
declare(strict_types=1);
#[Attribute(Attribute::TARGET_PARAMETER)]
class Validated { public function __construct(public string $rule) {} }
function submitOrder(#[Validated('positive')] int $quantity, string $currency = 'USD', ?string $note = null): void {}
function updateCounter(int &$total): void { $total++; }
function collectNames(string ...$names): void {}
class OrderRequest { public function __construct(public readonly int $identifier, public string $label = 'New') {} }
$functionReflection = new ReflectionFunction("submitOrder");
$parameterReflection = $functionReflection->getParameters()[1];
$result = $parameterReflection->getName();
var_dump($result);
// Check the returned value type before using the result.
echo "\nResult type: " . get_debug_type($result);
Output:
string(8) "currency"
Result type: string
Explanation: Renaming a parameter can affect named-argument callers.
Practical Example: Check a signature before building a call
This final case shows how the same API can be used when inspecting application definitions.
<?php
declare(strict_types=1);
#[Attribute(Attribute::TARGET_PARAMETER)]
class Validated { public function __construct(public string $rule) {} }
function submitOrder(#[Validated('positive')] int $quantity, string $currency = 'USD', ?string $note = null): void {}
function updateCounter(int &$total): void { $total++; }
function collectNames(string ...$names): void {}
class OrderRequest { public function __construct(public readonly int $identifier, public string $label = 'New') {} }
$functionReflection = new ReflectionFunction("submitOrder");
$parameterReflection = $functionReflection->getParameters()[2];
$result = $parameterReflection->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(4) "note"
Reflection result available
Explanation: getPosition returns its zero-based index.
Important Behavior and Edge Cases
- Renaming a parameter can affect named-argument callers.
- getPosition returns its zero-based index.
- 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 |
|---|---|
ReflectionParameter::getName() | Returns the parameter identifier without its dollar sign. |
Related API | getPosition returns its zero-based index. |
Common Beginner Mistakes
| Mistake | Correct Approach |
|---|---|
| Ignoring this condition: Renaming a parameter can affect named-argument callers. | Handle the specific limitation: Renaming a parameter can affect named-argument callers. |
| Confusing this method with Related API | getPosition returns its zero-based index. |
Key Takeaways
- Returns the parameter identifier without its dollar sign.
- Renaming a parameter can affect named-argument callers.
- getPosition returns its zero-based index.
Use ReflectionParameter::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.