Skip to content

Hooks: priority should be respected #647

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

Merged
schlessera merged 1 commit into from
Feb 7, 2022
Merged

Hooks: priority should be respected #647

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions src/Hooks.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,8 @@ public function dispatch($hook, $parameters = []) {
$parameters = array_values($parameters);
}

ksort($this->hooks[$hook]);

foreach ($this->hooks[$hook] as $priority => $hooked) {
foreach ($hooked as $callback) {
$callback(...$parameters);
Expand Down
67 changes: 67 additions & 0 deletions tests/HooksTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -241,6 +241,73 @@ public function testDispatchDoesntBreakWithKeyedParametersArray() {
$this->assertTrue($this->hooks->dispatch('hookname', ['paramA' => 10, 'paramB' => 'text']));
}

/**
* Verify that hooks are executed based on their priority order.
*
* Issue https://github.com/WordPress/Requests/issues/452
*
* @covers ::dispatch
*
* @return void
*/
public function testDispatchRespectsHookPriority() {
// Register multiple callbacks for the same hook with a variation of priorities.
$this->hooks->register(
'hook_a',
function(&$text) {
$text .= "no prio 0\n";
}
);
$this->hooks->register(
'hook_a',
function(&$text) {
$text .= "prio 10-1\n";
},
10
);
$this->hooks->register(
'hook_a',
function(&$text) {
$text .= "prio -3\n";
},
-3
);
$this->hooks->register(
'hook_a',
function(&$text) {
$text .= "prio 5\n";
},
5
);
$this->hooks->register(
'hook_a',
function(&$text) {
$text .= "prio 2-1\n";
},
2
);
$this->hooks->register(
'hook_a',
function(&$text) {
$text .= "prio 2-2\n";
},
2
);
$this->hooks->register(
'hook_a',
function(&$text) {
$text .= "prio 10-2\n";
},
10
);

$text = '';
$expected = "prio -3\nno prio 0\nprio 2-1\nprio 2-2\nprio 5\nprio 10-1\nprio 10-2\n";

$this->assertTrue($this->hooks->dispatch('hook_a', [&$text]));
$this->assertSame($expected, $text);
}

/**
* Tests receiving an exception when an invalid input type is passed to `register()` as `$hook`.
*
Expand Down