Commit Graph
17 Commits
Author SHA1 Message Date
Sergey Biryukov e005108fe1 Coding Standards: Restore more descriptive variable names in a few class methods.
When various methods parameters in child classes were renamed to `$item` to match the parent class for PHP 8 named parameter support, most of the methods restored the more descriptive, specific name at the beginning for better readability, with several exceptions for methods consisting only of a few lines.

To avoid confusion about why some methods do that and some don't, this commit aims to bring more consistency to the code, specifically in list tables' `::column_default()` methods.

Follow-up to [51728], [51737], [51786].

See #58831.

git-svn-id: https://develop.svn.wordpress.org/trunk@56586 602fd350-edb4-49c9-b593-d223f7449a82
2023-09-14 12:44:23 +00:00
Sergey Biryukov c5101f1101 Coding Standards: Use strict comparison in wp-includes/class-walker-page-dropdown.php.
Follow-up to [3704], [16100].

Props aristath, poena, afercia, SergeyBiryukov.
See #57839.

git-svn-id: https://develop.svn.wordpress.org/trunk@55905 602fd350-edb4-49c9-b593-d223f7449a82
2023-06-11 09:25:43 +00:00
Jb Audras a6afe726b9 Coding standards: Remove extra spaces in docblocks of the Walker_PageDropdown class.
Follow-up to [51779].

See #54728.


git-svn-id: https://develop.svn.wordpress.org/trunk@53325 602fd350-edb4-49c9-b593-d223f7449a82
2022-05-01 21:59:49 +00:00
John Blackbourn 3fdce9eb4b Docs: Increase the specificity of types in various inline documentation.
See #54729


git-svn-id: https://develop.svn.wordpress.org/trunk@52652 602fd350-edb4-49c9-b593-d223f7449a82
2022-01-30 19:23:25 +00:00
Tonya Mork 47a3b90231 Code Modernization: Fix last parameter name mismatches for parent/child classes in Walker::start_el().
The parent class uses `$current_object_id` while most of the child classes use `$id`. As the parent class' is more descriptive, renaming the last parameter in each of child class.

Why? PHP 8 introduces the ability to pass named arguments to function/method calls. This means the child and parent method signatures (i.e. parameter names) need to match.

Changes for readability:

- `@since` clearly specifies the original parameter name and its new name as well as why the change happened.

- In methods longer than a single line, the generic parameter is reassigned to the original parameter restoring it for context for use within the method. An inline comment is added to explain why this reassignment is made.

- In cases where the original parameter name was too generic or misleading, renamed (when reassigning) to a more descriptive name for use within the method.

Follow-up to [7737], [8900], [8970], [14248], [15077], [16100], [25642], [25644], [37051], [37054], [37056], [46271], [47189], [51739].

Props jrf, hellofromTonya, sergeybiryukov, azaozz, desrosj, johnbillion.
See #51553.

git-svn-id: https://develop.svn.wordpress.org/trunk@51779 602fd350-edb4-49c9-b593-d223f7449a82
2021-09-09 12:38:36 +00:00
Tonya Mork 4f4c3443d7 Code Modernization: Fix reserved keyword and parameter name mismatches for parent/child classes in Walker::start_el().
In the parent class, renames the parameter `$object` to `$data_object`.

Why? `object` is a PHP reserved keyword.

In each child class: renames the corresponding parameter to match the parent's method signature.

Why? 

PHP 8 introduces the ability to pass named arguments to function/method calls. This means the child and parent method signatures (i.e. parameter names) need to match.

Changes for readability:

- `@since` clearly specifies the original parameter name and its new name as well as why the change happened.

- in methods longer than a single line, the generic parameter is reassigned to the original parameter restoring it for context for use within the method. An inline comment is added to explain why this reassignment is made.

- in cases where the original parameter name was too generic, renamed (when reassigning) to a more descriptive name for use within the method.

Follow-up to [7737], [8900], [8970], [14248], [15077], [16100], [25642], [25644], [37051], [37054], [37056], [46271], [47189].

Props jrf, hellofromTonya, sergeybiryukov, azaozz, desrosj, johnbillion.
See #51553.

git-svn-id: https://develop.svn.wordpress.org/trunk@51739 602fd350-edb4-49c9-b593-d223f7449a82
2021-09-08 15:35:32 +00:00
Sergey Biryukov 00b03f2a6f I18N: Capitalize translator comments consistently, add trailing punctuation.
Includes minor code layout fixes.

See #44360.

git-svn-id: https://develop.svn.wordpress.org/trunk@45932 602fd350-edb4-49c9-b593-d223f7449a82
2019-09-03 00:39:13 +00:00
Jonathan Desrosiers 54debcd452 Docs: Correctly specify the $page parameter of list_pages filter as a WP_Post.
Props ianbelanger.
Fixes #44398.

git-svn-id: https://develop.svn.wordpress.org/trunk@44355 602fd350-edb4-49c9-b593-d223f7449a82
2018-12-20 20:04:00 +00:00
Gary Pendergast 8f95800d52 Code is Poetry.
WordPress' code just... wasn't.
This is now dealt with.

Props jrf, pento, netweb, GaryJ, jdgrimes, westonruter, Greg Sherwood from PHPCS, and everyone who's ever contributed to WPCS and PHPCS.
Fixes #41057.



git-svn-id: https://develop.svn.wordpress.org/trunk@42343 602fd350-edb4-49c9-b593-d223f7449a82
2017-11-30 23:09:33 +00:00
Drew Jaynes b4d81bd654 Docs: Remove @access notations from method DocBlocks in wp-includes/* classes.
Prior to about 2013, many class methods lacked even access modifiers which made the `@access` notations that much more useful. Now that we've gotten to a point where the codebase is more mature from a maintenance perspective and we can finally remove these notations. Notable exceptions to this change include standalone functions notated as private as well as some classes still considered to represent "private" APIs.

See #41452.


git-svn-id: https://develop.svn.wordpress.org/trunk@41162 602fd350-edb4-49c9-b593-d223f7449a82
2017-07-27 00:40:27 +00:00
Drew Jaynes d11f7ed391 Docs: Standardize filter docs in remaining wp-includes/* files to use third-person singular verbs per the inline documentation standards for PHP.
See #36913.


git-svn-id: https://develop.svn.wordpress.org/trunk@37518 602fd350-edb4-49c9-b593-d223f7449a82
2016-05-22 18:49:05 +00:00
Drew Jaynes 6f43565b51 Docs: The page object type in use in Walker_PageDropdown is WP_Post.
See #36300.


git-svn-id: https://develop.svn.wordpress.org/trunk@37054 602fd350-edb4-49c9-b593-d223f7449a82
2016-03-22 17:52:53 +00:00
Drew Jaynes eacd0d863d Docs: Improve inline documentation for properties and methods in Walker_PageDropdown.
Props raimy for the initial patch.
See #36300.


git-svn-id: https://develop.svn.wordpress.org/trunk@37053 602fd350-edb4-49c9-b593-d223f7449a82
2016-03-22 17:50:35 +00:00
Drew Jaynes 7b51c13f17 Docs: Add missing property and method summaries in DocBlocks for Walker_PageDropdown.
See #32246.


git-svn-id: https://develop.svn.wordpress.org/trunk@35961 602fd350-edb4-49c9-b593-d223f7449a82
2015-12-16 16:35:11 +00:00
Drew Jaynes 3ea73eb0d9 Docs: Add a missing description for the $id parameter in the DocBlock for Walker_PageDropdown::start_el(), which is implemented by Walker but unused by the subclass method.
Also marks the other optional parameters as such.

See #32246.


git-svn-id: https://develop.svn.wordpress.org/trunk@35928 602fd350-edb4-49c9-b593-d223f7449a82
2015-12-14 17:53:49 +00:00
Drew Jaynes 44c55211ce Docs: Clarify the file header subpackage for wp-includes/class-walker-page-dropdown.php, introduced in [34109].
Also clarifies the class DocBlock summary and tags for `Walker_PageDropdown`.

See #33413. See #33701.


git-svn-id: https://develop.svn.wordpress.org/trunk@34415 602fd350-edb4-49c9-b593-d223f7449a82
2015-09-22 13:57:23 +00:00
Scott Taylor 1ccae571d9 Move Walker_Page and Walker_PageDropdown into their own files via svn cp. Remove them from post-template.php. Load them in post.php.
`post-template.php` loads after `post.php` in `wp-settings.php`. It could probably also be loaded in `post.php`, but avoiding that for the moment.

See #33413.


git-svn-id: https://develop.svn.wordpress.org/trunk@34109 602fd350-edb4-49c9-b593-d223f7449a82
2015-09-14 02:58:40 +00:00