WP_AI_Client_Event_Dispatcher::dispatch( object $event ): object
- Since
- 7.0.0
- Source
wp-includes/ai-client/adapters/class-wp-ai-client-event-dispatcher.php:35
Description
Converts the event class name to a WordPress action hook name and fires it.
For example, BeforeGenerateResultEvent becomes wp_ai_client_before_generate_result.
Compatibility
- WordPress
- since 7.0.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in 2 of the 5 tracked releases, added in 7.0.0, and compiles on PHP 7.4 through 8.6-dev.
Parameters
$eventobject- The event object to dispatch.
Return value
object- The same event object, potentially modified by listeners.
Performance profile
How much work a call to WP_AI_Client_Event_Dispatcher::dispatch() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.
- Cost class
- Trivial
- Scaling
- Constant
- Instructions
- 12
- Plugin surface
- 1 hook
- Called by
- 0
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5. The body compiles to 12.
Third-party callbacks on 'wp_ai_client_{$event_name}' run inside this call, and their cost is not bounded by anything here.
Nothing in core calls this; the cost is only what you spend yourself.
What it touches
- hookthird-party callbacks
do_action()called directly
What one call costs · 1 distinct outcome
One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_AI_Client_Event_Dispatcher::dispatch() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 12 | ->get_hook_name_portion_for_event(), do_action() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 12 instructions, 12 executed per call, 0 branches. The work does not change between versions.
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Hooks and filters fired · 1
One hook fires while WP_AI_Client_Event_Dispatcher::dispatch() runs, in this order:
- do_action( wp_ai_client_{$event_name} )actionline 56 (+21 into the body)
Fires when an AI client event is dispatched.
Uses · 2
- do_action()Calls the callback functions that have been added to an action hook.
- WP_AI_Client_Event_Dispatcher::get_hook_name_portion_for_event()Converts an event object class name to a WordPress action hook name portion.
Source code
public function dispatch( object $event ): object { $event_name = $this->get_hook_name_portion_for_event( $event ); /** * Fires when an AI client event is dispatched. * * The dynamic portion of the hook name, `$event_name`, refers to the * snake_case version of the event class name, without the `_event` suffix. * * For example, an event class named `BeforeGenerateResultEvent` will fire the * `wp_ai_client_before_generate_result` action hook. * * In practice, the available action hook names are: * * - wp_ai_client_before_generate_result * - wp_ai_client_after_generate_result * * @since 7.0.0 * * @param object $event The event object. */ do_action( "wp_ai_client_{$event_name}", $event ); return $event; }Changelog
Introduced in 7.0.0. Unchanged from 7.0.4 through 7.1.0.
Signature, return type and hooks compared across 2 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 tag, from
src/wp-includes/ai-client/adapters/class-wp-ai-client-event-dispatcher.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it. - Corrections
- Something wrong on this page? Report it and it gets fixed in the next regeneration.