Skip to content

Connectors: Respect custom setting_name in connector registration#11357

Closed
jorgefilipecosta wants to merge 1 commit intoWordPress:trunkfrom
jorgefilipecosta:fix/connector-registry-custom-setting-name
Closed

Connectors: Respect custom setting_name in connector registration#11357
jorgefilipecosta wants to merge 1 commit intoWordPress:trunkfrom
jorgefilipecosta:fix/connector-registry-custom-setting-name

Conversation

@jorgefilipecosta
Copy link
Copy Markdown
Member

@jorgefilipecosta jorgefilipecosta commented Mar 26, 2026

Summary

  • WP_Connector_Registry::register() always auto-generates the setting_name for api_key connectors, ignoring any caller-provided value in $args['authentication']['setting_name']
  • This prevents connectors from using existing WordPress options as their API key storage
  • The fix checks for a non-empty setting_name in the provided args before falling back to the auto-generated name

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

Test plan

  • Register a connector with a custom setting_name and verify it is preserved in the registry output
  • Verify existing connectors without a custom setting_name still get the auto-generated value

The `WP_Connector_Registry::register()` method always auto-generates
the `setting_name` for connectors with `api_key` authentication,
ignoring any caller-provided value. This prevents connectors from
using existing WordPress options as their API key storage.

This change checks for a non-empty `setting_name` in the provided
args before falling back to the auto-generated name.
@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. You can also manually ask me to refresh this list by adding the props-bot label.

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

Props jorgefilipecosta.

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

@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.

Copy link
Copy Markdown
Member

@gziolo gziolo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could add an unit test to cover this case later.

@github-actions
Copy link
Copy Markdown

A commit was made that fixes the Trac ticket referenced in the description of this pull request.

SVN changeset: 62116
GitHub commit: e2cf039

This PR will be closed, but please confirm the accuracy of this and reopen if there is more work to be done.

@github-actions github-actions bot closed this Mar 26, 2026
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.

2 participants