ae9eae8f64
Docs: Document some more common names for dynamic hooks and standardise the phrasing used.
...
Fixes #53581
Built from https://develop.svn.wordpress.org/trunk@51837
git-svn-id: http://core.svn.wordpress.org/trunk@51444 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-09-21 18:21:00 +00:00
efaf4a8938
Docs: Add and correct examples of common names for various dynamic hooks.
...
See #53581
Built from https://develop.svn.wordpress.org/trunk@51327
git-svn-id: http://core.svn.wordpress.org/trunk@50936 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-07-03 21:42:59 +00:00
db01832512
Docs: Correct default value for the `number` argument of `wp_tag_cloud()`.
...
Follow-up to [42658].
Props audrasjb, pawki07.
Fixes #52348 .
Built from https://develop.svn.wordpress.org/trunk@50009
git-svn-id: http://core.svn.wordpress.org/trunk@49710 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-01-24 14:07:57 +00:00
f5bd63d352
Docs: Link to the parent function for accepted arguments in some filters for HTML output.
...
See #51800 .
Built from https://develop.svn.wordpress.org/trunk@49977
git-svn-id: http://core.svn.wordpress.org/trunk@49678 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-01-18 12:28:07 +00:00
53da9208dd
Docs: Various docblock corrections particularly relating to boolean types.
...
See #51800
Built from https://develop.svn.wordpress.org/trunk@49926
git-svn-id: http://core.svn.wordpress.org/trunk@49625 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-01-03 21:57:09 +00:00
f4cda1b62f
Docs: Upgrade more parameters in docblocks to used typed array notation.
...
See #51800 , #41756
Built from https://develop.svn.wordpress.org/trunk@49693
git-svn-id: http://core.svn.wordpress.org/trunk@49416 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-11-24 21:27:05 +00:00
35f6c356c1
Docs: Document parameters that accept an array of integers using typed array notation.
...
While many of these parameters also technically accept an array of numerical strings, they are all ultimately cast to an array of integers. Documenting them as such assists developers in understanding the expected types.
See #51800 , #41756
Built from https://develop.svn.wordpress.org/trunk@49672
git-svn-id: http://core.svn.wordpress.org/trunk@49395 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-11-19 18:24:09 +00:00
aab7112b09
Docs: Use more specific type in parameter descriptions for `in_category()` and `is_object_in_term()`.
...
This better aligns with `is_category()` and other conditional tags and their `WP_Query` counterpart methods.
Follow-up to [47402].
Props princeahmed.
Fixes #51825 .
Built from https://develop.svn.wordpress.org/trunk@49669
git-svn-id: http://core.svn.wordpress.org/trunk@49392 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-11-19 15:20:05 +00:00
170ca32007
Docs: Various docblock corrections and improvements.
...
See #50768
Built from https://develop.svn.wordpress.org/trunk@49597
git-svn-id: http://core.svn.wordpress.org/trunk@49335 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-11-14 16:35:06 +00:00
0e3147c40e
Coding Standards: Replace alias PHP functions with the canonical names.
...
Using the canonical function name for PHP functions is strongly recommended, as aliases may be deprecated or removed without (much) warning.
This replaces all uses of the following:
* `join()` with `implode()`
* `sizeof()` with `count()`
* `is_writeable()` with `is_writable()`
* `doubleval()` with a `(float)` cast
In part, this is a follow-up to #47746 .
Props jrf.
See #50767 .
Built from https://develop.svn.wordpress.org/trunk@49193
git-svn-id: http://core.svn.wordpress.org/trunk@48955 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-10-18 17:27:06 +00:00
897f004a9c
General: Replace older-style PHP type conversion functions with type casts.
...
This improves performance, readability, and consistency throughout core.
* `intval()` → `(int)`
* `strval()` → `(string)`
* `floatval()` → `(float)`
Props ayeshrajans.
Fixes #42918 .
Built from https://develop.svn.wordpress.org/trunk@49108
git-svn-id: http://core.svn.wordpress.org/trunk@48870 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-10-08 21:15:13 +00:00
d36da091c4
Taxonomy: Restore documentation for the `taxonomy` parameter of `wp_list_categories()`.
...
The parameter's default value is different from the one in `WP_Term_Query::__construct()`, and should be documented accordingly.
This also clarifies that the `taxonomy` parameter of `wp_list_categories()` only accepts a string, not an array.
Follow-up to [40903], [41767], [45894], [45895].
Props grapplerulrich, mukesh27, TimothyBlynJacobs, SergeyBiryukov.
Fixes #51378 . See #47896 .
Built from https://develop.svn.wordpress.org/trunk@49060
git-svn-id: http://core.svn.wordpress.org/trunk@48822 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-09-27 08:19:04 +00:00
5c3a734df0
Docs: Correct description for the `taxonomy` parameter of `wp_dropdown_categories()`.
...
Follow-up to [40903], [41767].
Props grapplerulrich, mukesh27, TimothyBlynJacobs.
See #51378 .
Built from https://develop.svn.wordpress.org/trunk@49059
git-svn-id: http://core.svn.wordpress.org/trunk@48821 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-09-27 07:49:06 +00:00
d0a32c5111
Docs: Various docblock corrections and improvements.
...
See #50768
Built from https://develop.svn.wordpress.org/trunk@48941
git-svn-id: http://core.svn.wordpress.org/trunk@48703 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-09-04 20:41:07 +00:00
33b3ea7bfe
Docs: Improve documentation for various category functions.
...
Props atachibana.
Fixes #48394 .
Built from https://develop.svn.wordpress.org/trunk@48623
git-svn-id: http://core.svn.wordpress.org/trunk@48385 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-07-26 17:18:04 +00:00
93429bb561
Coding Standards: Rename the `$id` parameter in various category functions for clarity.
...
See #49542 .
Built from https://develop.svn.wordpress.org/trunk@48622
git-svn-id: http://core.svn.wordpress.org/trunk@48384 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-07-26 16:07:06 +00:00
57a3f803ae
Docs: First pass at some inline docs fixes mostly made by PHPCBF.
...
See #49572 , #50744
Built from https://develop.svn.wordpress.org/trunk@48586
git-svn-id: http://core.svn.wordpress.org/trunk@48348 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-07-23 20:01:04 +00:00
0bf9b04c53
Docs: Various formatting improvements to inline docblocks.
...
See #49572
Built from https://develop.svn.wordpress.org/trunk@48574
git-svn-id: http://core.svn.wordpress.org/trunk@48336 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-07-23 00:52:05 +00:00
58ad216087
Docs: Improve documentation for optional parameters per the documentation standards.
...
See #49572 .
Built from https://develop.svn.wordpress.org/trunk@48197
git-svn-id: http://core.svn.wordpress.org/trunk@47966 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-06-28 11:49:02 +00:00
e13c363b17
Docs: Capitalize "ID", when referring to a post ID, term ID, etc. in a more consistent way.
...
See #49572 .
Built from https://develop.svn.wordpress.org/trunk@48104
git-svn-id: http://core.svn.wordpress.org/trunk@47873 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-06-20 12:02:12 +00:00
de59ad23a4
Docs: Consistently include an empty line between `@since` tag and `@see`, `@link`, or `@global`, per the documentation standards.
...
See #49572 .
Built from https://develop.svn.wordpress.org/trunk@48067
git-svn-id: http://core.svn.wordpress.org/trunk@47834 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-06-16 21:07:14 +00:00
7932193708
Coding Standards: Use strict comparison where static strings are involved.
...
This reduces the number of `WordPress.PHP.StrictComparisons.LooseComparison` issues in half, from 1897 to 890.
Includes minor code layout fixes for better readability.
See #49542 .
Built from https://develop.svn.wordpress.org/trunk@47808
git-svn-id: http://core.svn.wordpress.org/trunk@47584 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-05-16 18:42:12 +00:00
38676936ba
Coding Standards: Use strict type check for `in_array()` and `array_search()` where strings are involved.
...
This reduces the number of `WordPress.PHP.StrictInArray.MissingTrueStrict` issues from 486 to 50.
Includes minor code layout fixes for better readability.
See #49542 .
Built from https://develop.svn.wordpress.org/trunk@47550
git-svn-id: http://core.svn.wordpress.org/trunk@47325 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-04-05 03:02:11 +00:00
ca8463f4f4
Docs: Use third-person singular verbs for function descriptions in `wp-includes/category-template.php`, per the documentation standards.
...
See #49572 .
Built from https://develop.svn.wordpress.org/trunk@47545
git-svn-id: http://core.svn.wordpress.org/trunk@47320 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-04-02 15:51:08 +00:00
641c632b0c
Coding Standards: Use Yoda conditions where appropriate.
...
See #49222 .
Built from https://develop.svn.wordpress.org/trunk@47219
git-svn-id: http://core.svn.wordpress.org/trunk@47019 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-02-09 16:55:09 +00:00
001ffe81fb
Docs: Improve inline comments per the documentation standards.
...
Includes minor code layout fixes for better readability.
See #48303 .
Built from https://develop.svn.wordpress.org/trunk@47122
git-svn-id: http://core.svn.wordpress.org/trunk@46922 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-01-29 00:45:18 +00:00
6cf32058ff
Docs: Expand `@return` description for `the_terms()`.
...
See #48303 .
Built from https://develop.svn.wordpress.org/trunk@47103
git-svn-id: http://core.svn.wordpress.org/trunk@46903 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-01-22 00:41:06 +00:00
dd79e6e107
Docs: Correct DocBlock formatting for filters accepting the `$parsed_args` parameter.
...
Follow-up to [45667].
See #48303 .
Built from https://develop.svn.wordpress.org/trunk@47096
git-svn-id: http://core.svn.wordpress.org/trunk@46896 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-01-21 15:41:04 +00:00
dd4d98a368
Docs: In various `@return` tags, list the expected type first, instead of `false`.
...
Follow-up to [46696].
See #48303 .
Built from https://develop.svn.wordpress.org/trunk@47060
git-svn-id: http://core.svn.wordpress.org/trunk@46860 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-01-11 18:32:05 +00:00
f93ee2ca76
Docs: Increase the specificity of various docblock parameter types and return types.
...
See #48303
Built from https://develop.svn.wordpress.org/trunk@46823
git-svn-id: http://core.svn.wordpress.org/trunk@46623 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-12-06 22:43:04 +00:00
8d1e51e9c7
Docs: Add a `@since` note about new parameters with the spread operator added to function signatures.
...
Props jrf.
See #47678 .
Built from https://develop.svn.wordpress.org/trunk@46451
git-svn-id: http://core.svn.wordpress.org/trunk@46249 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-10-09 04:28:02 +00:00
654f8a8677
Code Modernisation: Introduce the spread operator in `wp-includes/category-template.php`.
...
Rather than relying `func_get_args()` to retrieve arbitrary function arguments, we can now use the spread operator to assign them directly to a variable.
Props jrf.
See #47678 .
Built from https://develop.svn.wordpress.org/trunk@46123
git-svn-id: http://core.svn.wordpress.org/trunk@45935 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-09-15 10:33:55 +00:00
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
16b8d91baa
I18N: Improve translator comments.
...
* Add missing translator comments.
* Fix placement of some translator comments. Translator comments should be on the line directly above the line containing the translation function call for optimal compatibility with various `.pot` file generation tools. The CS auto-fixing, which changed some inconsistent function calls to multi-line function calls, is part of the reason why this was no longer the case for a select group of translator comments.
Includes minor code layout fixes.
Polyglots, rejoice! All WordPress core files now have translator comments for all strings with placeholders!
Props jrf, subrataemfluence, GaryJ, webdados, Dency, swissspidy, alvarogois, marcomartins, mihaiiceyro, vladwtz, niq1982, flipkeijzer, michielatyoast, chandrapatel, thrijith, joshuanoyce, FesoVik, tessak22, bhaktirajdev, cleancoded, dhavalkasvala, garrett-eclipse, bibliofille, socalchristina, priyankkpatel, 5hel2l2y, adamsilverstein, JeffPaul, pierlo, SergeyBiryukov.
Fixes #44360 .
Built from https://develop.svn.wordpress.org/trunk@45926
git-svn-id: http://core.svn.wordpress.org/trunk@45737 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-09-01 17:13:59 +00:00
baffd21844
Docs: Reference `WP_Term_Query::__construct()` in `wp_list_categories()` DocBlock for additional accepted arguments.
...
Clarify that `wp_dropdown_categories()` always returns a string, regardless of the `echo` parameter.
See #47896 , #47110 .
Built from https://develop.svn.wordpress.org/trunk@45895
git-svn-id: http://core.svn.wordpress.org/trunk@45706 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-08-26 17:00:55 +00:00
d1ac7170dc
Taxonomy: Standardize docs for `wp_list_categories()`.
...
Many of the parameters historically documented on this function are merely
passed through to `get_categories()` and its underlying functions. In order to
avoid unnecessary duplication of function arguments, we remove documentation of
these parameters, and replace it with reference to the wrapped functions.
Parameters that receive special treatment or are otherwise changed before
being passed through continue to be documented as part of `wp_list_categories()`.
Props audrasjb, itowhid06, birgire.
Fixes #47896 .
Built from https://develop.svn.wordpress.org/trunk@45894
git-svn-id: http://core.svn.wordpress.org/trunk@45705 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-08-26 15:24:55 +00:00
b1e34ccc1f
Docs: Add missing description for `$wp_rewrite` global.
...
See #45604 , #47110 .
Built from https://develop.svn.wordpress.org/trunk@45735
git-svn-id: http://core.svn.wordpress.org/trunk@45546 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-08-04 01:19:56 +00:00
c26f1c5d90
Taxonomy: Fix deprecated calls to `get_terms()`.
...
The taxonomy should be passed as part of `$args`, rather than as its own argument.
Props sgastard, mukesh27, SergeyBiryukov.
Fixes #47819 .
Built from https://develop.svn.wordpress.org/trunk@45723
git-svn-id: http://core.svn.wordpress.org/trunk@45534 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-08-03 03:35:56 +00:00
5522be31e7
Coding Standards: Use correct variable in `wp_dropdown_categories()` after [45667].
...
See #45059 .
Built from https://develop.svn.wordpress.org/trunk@45668
git-svn-id: http://core.svn.wordpress.org/trunk@45479 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-07-25 01:07:54 +00:00
18bd01985b
Coding Standards: Rename `$r` variable used with `wp_parse_args()` to `$parsed_args` for clarity.
...
Props freewebmentor.
Fixes #45059 .
Built from https://develop.svn.wordpress.org/trunk@45667
git-svn-id: http://core.svn.wordpress.org/trunk@45478 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-07-25 00:48:58 +00:00
a02b5cc2a8
Coding Standards: Mark the handful of hook names with uppercase characters or hyphens as ignored.
...
See #47632 .
Built from https://develop.svn.wordpress.org/trunk@45599
git-svn-id: http://core.svn.wordpress.org/trunk@45410 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-07-05 01:45:56 +00:00
4803fc405e
Coding Standards: Fix the `Squiz.PHP.DisallowMultipleAssignments` violations in `wp-includes`.
...
See #47632 .
Built from https://develop.svn.wordpress.org/trunk@45590
git-svn-id: http://core.svn.wordpress.org/trunk@45401 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-07-02 23:42:58 +00:00
55af0f0d0a
Coding Standards: Fix/ignore the `WordPress.NamingConventions.ValidFunctionName` violations.
...
See #47632
Built from https://develop.svn.wordpress.org/trunk@45580
git-svn-id: http://core.svn.wordpress.org/trunk@45391 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-07-01 08:01:57 +00:00
3a697f7f46
Coding Standards: Remove an unnecessary line whitelisting.
...
Props jrf.
See #45934 .
Built from https://develop.svn.wordpress.org/trunk@44572
git-svn-id: http://core.svn.wordpress.org/trunk@44403 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-01-12 04:53:51 +00:00
57fcb7d8dd
Coding Standards: Fix an incorrect `phpcs:ignore` comment.
...
It's `phpcs:ignore`, not `wpcs:ignore`.
Props GaryJ.
See #45934 .
Built from https://develop.svn.wordpress.org/trunk@44570
git-svn-id: http://core.svn.wordpress.org/trunk@44401 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-01-12 03:49:49 +00:00
c008959e9e
Coding Standards: Fix the minor `WordPress.WP.I18n` violations.
...
`WordPress.WP.I18n.MissingTranslatorsComment` is in progress in #44360 .
See #45934 .
Built from https://develop.svn.wordpress.org/trunk@44562
git-svn-id: http://core.svn.wordpress.org/trunk@44393 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-01-11 06:04:49 +00:00
56c162fbc9
Coding Standards: Upgrade WPCS to 1.0.0
...
WPCS 1.0.0 includes a bunch of new auto-fixers, which drops the number of coding standards issues across WordPress significantly. Prior to running the auto-fixers, there were 15,312 issues detected. With this commit, we now drop to 4,769 issues.
This change includes three notable additions:
- Multiline function calls must now put each parameter on a new line.
- Auto-formatting files is now part of the `grunt precommit` script.
- Auto-fixable coding standards issues will now cause Travis failures.
Fixes #44600 .
Built from https://develop.svn.wordpress.org/trunk@43571
git-svn-id: http://core.svn.wordpress.org/trunk@43400 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2018-08-17 01:51:36 +00:00
9a11487e22
Taxonomy: In `category_description()`, don't pass the `$taxonomy` parameter to `term_description()`.
...
The parameter was deprecated in [42368] and is now unused.
Props chetan200891.
Fixes #43381 . See #42771 .
Built from https://develop.svn.wordpress.org/trunk@42890
git-svn-id: http://core.svn.wordpress.org/trunk@42720 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2018-03-28 23:25:29 +00:00
bbcb4300a3
Docs: Correct and improve various inline documentation.
...
See #42505
Built from https://develop.svn.wordpress.org/trunk@42877
git-svn-id: http://core.svn.wordpress.org/trunk@42707 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2018-03-25 19:35:29 +00:00
b13e73d05c
Docs: Document more parameters and properties using typed array notation.
...
See #41756
Built from https://develop.svn.wordpress.org/trunk@42875
git-svn-id: http://core.svn.wordpress.org/trunk@42705 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2018-03-25 18:10:32 +00:00
John Blackbourn
Sergey Biryukov
Boone Gorges
Gary Pendergast