When building tools that inspect PHP code, ReflectionProperty::getAttributes() helps answer a focused question: returns reflection attributes declared on a class property.
Reflection is useful in framework tooling, dependency injection, testing, code inspection and debugging.
What Is ReflectionProperty::getAttributes()?
Returns reflection attributes declared on a class property.
Its method signature is:
public function getAttributes(?string $name = ..., int $flags = ...): array
Parameters:
$name— Name of the method, case, property, constant, extension, or parameter being requested May be omitted.$flags— Filtering behavior such as ReflectionAttribute::IS_INSTANCEOF May be omitted.
Return value: array
Example 1: Inspect a property declaration
Start with a self-contained PHP declaration and inspect the method result.
<?php
declare(strict_types=1);
#[Attribute(Attribute::TARGET_PROPERTY)]
class FieldLabel { public function __construct(public string $label) {} }
class BaseData { protected string $source = 'local'; }
class CustomerData extends BaseData {
#[FieldLabel('identity')]
public string $name = 'Morgan';
public private(set) string $token = 'abc';
public protected(set) int $level = 1;
public readonly int $identifier;
public static int $counter = 3;
public string $label { get => strtoupper($this->name); }
public string $initials { get => substr($this->name, 0, 1); }
final public string $finalLabel { get => $this->name; }
public int $delayed;
public function __construct(public string $city = 'Rome') { $this->identifier = 10; }
}
$propertyReflection = new ReflectionProperty(CustomerData::class, "name");
$result = $propertyReflection->getAttributes();
echo count($result);
Output:
1
Explanation: Returns reflection attributes declared on a class property.
Example 2: Explore another property context
Next, change the reflected declaration or parameter to observe a related situation.
<?php
declare(strict_types=1);
#[Attribute(Attribute::TARGET_PROPERTY)]
class FieldLabel { public function __construct(public string $label) {} }
class BaseData { protected string $source = 'local'; }
class CustomerData extends BaseData {
#[FieldLabel('identity')]
public string $name = 'Morgan';
public private(set) string $token = 'abc';
public protected(set) int $level = 1;
public readonly int $identifier;
public static int $counter = 3;
public string $label { get => strtoupper($this->name); }
public string $initials { get => substr($this->name, 0, 1); }
final public string $finalLabel { get => $this->name; }
public int $delayed;
public function __construct(public string $city = 'Rome') { $this->identifier = 10; }
}
$propertyReflection = new ReflectionProperty(CustomerData::class, "city");
$result = $propertyReflection->getAttributes();
echo count($result);
// Check the returned value type before using the result.
echo "\nResult type: " . get_debug_type($result);
Output:
0
Result type: array
Explanation: Property-level attributes are separate from class and parameter attributes.
Practical Example: Apply reflection to a data model
This final case shows how the same API can be used when inspecting application definitions.
<?php
declare(strict_types=1);
#[Attribute(Attribute::TARGET_PROPERTY)]
class FieldLabel { public function __construct(public string $label) {} }
class BaseData { protected string $source = 'local'; }
class CustomerData extends BaseData {
#[FieldLabel('identity')]
public string $name = 'Morgan';
public private(set) string $token = 'abc';
public protected(set) int $level = 1;
public readonly int $identifier;
public static int $counter = 3;
public string $label { get => strtoupper($this->name); }
public string $initials { get => substr($this->name, 0, 1); }
final public string $finalLabel { get => $this->name; }
public int $delayed;
public function __construct(public string $city = 'Rome') { $this->identifier = 10; }
}
$propertyReflection = new ReflectionProperty(CustomerData::class, "token");
$result = $propertyReflection->getAttributes();
echo count($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:
0
Entries: 0
Explanation: ReflectionClass::getAttributes reads class-level annotations.
Important Behavior and Edge Cases
- Property-level attributes are separate from class and parameter attributes.
- ReflectionClass::getAttributes reads class-level annotations.
- 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 |
|---|---|
ReflectionProperty::getAttributes() | Returns reflection attributes declared on a class property. |
Related API | ReflectionClass::getAttributes reads class-level annotations. |
Common Beginner Mistakes
| Mistake | Correct Approach |
|---|---|
| Ignoring this condition: Property-level attributes are separate from class and parameter attributes. | Handle the specific limitation: Property-level attributes are separate from class and parameter attributes. |
| Confusing this method with Related API | ReflectionClass::getAttributes reads class-level annotations. |
Key Takeaways
- Returns reflection attributes declared on a class property.
- Property-level attributes are separate from class and parameter attributes.
- ReflectionClass::getAttributes reads class-level annotations.
Use ReflectionProperty::getAttributes() when you need the precise metadata or behavior demonstrated above. Keep the target declaration and relevant PHP version in mind when adapting the examples.