wppaste
WordPress

AiClient::prompt( WordPress\AiClient\Prompt $prompt = null, WordPress\AiClient\Providers\ProviderRegistry|null $registry = null ): WordPress\AiClient\Builders\PromptBuilder

Since
0.1.0
Source
wp-includes/php-ai-client/src/AiClient.php:210
Creates a new prompt builder for fluent API usage.

Description

Returns a PromptBuilder instance configured with the specified or default registry.
The traditional API methods in this class delegate to PromptBuilder for all generation logic.

Compatibility

WordPress
since 0.1.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 0.1.0, and compiles on PHP 7.4 through 8.6-dev.

Parameters

$promptWordPress\AiClient\Promptoptional
Optional initial prompt content.Default: null
$registryWordPress\AiClient\Providers\ProviderRegistry|nulloptional
Optional custom registry. If null, uses default.Default: null

Return value

WordPress\AiClient\Builders\PromptBuilder
The prompt builder instance.

Performance profile

How much work a call to AiClient::prompt() 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

Touches nothing outside its own arguments.

Scaling
Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions
12–15

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 15.

Plugin surface
None

Nothing here hands control to plugin code.

Called by
0

Nothing in core calls this; the cost is only what you spend yourself.

What one call costs · 2 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost AiClient::prompt() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
always12none
always15::defaultRegistry()

Across PHP versions

PHPCompiledExecutedBranchesNotes
8.6-dev1412–1411 fewer instruction than PHP 8.5
8.51512–151
8.41512–151
8.31512–151
8.21512–151
8.11512–151
7.41512–151

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.

Uses · 2

  • \WordPress\AiClient\Builders\PromptBuilder::__construct()
  • \WordPress\AiClient\AiClient::defaultRegistry()

Source code

View on Trac View on GitHub 

    public static function prompt($prompt = null, ?ProviderRegistry $registry = null): PromptBuilder    {        return new PromptBuilder($registry ?? self::defaultRegistry(), $prompt, self::$eventDispatcher);    }

Changelog

Introduced in 0.1.0. Unchanged from 7.0.4 through 7.1.0.

  1. 7.0.4
  2. 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/php-ai-client/src/AiClient.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.