Skip to content

Hooks: Add site-scoped callback registrations - #13550

Open
hokoo wants to merge 2 commits into
WordPress:trunkfrom
hokoo:ticket-66097-site-scoped-hooks
Open

hokoo wants to merge 2 commits into
WordPress:trunkfrom
hokoo:ticket-66097-site-scoped-hooks

Conversation

@hokoo

@hokoo hokoo commented Sep 16, 2026

Copy link
Copy Markdown

This adds native site-scoped callback registrations to the Hooks API while preserving global registrations as the default.

The existing registration, lookup, and removal functions receive an optional trailing $blog_id parameter:

  • Registration accepts null for global scope or a positive integer for one site.
  • Lookup and removal accept false for all scopes, null for global scope, or a positive integer for one site.
  • Scope forms part of registration identity, allowing the same callback and priority to coexist globally and for multiple sites.
  • Global and matching site-scoped callbacks retain their normal registration order.
  • Scope is evaluated immediately before each callback, including nested dispatch and the all hook.
  • The initial implementation intentionally supports scalar site IDs only.

Legacy global callback keys and callback array shapes remain unchanged. A separate global-only dispatch path avoids adding a per-callback scope check to existing hooks.

Tests cover global compatibility, matching and non-matching sites, identity and ordering, lookup and removal selectors, priority 0, nested and mid-dispatch changes, the all hook, reference-array variants, invalid IDs, preinitialized hooks, and adding the first scoped callback during dispatch.

Trac ticket: https://core.trac.wordpress.org/ticket/66097

Use of AI Tools

AI assistance: Yes
Tool(s): OpenAI Codex
Model(s): GPT-5
Used for: API design analysis, implementation, test development, performance benchmarking, and automated QA. The contributor selected and approved the public API decisions and is submitting the resulting patch.


This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

@github-actions

Copy link
Copy Markdown

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props hokku.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@github-actions

Copy link
Copy Markdown

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

  • All changes will be lost when closing a tab with a Playground instance.
  • All changes will be lost when refreshing the page.
  • A fresh instance is created each time the link below is clicked.
  • Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
    it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant