wppaste
WordPress

wp_get_connector( string $id ): array|null

Since
7.0.0
Source
wp-includes/connectors.php:87
Retrieves a registered connector.

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

$idstring
The connector identifier.

Return value

array|null
Connector data, or null if not registered.

  • $namestring

    The connector's display name.

  • $descriptionstring

    The connector's description.

  • $logo_urlstring

    Optional. URL to the connector's logo image.

  • $typestring

    The connector type, e.g. 'ai_provider'.

  • $authenticationarray

    Authentication configuration. When method is 'api_key' or 'application_password', includes credentials_url, setting_name, and optionally constant_name and env_var_name. When 'none', only method is present.

    • $methodstring

      The authentication method: 'api_key', 'application_password', or 'none'.

    • $credentials_urlstring

      Optional. URL where users can obtain API credentials.

    • $setting_namestring

      Optional. The setting name for the API key or application-password credentials.

    • $constant_namestring

      Optional. PHP constant name for the API key or application-password credentials.

    • $env_var_namestring

      Optional. Environment variable name for the API key or application-password credentials. } @type array $plugin { Optional. Plugin data for install/activate UI.

    • $filestring

      The plugin's main file path relative to the plugins directory (e.g. 'my-plugin/my-plugin.php' or 'hello.php').

    • $is_activecallable

      Callback to determine whether the plugin is active. Receives no arguments and must return bool. Defaults to __return_true.

Performance profile

How much work a call to wp_get_connector() 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
7–11

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

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 wp_get_connector() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
$registry === null7::WP_Connector_Registry()
$registry !== null11::WP_Connector_Registry(), ->get_registered()

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, 7–11 executed per call, 1 branch. 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 · 1

Source code

View on Trac View on GitHub 

function wp_get_connector( string $id ): ?array {	$registry = WP_Connector_Registry::get_instance();	if ( null === $registry ) {		return null;	} 	return $registry->get_registered( $id );}

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/connectors.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.