Skip to content

Connectors: Replace plugin.slug with plugin.file#11400

Open
jorgefilipecosta wants to merge 5 commits intoWordPress:trunkfrom
jorgefilipecosta:update/connector-plugin-file
Open

Connectors: Replace plugin.slug with plugin.file#11400
jorgefilipecosta wants to merge 5 commits intoWordPress:trunkfrom
jorgefilipecosta:update/connector-plugin-file

Conversation

@jorgefilipecosta
Copy link
Copy Markdown
Member

@jorgefilipecosta jorgefilipecosta commented Mar 30, 2026

Summary

  • Replace plugin.slug with plugin.file (the full plugin file path, e.g. akismet/akismet.php) in connector registrations
  • Simplify script module data: remove get_plugins() slug-to-file map, use file_exists() and is_plugin_active() directly
  • Add isInstalled to the frontend plugin data
  • Update PHPDoc for plugin type across registry and public API functions

Ticket: https://core.trac.wordpress.org/ticket/65002

Test plan

  • Verify connectors page loads and shows correct plugin status
  • Verify install and activate flows still work for AI provider plugins

…ation

Use the plugin's main file path (e.g. 'akismet/akismet.php') instead of
just the slug. This lets the script module data function use file_exists()
and is_plugin_active() directly, removing the get_plugins() slug-to-file
map. The frontend derives the slug from the file path when needed.
@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 30, 2026

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, mukesh27, gziolo.

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

@mukeshpanchal27 mukeshpanchal27 left a comment

Choose a reason for hiding this comment

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

Thanks for the PR!

Have you consider single file plugin (hello.php)?

@gziolo
Copy link
Copy Markdown
Member

gziolo commented Mar 31, 2026

Have you consider single file plugin (hello.php)?

This should work, too. Worth including in the PHPDoc for completeness.

@gziolo
Copy link
Copy Markdown
Member

gziolo commented Mar 31, 2026

@jorgefilipecosta, to test it in the browser we need to land Gutenberg changes and update the hash to have JS changes compatible?

@jorgefilipecosta
Copy link
Copy Markdown
Member Author

@jorgefilipecosta, to test it in the browser we need to land Gutenberg changes and update the hash to have JS changes compatible?

Exactly or we can test this together with Gutenberg plugin activated.

'pluginFile' => $is_installed
? ( str_ends_with( $plugin_file, '.php' ) ? substr( $plugin_file, 0, -4 ) : $plugin_file )
: null,
'file' => str_ends_with( $file, '.php' ) ? substr( $file, 0, -4 ) : $file,
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The file key here has .php stripped (e.g. ai-provider-for-anthropic/plugin), but the registration file key includes it (e.g. ai-provider-for-anthropic/plugin.php). Using the same key name for two different values in different contexts could be confusing.

Consider either:

  • Keeping the .php extension in the JS output so it matches the registration value exactly, or
  • Renaming the output key to something like slug or pluginBasename to signal it's a derived value

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.

The existing test test_register_includes_plugin_data in tests/phpunit/tests/connectors/wpConnectorRegistry.php:297 still uses 'slug' => 'my-plugin' and passes because the registry stores whatever keys are provided in the plugin array without validation. This should be updated to use 'file' to match the new contract:

$args['plugin'] = array( 'file' => 'my-plugin/my-plugin.php' );
$this->assertSame( array( 'file' => 'my-plugin/my-plugin.php' ), $result['plugin'] );

This also flags that the registry might benefit from cherry-picking known properties from the plugin array (i.e., only keeping file) rather than storing whatever is passed in. That way invalid keys would be silently dropped and the stored data would always match the documented shape. It still works properly because we do that sanitization when passing data to the client.

jorgefilipecosta and others added 3 commits March 31, 2026 17:38
Co-authored-by: Mukesh Panchal <mukeshpanchal27@users.noreply.github.com>
Co-authored-by: Mukesh Panchal <mukeshpanchal27@users.noreply.github.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.

3 participants