WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

wp_get_connector()

wp_get_connector( string $id ): array|null

In this article

Back to top

Retrieves a registered connector.

Description

See also

Parameters

$idstringrequired
The connector identifier.

Return

array|null Connector data, or null if not registered.
  • name string
    The connector’s display name.
  • description string
    The connector’s description.
  • logo_url string
    Optional. URL to the connector’s logo image.
  • type string
    The connector type, e.g. 'ai_provider'.
  • authentication array
    Authentication configuration. When method is ‘api_key’, includes credentials_url, setting_name, and optionally constant_name and env_var_name. When ‘none’, only method is present.
    • method string
      The authentication method: 'api_key' or 'none'.
    • credentials_url string
      Optional. URL where users can obtain API credentials.
    • setting_name string
      Optional. The setting name for the API key.
    • constant_name string
      Optional. PHP constant name for the API key.
    • env_var_name string
      Optional. Environment variable name for the API key.
  • plugin array
    Optional. Plugin data for install/activate UI.
    • file string
      The plugin’s main file path relative to the plugins directory (e.g. 'my-plugin/my-plugin.php' or 'hello.php').
    • is_active callable
      Callback to determine whether the plugin is active. Receives no arguments and must return bool.
      Defaults to __return_true.

Source

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

	return $registry->get_registered( $id );
}

View all references View on Trac View on GitHub

UsesDescription
WP_Connector_Registry::get_instance()wp-includes/class-wp-connector-registry.php

Retrieves the main instance of the registry class.

Changelog

VersionDescription
7.0.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.