Skip to content
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.

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

Add Required Plugin header field to Header Requirements #1531

Closed
damiencarbery opened this issue Apr 9, 2024 · 5 comments
Closed

Add Required Plugin header field to Header Requirements #1531

damiencarbery opened this issue Apr 9, 2024 · 5 comments
Assignees
Labels
developer documentation (DevHub) Improvements or additions to developer documentation plugins Issues for Plugin Developer Handbook [Status] Done Issue is completed

Comments

@damiencarbery
Copy link

Issue Description

I suggest adding the new Required Plugins header field to the Header Fields page. The header field was introduced in 6.5.

URL of the Page with the Issue

https://developer.wordpress.org/plugins/plugin-basics/header-requirements/

Section of Page with the issue

Header Fields: https://developer.wordpress.org/plugins/plugin-basics/header-requirements/#header-fields

Why is this a problem?

WordPress 6.5 introduced a new header field - Required Plugins. And it is a very useful feature to help users.

Suggested Fix

Add text like the following to the Available header fields list. This text is copied from the page mentioned in the 6.5 release notes.
https://make.wordpress.org/core/2024/03/05/introducing-plugin-dependencies-in-wordpress-6-5/

Requires Plugins: This must contain a comma-separated list of WordPress.org-formatted slugs for its dependencies, such as my-plugin (my-plugin/my-plugin.php is not supported). It does not support commas in plugin slugs.

@damiencarbery damiencarbery added the [Status] To do Issue marked as Todo label Apr 9, 2024
Copy link

github-actions bot commented Apr 9, 2024

Heads up @WordPress/docs-issues-coordinators, we have a new issue open. Time to use 'em labels.

@flexseth flexseth added the developer documentation (DevHub) Improvements or additions to developer documentation label Apr 9, 2024
@flexseth
Copy link
Collaborator

flexseth commented Apr 9, 2024

I suggest adding the new Required Plugins header field to the Header Fields page.

Hey @damiencarbery - I've requested the change in the Plugins Handbook repo. The handbook is kind of in limbo right now due to some change decisions being made. If I can get to making the PR to update it, I will...

Duplicate of


Labeling for DevHub and I'll keep the issue open so both can be closed out when the doc is updated.

@stevenlinx
Copy link
Member

1.)

"I suggest adding the new Required Plugins header field..."

"WordPress 6.5 introduced a new header field - Required Plugins. And it is..."

I think there are errors here. It should be Requires Plugins with a s

2.)
It seems @audrasjb has already updated the page.

But @audrasjb , will you please open an Issue as well next time please? Thank you.

@stevenlinx stevenlinx added the plugins Issues for Plugin Developer Handbook label Apr 19, 2024
Copy link

Heads up @theMikeD - the "plugins" label was applied to this issue.

@github-actions github-actions bot added [Status] In progress Issue is in progress and removed [Status] To do Issue marked as Todo labels Apr 19, 2024
@stevenlinx stevenlinx added [Status] Done Issue is completed and removed [Status] In progress Issue is in progress labels Apr 22, 2024
@audrasjb
Copy link

But @audrasjb , will you please open an Issue as well next time please? Thank you.

Ok!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
developer documentation (DevHub) Improvements or additions to developer documentation plugins Issues for Plugin Developer Handbook [Status] Done Issue is completed
Projects
Status: Done
Development

No branches or pull requests

4 participants