WP_AI_Client_Prompt_Builder::__call( string $name, array $arguments ): mixed

Description

Compatibility

Present in 2 of the 5 tracked releases, added in 7.0.0, and compiles on PHP 7.4 through 8.6-dev.

Parameters

$namestring

The method name in snake_case.

$argumentsarray

Return value

mixed

The result of the method call.

Performance profile

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

11–53

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

Plugin surface

1 hook

Third-party callbacks on 'wp_ai_client_prevent_prompt' run inside this call, and their cost is not bounded by anything here.

Called by

0

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

What it touches

• hookthird-party callbacksapply_filters()called directly

Further down the call graph this can also reach query, option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 13 distinct outcomes

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

Hooks and filters fired · 1

One hook fires while WP_AI_Client_Prompt_Builder::__call() runs, in this order:

1. 1
   apply_filters( wp_ai_client_prevent_prompt )filterline 322 (+29 into the body)

   Filters whether to prevent the prompt from being executed.

Uses · 8

• wp_supports_ai()Returns whether AI features are supported in the current environment.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• __()Retrieves the translation of $text.
• WP_AI_Client_Prompt_Builder::is_generating_method()Checks if a method name is a generating method (generate_*, convert_text_to_speech*).
• WP_AI_Client_Prompt_Builder::is_support_check_method()Checks if a method name is a support check method (is_supported*).
• WP_Error::__construct()Initializes the error.
• WP_AI_Client_Prompt_Builder::get_builder_callable()Retrieves a callable for a given PHP AI Client SDK prompt builder method name.
• WP_AI_Client_Prompt_Builder::exception_to_wp_error()Converts an exception into a WP_Error with a structured error code and message.

Source code

View on Trac ↗View on GitHub ↗

293	public function __call( string $name, array $arguments ) {294		/*295		 * If an error occurred in a previous method call, either return the error for terminate methods,296		 * or return the same instance for other methods to maintain the fluent interface.297		 */298		if ( null !== $this->error ) {299			if ( self::is_generating_method( $name ) ) {300				return $this->error;301			}302			if ( self::is_support_check_method( $name ) ) {303				return false;304			}305			return $this;306		}307 308		// Check if the prompt should be prevented for is_supported* and generate_*/convert_text_to_speech* methods.309		if ( self::is_support_check_method( $name ) || self::is_generating_method( $name ) ) {310			// If AI is not supported, then there's no need to apply the filter as the prompt will be prevented anyway.311			$is_ai_disabled = ! wp_supports_ai();312			$prevent        = $is_ai_disabled;313			if ( ! $prevent ) {314				/**315				 * Filters whether to prevent the prompt from being executed.316				 *317				 * @since 7.0.0318				 *319				 * @param bool                        $prevent Whether to prevent the prompt. Default false.320				 * @param WP_AI_Client_Prompt_Builder $builder A clone of the prompt builder instance (read-only).321				 */322				$prevent = (bool) apply_filters( 'wp_ai_client_prevent_prompt', false, clone $this );323			}324 325			if ( $prevent ) {326				// For is_supported* methods, return false.327				if ( self::is_support_check_method( $name ) ) {328					return false;329				}330 331				$error_message = $is_ai_disabled332					? __( 'AI features are not supported in this environment.' )333					: __( 'Prompt execution was prevented by a filter.' );334 335				// For generate_* and convert_text_to_speech* methods, create a WP_Error.336				$this->error = new WP_Error(337					'prompt_prevented',338					$error_message,339					array(340						'status' => 503,341					)342				);343 344				if ( self::is_generating_method( $name ) ) {345					return $this->error;346				}347				return $this;348			}349		}350 351		try {352			$callable = $this->get_builder_callable( $name );353			$result   = $callable( ...$arguments );354 355			// If the result is a PromptBuilder, return the current instance to allow method chaining.356			if ( $result instanceof PromptBuilder ) {357				return $this;358			}359 360			return $result;361		} catch ( Exception $e ) {362			$this->error = $this->exception_to_wp_error( $e );363 364			if ( self::is_generating_method( $name ) ) {365				return $this->error;366			}367			return $this;368		}369	}

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/class-wp-ai-client-prompt-builder.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.