Docs & Standards: Improve PHPDoc consistency and grammar in functions.php

[prab18hat]

• Updated @return type for is_new_day() from int to bool
• Clarified return type in xmlrpc_getpostcategory()
• Improved @param description for get_weekstartend()
• Corrected grammar in build_query() docblock
• Improved return description in get_status_header_desc()

Summary of Changes:

Standardized PHPDoc for is_new_day():

Updated the @return type from int to bool for clarity and modern PHPDoc standards.

Grammar and Docblock Improvements in functions.php:

xmlrpc_getpostcategory(): Clarified the return type and simplified awkward phrasing for readability.

get_weekstartend(): Improved the @param description for $start_of_week to clearly state “Default is an empty string.”

build_query(): Corrected grammar by adding the missing article and removing an unnecessary comma.

Old: Builds URL query based on an associative and, or indexed array.

New: Builds a URL query based on an associative or indexed array.

get_status_header_desc(): Updated return description to: “Status description if found, or an empty string otherwise.” for better clarity.

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

---

This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

[github-actions]

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 prab18hat, dhruvang21, swissspidy.

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

[github-actions]

Hi @prab18hat! 👋

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:

• PHP Coding Standards
• CSS Coding Standards
• HTML Coding Standards
• JavaScript Coding Standards
• Accessibility Coding Standards
• Inline Documentation Standards

Thank you,
The WordPress Project

[github-actions]

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

• The Plugin and Theme Directories cannot be accessed within Playground.
• 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.

[dhruvang21]

@prab18hat you also need to update the test cases code to pass the phpunit tests

public function data_is_new_date() {
		return array(
			array( '21.05.19', '21.05.19', false ),
			array( '21.05.19', '20.05.19', true ),
			array( '21.05.19', false, true ),
		);
	}

[prab18hat]

Thanks for the feedback! I’ve updated the test cases for is_new_day() so that the data provider now returns booleans (true/false). The PHPUnit assertions now match the updated return type.

[swissspidy]

🚨 We cannot just change the return type of is_new_day(). That would be a breaking change. We need to ensure backward compatibility. Please revert those changes.

[github-actions]

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

SVN changeset: 60687
GitHub commit: 56d7d59

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

[prab18hat]

• Updated @return type for is_new_day() from int to bool
• Clarified return type in xmlrpc_getpostcategory()
• Improved @param description for get_weekstartend()
• Corrected grammar in build_query() docblock
• Improved return description in get_status_header_desc()

Summary of Changes:

Standardized PHPDoc for is_new_day():

Updated the @return type from int to bool for clarity and modern PHPDoc standards.

Grammar and Docblock Improvements in functions.php:

xmlrpc_getpostcategory(): Clarified the return type and simplified awkward phrasing for readability.

get_weekstartend(): Improved the @param description for $start_of_week to clearly state “Default is an empty string.”

build_query(): Corrected grammar by adding the missing article and removing an unnecessary comma.

Old: Builds URL query based on an associative and, or indexed array.

New: Builds a URL query based on an associative or indexed array.

get_status_header_desc(): Updated return description to: “Status description if found, or an empty string otherwise.” for better clarity.

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

This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

Hi, I noticed this PR was closed after the Trac ticket was fixed. However, some of the docblock and grammar improvements here are not yet in trunk. If possible, could a maintainer please reopen this PR so I can update it, or should I open a new PR instead? Thank you!