Skip to content

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

Open
mpeshev wants to merge 2 commits into
WordPress:trunkfrom
mpeshev:66146-connector-type-docs
Open

mpeshev wants to merge 2 commits into
WordPress:trunkfrom
mpeshev:66146-connector-type-docs

Conversation

@mpeshev

@mpeshev mpeshev commented Oct 25, 2026

Copy link
Copy Markdown

Documents the connector type argument of WP_Connector_Registry::register(), following comment:4 and comment:7 on the ticket: type is free-form and may be shared; what core does differently for 'ai_provider' (not registered when wp_supports_ai() is false, key checked with the AI Client on save and cleared if invalid, passed to the AI Client, which also decides whether it is connected); how other types behave; and that the type is part of the default setting_name. Each statement was checked against connectors.php and class-wp-connector-registry.php.

Trac ticket: https://core.trac.wordpress.org/ticket/66146

Testing

  • Docs only. PHPCS is clean, and vendor/bin/phpunit --filter Tests_Connectors passes.

Use of AI Tools

AI assistance: Yes
Tool(s): Claude Code
Model(s): Claude Opus 5.5
Used for: drafting the docblock and checking each statement against the code. I reviewed every line.


This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

🤖 Generated with Claude Code

…::register()`.

The docblock gave 'ai_provider' as the only example, which reads as if it were the only valid value. Document that any non-empty string is accepted, what 'ai_provider' changes, how other types behave, and that the type is part of the default setting name.

See #66146.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs.

Core Committers: Use this line as a base for the props when committing in SVN:

Props nofearinc.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.


Props Bot commands

You can trigger Props Bot actions by commenting on this PR:

  • @propsbot add <username> to give props to a GitHub user. Requires write access.
  • @propsbot remove <username> to leave a user out of the props. Requires write access.
  • @propsbot refresh to refresh this list. Adding the props-bot label works too.

@github-actions

Copy link
Copy Markdown

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

  • All changes will be lost when closing a tab with a Playground instance.
  • All changes will be lost when refreshing the page.
  • A fresh instance is created each time the link below is clicked.
  • Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
    it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

The AI Client key check, the handoff to the AI Client and the key-based connection status only apply to connectors using the `api_key` method. Connectors using `application_password` count as connected when both a username and a password are stored, whatever their type.

See #66146.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant