Skip to content

Docs: Explain the connector type argument of WP_Connector_Registry::register() #14851

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mpeshev wants to merge 2 commits into
base: trunk
Choose a base branch
from
Open

Docs: Explain the connector type argument of WP_Connector_Registry::register() #14851

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fd04752
Docs: Explain the connector `type` argument of `WP_Connector_Registry…
mpeshev Oct 25, 2026
f65077b
Docs: Scope the connector key behavior to the `api_key` method.
mpeshev Oct 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion src/wp-includes/class-wp-connector-registry.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,21 @@ final class WP_Connector_Registry {
* @type string $name Required. The connector's display name.
* @type string $description Optional. The connector's description. Default empty string.
* @type string $logo_url Optional. URL to the connector's logo image.
* @type string $type Required. The connector type, e.g. 'ai_provider'.
* @type string $type Required. The connector type. Any non-empty string is
* accepted, and several connectors may share a type.
* 'ai_provider' is the only type core treats specially.
* Such a connector is not registered when wp_supports_ai()
* is false. For connectors using the 'api_key' method, an
* 'ai_provider' key is checked with the AI Client when saved
* (an invalid key is cleared) and passed to the AI Client,
* which decides whether it is connected; for any other type,
* the key is saved as given, and the connector counts as
* connected when any of its key sources holds a key.
* Connectors using the 'application_password' method count
* as connected when both a username and a password are
* stored, whatever their type. The type is part of the
* default `setting_name`, so set `setting_name` explicitly
* if the type may change later.
* @type array $authentication {
* Required. Authentication configuration.
*
Expand Down
Loading