PHP ReflectionParameter::getPosition() Method: Usage and Examples

When building tools that inspect PHP code, ReflectionParameter::getPosition() helps answer a focused question: returns a parameter's zero-based position in the signature.

Reflection is useful in framework tooling, dependency injection, testing, code inspection and debugging.

What Is ReflectionParameter::getPosition()?

Returns a parameter's zero-based position in the signature.

Its method signature is:

public function getPosition(): int

This method has no required arguments.

Return value: int

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->getPosition();
var_dump($result);

Output:

int(0)

Explanation: Returns a parameter's zero-based position in the signature.

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->getPosition();
var_dump($result);

// Check the returned value type before using the result.
echo "\nResult type: " . get_debug_type($result);

Output:

int(1)

Result type: int

Explanation: Position is distinct from its name for named arguments.

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->getPosition();
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:

int(2)

Reflection result available

Explanation: getName returns the identifier.

Important Behavior and Edge Cases

• Position is distinct from its name for named arguments.
• getName returns the identifier.
• Reflection describes declarations and runtime state; requesting metadata does not automatically validate or sanitize application input.

Comparison With Related Approaches

Common Beginner Mistakes

Key Takeaways

• Returns a parameter's zero-based position in the signature.
• Position is distinct from its name for named arguments.
• getName returns the identifier.

Use ReflectionParameter::getPosition() when you need the precise metadata or behavior demonstrated above. Keep the target declaration and relevant PHP version in mind when adapting the examples.