Skip to content

Docs: Correct the documented default for $format in get_next_post_link() and next_post_link()#12320

Open
1shiharat wants to merge 1 commit into
WordPress:trunkfrom
1shiharat:fix/65541-next-post-link-format-default
Open

Docs: Correct the documented default for $format in get_next_post_link() and next_post_link()#12320
1shiharat wants to merge 1 commit into
WordPress:trunkfrom
1shiharat:fix/65541-next-post-link-format-default

Conversation

@1shiharat

Copy link
Copy Markdown

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

Description

The @param DocBlock for $format in get_next_post_link() documents the default as '« %link', but the actual signature default is '%link »'. The '« %link' value is the default for the previous-post functions (get_previous_post_link() / previous_post_link()) and was copied onto the next-post functions. The same mismatch is present in next_post_link() (its signature default is likewise '%link »').

For context: the $format signature default was originally corrected in [25965] (#25743). The Default '...'. notations were added later in [37254] (4.6.0), which copied the previous-post value onto the next-post DocBlocks — so the documentation again contradicts the signature.

Change

Update the @param $format DocBlocks of get_next_post_link() and next_post_link() to read Default '%link »'. so they match their signatures. Documentation only — no functional change. The previous-post functions are already correct and are left unchanged.

Verified against trunk; phpcs reports no new issues on the changed lines.

Use of AI Tools

AI assistance: Yes (Claude). Used to locate the discrepancy, verify it against the source and changeset history, and draft this description. The change was reviewed and verified before submission.

🤖 Generated with Claude Code

…functions.

The `@param` DocBlock for `$format` in `get_next_post_link()` and `next_post_link()`
documented the default as `'« %link'`, but both signatures default to
`'%link »'`. The `'« %link'` value is the default for the previous-post
functions and was copied onto the next-post functions.

The signature default was corrected in [25965] (#25743); the `Default '...'.`
notations added later in [37254] (4.6.0) reintroduced the mismatch in the DocBlocks.
Update both next-post DocBlocks to match their signatures.

Docs only, no functional change. The previous-post functions are already correct.

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

Co-Authored-By: Claude Opus 4.8 <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. You can also manually ask me to refresh this list by adding the props-bot label.

Unlinked Accounts

The following contributors have not linked their GitHub and WordPress.org accounts: @1shiharat.

Contributors, please read how to link your accounts to ensure your work is properly credited in WordPress releases.

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

Hi there! 👋

Thank you for your contribution to WordPress! 💖

It looks like this is your first pull request to wordpress-develop. Here are a few things to be aware of that may help you out!

No one monitors this repository for new pull requests. Pull requests must be attached to a Trac ticket to be considered for inclusion in WordPress Core. To attach a pull request to a Trac ticket, please include the ticket's full URL in your pull request description.

Pull requests are never merged on GitHub. The WordPress codebase continues to be managed through the SVN repository that this GitHub repository mirrors. Please feel free to open pull requests to work on any contribution you are making.

More information about how GitHub pull requests can be used to contribute to WordPress can be found in the Core Handbook.

Please include automated tests. Including tests in your pull request is one way to help your patch be considered faster. To learn about WordPress' test suites, visit the Automated Testing page in the handbook.

If you have not had a chance, please review the Contribute with Code page in the WordPress Core Handbook.

The Developer Hub also documents the various coding standards that are followed:

Thank you,
The WordPress Project

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

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