Commit Graph

14 Commits

Author SHA1 Message Date
John Blackbourn ecc08a41f6 Docs: Increase the specificity of types in various inline documentation.
See #54729

Built from https://develop.svn.wordpress.org/trunk@52652


git-svn-id: http://core.svn.wordpress.org/trunk@52241 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-01-30 19:25:03 +00:00
hellofromTonya 7abc752329 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.
Built from https://develop.svn.wordpress.org/trunk@51779


git-svn-id: http://core.svn.wordpress.org/trunk@51386 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-09-09 12:39:59 +00:00
hellofromTonya 1105ddf965 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.
Built from https://develop.svn.wordpress.org/trunk@51739


git-svn-id: http://core.svn.wordpress.org/trunk@51347 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-09-08 15:36:59 +00:00
Sergey Biryukov e199663322 I18N: Capitalize translator comments consistently, add trailing punctuation.
Includes minor code layout fixes.

See #44360.
Built from https://develop.svn.wordpress.org/trunk@45932


git-svn-id: http://core.svn.wordpress.org/trunk@45743 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-09-03 00:41:05 +00:00
desrosj b3a7877017 Docs: Correctly specify the `$page` parameter of `list_pages` filter as a `WP_Post`.
Props ianbelanger.
Fixes #44398.
Built from https://develop.svn.wordpress.org/trunk@44355


git-svn-id: http://core.svn.wordpress.org/trunk@44185 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2018-12-20 20:04:50 +00:00
Gary Pendergast aaf99e6913 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.


Built from https://develop.svn.wordpress.org/trunk@42343


git-svn-id: http://core.svn.wordpress.org/trunk@42172 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-11-30 23:11:00 +00:00
Drew Jaynes 0860bb2771 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.

Built from https://develop.svn.wordpress.org/trunk@41162


git-svn-id: http://core.svn.wordpress.org/trunk@41002 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-07-27 00:41:44 +00:00
Drew Jaynes 9cb5247392 Docs: Standardize filter docs in remaining wp-includes/* files to use third-person singular verbs per the inline documentation standards for PHP.
See #36913.

Built from https://develop.svn.wordpress.org/trunk@37518


git-svn-id: http://core.svn.wordpress.org/trunk@37486 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-05-22 18:50:28 +00:00
Drew Jaynes 3cdef41502 Docs: The page object type in use in `Walker_PageDropdown` is `WP_Post`.
See #36300.

Built from https://develop.svn.wordpress.org/trunk@37054


git-svn-id: http://core.svn.wordpress.org/trunk@37021 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-03-22 17:53:27 +00:00
Drew Jaynes 63582d4ecb Docs: Improve inline documentation for properties and methods in `Walker_PageDropdown`.
Props raimy for the initial patch.
See #36300.

Built from https://develop.svn.wordpress.org/trunk@37053


git-svn-id: http://core.svn.wordpress.org/trunk@37020 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-03-22 17:51:27 +00:00
Drew Jaynes d057c51893 Docs: Add missing property and method summaries in DocBlocks for `Walker_PageDropdown`.
See #32246.

Built from https://develop.svn.wordpress.org/trunk@35961


git-svn-id: http://core.svn.wordpress.org/trunk@35926 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-12-16 16:36:28 +00:00
Drew Jaynes fc9fa08592 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.

Built from https://develop.svn.wordpress.org/trunk@35928


git-svn-id: http://core.svn.wordpress.org/trunk@35892 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-12-14 17:54:27 +00:00
Drew Jaynes 2828e6cc06 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.

Built from https://develop.svn.wordpress.org/trunk@34415


git-svn-id: http://core.svn.wordpress.org/trunk@34379 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-09-22 13:58:24 +00:00
Scott Taylor 4cec121d0b 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.

Built from https://develop.svn.wordpress.org/trunk@34109


git-svn-id: http://core.svn.wordpress.org/trunk@34077 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-09-14 02:59:24 +00:00