Skip to content

[DevHub] Plugin Handbook: grammar and punctuation fixes on Header Requirements page #2513

Open

Description

@Qamca

Issue Description

The Header Requirements page of the Plugin Handbook has several small grammar and punctuation errors, mostly in the opening sentence and the Header Fields list.

URL of the Page with the Issue

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

Section of Page with the issue

The introductory paragraph, the Header Fields list (Plugin URI, Description, Network and Update URI), and the sentence introducing the second code example.

Why is this a problem?

The opening sentence is ungrammatical ("should include header comment what tells WordPress that a file is a plugin"). It is the first thing readers see on the page, and it is also used as the page's meta description, so it shows up in search results and link previews. The other items are smaller inconsistencies and redundancies that make the text harder to read.

Suggested Fix

1. Introductory paragraph (missing article, "what" instead of "that", "a file" instead of "the file")
Current: the main PHP file should include header comment what tells WordPress that a file is a plugin and provides information about the plugin.
Suggested: the main PHP file should include a header comment that tells WordPress that the file is a plugin and provides information about the plugin.

2. Plugin URI (says the URL "should be" unique, then that it "must be" unique)
Current: The home page of the plugin, which should be a unique URL, preferably on your own website. This must be unique to your plugin. You cannot use a WordPress.org URL here.
Suggested: The home page of the plugin, preferably on your own website. This must be unique to your plugin. You cannot use a WordPress.org URL here.

3. Description (the same admin screen is called the "Plugins list" in the Plugin Name field)
Current: as displayed in the Plugins section in the WordPress Admin.
Suggested: as displayed in the Plugins list in the WordPress Admin.

4. Network (unnecessary comma: both verbs share the same subject)
Current: Can only be set to true, and should be left out when not needed.
Suggested: Can only be set to true and should be left out when not needed.

5. Update URI (missing article; the Requires Plugins field already says "read the related dev note")
Current: For more info read related dev note.
Suggested: For more info read the related dev note.

6. Sentence before the second code example (restrictive clause, so "that" rather than "which")
Current: Here's another example which allows file-level PHPDoc DocBlock as well as WordPress plugin file headers:
Suggested: Here's another example that allows file-level PHPDoc DocBlock as well as WordPress plugin file headers:

Is WordPress/developer-plugins-handbook still the source for this page? If so, I'm happy to open a PR with these changes there as well.

Activity

  1. github-actions commented on Sep 25, 2026

    @github-actions

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

  2. Qamca commented on Sep 25, 2026

    @Qamca
    Author

    I've opened a PR with these changes in the handbook repo: WordPress/developer-plugins-handbook#78

    Since the repo and the live page have drifted apart, the live page will still need to be updated separately.

  3. github-actions commented on Sep 28, 2026

    @github-actions

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    developer documentation (DevHub)Improvements or additions to developer documentationpluginsIssues for Plugin Developer Handbook

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions