AiClient::isConfigured( WordPress\AiClient\Providers\Contracts\ProviderAvailabilityInterface|string|WordPress\AiClient\class-string<ProviderInterface> $availabilityOrIdOrClassName ): bool
- Since
- 0.1.0, 0.2.0
- Source
wp-includes/php-ai-client/src/AiClient.php:185
Description
Supports multiple input formats for developer convenience:
- ProviderAvailabilityInterface: Direct availability check
- string (provider ID): e.g., AiClient::isConfigured('openai')
- string (class name): e.g., AiClient::isConfigured(OpenAiProvider::class)
When using string input, this method leverages the ProviderRegistry's centralized dependency management, ensuring HttpTransporter and authentication are properly injected into availability instances.
Compatibility
- WordPress
- since 0.2.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.2.0, and compiles on PHP 7.4 through 8.6-dev.
Parameters
$availabilityOrIdOrClassNameWordPress\AiClient\Providers\Contracts\ProviderAvailabilityInterface|string|WordPress\AiClient\class-string<ProviderInterface>- The provider availability instance, provider ID, or provider class name.
Return value
bool- True if the provider is configured and available, false otherwise.
Performance profile
How much work a call to AiClient::isConfigured() 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
- 7–15
- Plugin surface
- None
- 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, depending on the branch taken. The body compiles to 27.
Nothing here hands control to plugin code.
Nothing in core calls this; the cost is only what you spend yourself.
What one call costs · 3 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost AiClient::isConfigured() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
$availabilityOrIdOrClassName instanceof | 7 | ->isConfigured() |
!($availabilityOrIdOrClassName instanceof) && is_string($availabilityOrIdOrClassName) | 12 | ::defaultRegistry(), ->isProviderConfigured() |
!($availabilityOrIdOrClassName instanceof) && !is_string($availabilityOrIdOrClassName) | 14–15 | none |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 27 | 7–15 | 3 | |
| 8.5 | 27 | 7–15 | 3 | |
| 8.4 | 27 | 7–15 | 3 | 3 fewer instructions than PHP 8.3 |
| 8.3 | 30 | 7–18 | 3 | |
| 8.2 | 30 | 7–18 | 3 | |
| 8.1 | 30 | 7–18 | 3 | 2 fewer instructions than PHP 7.4 |
| 7.4 | 32 | 7–19 | 3 |
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 · 3
- self::defaultRegistry()::isProviderConfigured()
- \WordPress\AiClient\AiClient::defaultRegistry()
- InvalidArgumentException::__construct()
Source code
public static function isConfigured($availabilityOrIdOrClassName): bool { // Handle direct ProviderAvailabilityInterface (backward compatibility) if ($availabilityOrIdOrClassName instanceof ProviderAvailabilityInterface) { return $availabilityOrIdOrClassName->isConfigured(); } // Handle string input (provider ID or class name) via registry if (is_string($availabilityOrIdOrClassName)) { return self::defaultRegistry()->isProviderConfigured($availabilityOrIdOrClassName); } throw new \InvalidArgumentException('Parameter must be a ProviderAvailabilityInterface instance, provider ID string, or provider class name. ' . sprintf('Received: %s', is_object($availabilityOrIdOrClassName) ? get_class($availabilityOrIdOrClassName) : gettype($availabilityOrIdOrClassName))); }Changelog
Introduced in 0.1.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/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.