Thanks to visit codestin.com
Credit goes to github.com

Skip to content

#64896 Tighten the documented types in WP_Hook #12441

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
johnbillion wants to merge 3 commits into
base: trunk
Choose a base branch
from
+29 −15
Open

#64896 Tighten the documented types in WP_Hook #12441

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
49e7f6f
Tighten the documented types in `WP_Hook`.
johnbillion Jul 7, 2026
6e10867
Naming.
johnbillion Jul 7, 2026
67f3a9b
Document the `Iterator`/`ArrayAccess` generics and tighten the offset…
westonruter Jul 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 29 additions & 15 deletions src/wp-includes/class-wp-hook.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,39 +14,48 @@
*
* @see Iterator
* @see ArrayAccess
*
* @phpstan-type Hook_Callback array{
* function: callable,
* accepted_args: int,
* }
*
* @phpstan-implements Iterator<int, array<string, Hook_Callback>>
* @phpstan-implements ArrayAccess<int, array<string, Hook_Callback>>
*/
#[AllowDynamicProperties]
final class WP_Hook implements Iterator, ArrayAccess {

/**
* Hook callbacks.
* Hook callbacks keyed by priority.
*
* @since 4.7.0
* @var array
* @phpstan-var array<int, array<string, Hook_Callback>>
*/
public $callbacks = array();

/**
* Priorities list.
*
* @since 6.4.0
* @var array
* @var list<int>
*/
protected $priorities = array();

/**
* The priority keys of actively running iterations of a hook.
*
* @since 4.7.0
* @var array
* @var array<int, list<int>>
*/
private $iterations = array();

/**
* The current priority of actively running iterations of a hook.
*
* @since 4.7.0
* @var array
* @var array<int, int>
*/
private $current_priority = array();

Expand Down Expand Up @@ -439,10 +448,11 @@ public function current_priority() {
* @since 4.7.0
*
* @param array $filters Filters to normalize. See documentation above for details.
* @return WP_Hook[] Array of normalized filters.
* @phpstan-param array<string, WP_Hook|array<int, array<Hook_Callback>>> $filters
* @return array<string, WP_Hook> Array of normalized filters keyed by hook name.
*/
public static function build_preinitialized_hooks( $filters ) {
/** @var WP_Hook[] $normalized */
/** @var array<string, WP_Hook> $normalized */
$normalized = array();

foreach ( $filters as $hook_name => $callback_groups ) {
Expand Down Expand Up @@ -475,7 +485,7 @@ public static function build_preinitialized_hooks( $filters ) {
*
* @link https://www.php.net/manual/en/arrayaccess.offsetexists.php
*
* @param mixed $offset An offset to check for.
* @param int $offset An offset to check for.
* @return bool True if the offset exists, false otherwise.
*/
#[ReturnTypeWillChange]
Expand All @@ -490,8 +500,9 @@ public function offsetExists( $offset ) {
*
* @link https://www.php.net/manual/en/arrayaccess.offsetget.php
*
* @param mixed $offset The offset to retrieve.
* @return mixed If set, the value at the specified offset, null otherwise.
* @param int $offset The offset to retrieve.
* @return array|null If set, the value at the specified offset, null otherwise.
* @phpstan-return array<string, Hook_Callback>|null
*/
#[ReturnTypeWillChange]
public function offsetGet( $offset ) {
Expand All @@ -505,8 +516,9 @@ public function offsetGet( $offset ) {
*
* @link https://www.php.net/manual/en/arrayaccess.offsetset.php
*
* @param mixed $offset The offset to assign the value to.
* @param mixed $value The value to set.
* @param int|null $offset The offset to assign the value to.
* @param array $value The value to set.
* @phpstan-param array<string, Hook_Callback> $value
*/
#[ReturnTypeWillChange]
public function offsetSet( $offset, $value ) {
Expand All @@ -526,7 +538,7 @@ public function offsetSet( $offset, $value ) {
*
* @link https://www.php.net/manual/en/arrayaccess.offsetunset.php
*
* @param mixed $offset The offset to unset.
* @param int $offset The offset to unset.
*/
#[ReturnTypeWillChange]
public function offsetUnset( $offset ) {
Expand All @@ -541,7 +553,8 @@ public function offsetUnset( $offset ) {
*
* @link https://www.php.net/manual/en/iterator.current.php
*
* @return array Of callbacks at current priority.
* @return array|false Array of callbacks at current priority, false if there are no more elements.
* @phpstan-return array<string, Hook_Callback>|false
*/
#[ReturnTypeWillChange]
public function current() {
Expand All @@ -555,7 +568,8 @@ public function current() {
*
* @link https://www.php.net/manual/en/iterator.next.php
*
* @return array Of callbacks at next priority.
* @return array|false Array of callbacks at next priority, false if there are no more elements.
* @phpstan-return array<string, Hook_Callback>|false
*/
#[ReturnTypeWillChange]
public function next() {
Expand All @@ -569,7 +583,7 @@ public function next() {
*
* @link https://www.php.net/manual/en/iterator.key.php
*
* @return mixed Returns current priority on success, or NULL on failure
* @return int|null Returns current priority on success, or NULL on failure
*/
#[ReturnTypeWillChange]
public function key() {
Expand Down
Loading