Creates a weak reference to an object without extending its lifetime.
The examples focus on the operation itself, including the important distinction: get tries to obtain the object later.
What It Does
Use the examples below to observe the behavior on a small dataset before extending it to application code.
Syntax and Return Value
WeakReference::create(object $object): WeakReference
The displayed signature describes the API or identifies any correction or optional dependency. When a parameter is optional, supply it only when the task requires it.
Parameters
- object: required.
Declared return type: WeakReference. Read the behavior notes for important cases such as empty collections and destructive iteration.
Example 1: Basic Use
A weak reference does not own the object; the second example releases the only strong reference explicitly.
<?php
$resource = new stdClass();
$resource->name = 'draft';
$ref = WeakReference::create($resource);
echo $ref->get()?->name ?? "collected";
Output from a successful local PHP 8.4 run:
draft
Example 2: Checking Behavior
A weak reference does not own the object; the second example releases the only strong reference explicitly.
<?php
$resource = new stdClass();
$resource->name = 'receipt';
$ref = WeakReference::create($resource);
echo $ref->get()?->name ?? "collected";
Output from a successful local PHP 8.4 run:
receipt
Example 3: Practical Example
A weak reference does not own the object; the second example releases the only strong reference explicitly.
<?php
$resource = new stdClass();
$resource->name = 'cache';
$ref = WeakReference::create($resource);
echo $ref->get()?->name ?? "collected";
Output from a successful local PHP 8.4 run:
cache
Important Behavior and Edge Cases
The referenced object can be collected when no strong reference remains.
Comparison with Related Approaches
| Approach | Difference |
|---|---|
| WeakReference::create | Creates a weak reference to an object without extending its lifetime. |
| Related API or alternative | get tries to obtain the object later. |
Common Beginner Mistakes
| Mistake | Correct approach |
|---|---|
| Ignoring the operation-specific limits | The referenced object can be collected when no strong reference remains. |
| Confusing it with a related API | get tries to obtain the object later. |
Key Takeaways
- Creates a weak reference to an object without extending its lifetime.
- The referenced object can be collected when no strong reference remains.
- get tries to obtain the object later.
Use WeakReference::create when its documented behavior matches the problem. Test the relevant edge cases in your own runtime before deploying it.