wppaste
WordPress

wp_ai_client_prompt( string|WordPress\AiClient\Messages\DTO\MessagePart|WordPress\AiClient\Messages\DTO\Message|array|list<string|WordPress\AiClient\Messages\DTO\MessagePart|array>|list<Message>|null $prompt = null ): WP_AI_Client_Prompt_Builder

Since
7.0.0
Source
wp-includes/ai-client.php:60
Creates a new AI prompt builder using the default provider registry.

Description

This is the main entry point for generating AI content in WordPress. It returns a fluent builder that can be used to configure and execute AI prompts.

The prompt can be provided as a simple string for basic text prompts, or as more complex types for advanced use cases like multi-modal content or conversation history.

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

$promptstring|WordPress\AiClient\Messages\DTO\MessagePart|WordPress\AiClient\Messages\DTO\Message|array|list<string|WordPress\AiClient\Messages\DTO\MessagePart|array>|list<Message>|nulloptional
Initial prompt content.
A string for simple text prompts, a MessagePart or Message object for structured content, an array for a message array shape, or a list of parts or messages for multi-turn conversations. Default null.Default: null

Return value

WP_AI_Client_Prompt_Builder
The prompt builder instance.

Performance profile

How much work a call to wp_ai_client_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
9

Executed per call on PHP 8.5. The body compiles to 9.

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 · 1 distinct outcome

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

WhenInstructionsCalls it makes
always9::AiClient()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 9 instructions, 9 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.

Uses · 2

Source code

View on Trac View on GitHub 

function wp_ai_client_prompt( $prompt = null ): WP_AI_Client_Prompt_Builder {	return new WP_AI_Client_Prompt_Builder( AiClient::defaultRegistry(), $prompt );}

Changelog

Introduced in 7.0.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/ai-client.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.