John Blackbourn
41995176f6
Docs: Miscellaneous inline documentation improvements, including:
...
* Document the post statuses global as an array of `stdClass` objects
* Document the taxonomies global as an array of `WP_Taxonomy` objects
* Document the return value of the post count functions as `stdClass` objects
* Fix some typos
See #53399
Built from https://develop.svn.wordpress.org/trunk@51885
git-svn-id: http://core.svn.wordpress.org/trunk@51478 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-10-04 20:44:02 +00:00
John Blackbourn
a4bdae8122
Docs: Add missing documentation for the minute
parameter of WP_Query
.
...
See #53399
Built from https://develop.svn.wordpress.org/trunk@51514
git-svn-id: http://core.svn.wordpress.org/trunk@51125 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-07-30 10:53:58 +00:00
John Blackbourn
ab9ed33f1d
Docs: Correct the documented allowed range for the minute
and second
parameters of WP_Query
.
...
These are correctly documented and validated in `WP_Date_Query` as 0-59.
See #53399
Built from https://develop.svn.wordpress.org/trunk@51513
git-svn-id: http://core.svn.wordpress.org/trunk@51124 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-07-30 10:23:57 +00:00
John Blackbourn
e4cfebe92e
Docs: Undo the accidental revert of [51299] made in [51300].
...
See #53399
Built from https://develop.svn.wordpress.org/trunk@51301
git-svn-id: http://core.svn.wordpress.org/trunk@50910 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-07-01 21:29:56 +00:00
John Blackbourn
ea60cd8191
Docs: Descriptive improvements and corrections for various docblocks.
...
See #53399
Built from https://develop.svn.wordpress.org/trunk@51300
git-svn-id: http://core.svn.wordpress.org/trunk@50909 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-07-01 21:12:58 +00:00
John Blackbourn
9146628ae1
Docs: Miscellaneous formatting corrections for docblocks.
...
See #53399
Built from https://develop.svn.wordpress.org/trunk@51299
git-svn-id: http://core.svn.wordpress.org/trunk@50908 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-07-01 21:10:56 +00:00
Sergey Biryukov
e7b6a4dce8
Coding Standards: Remove redundant type casting to array in WP_Query::get_posts()
.
...
This brings some consistency with other instances of using `get_post_stati()` in core.
`get_post_stati()` always returns an array, so the type casting is not needed.
Follow-up to [13172].
See #53359 .
Built from https://develop.svn.wordpress.org/trunk@51285
git-svn-id: http://core.svn.wordpress.org/trunk@50894 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-06-30 17:44:58 +00:00
Peter Wilson
4c598d36b1
Query: Check each post-type's capabilities when querying multiple post-types.
...
When querying multiple post types, check the `read_private_posts` capability for each post type when determining which post statuses to return. This ensures private posts appear in search results and archives for users permitted to read them.
Props leogermani, hellofromTonya, jeffpaul, peterwilsoncc.
Fixes #48556 .
Built from https://develop.svn.wordpress.org/trunk@51276
git-svn-id: http://core.svn.wordpress.org/trunk@50885 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-06-30 05:00:56 +00:00
Sergey Biryukov
d6cc4f1aec
Query: Consistently include a space in parentheses in WP_Meta_Query::get_sql_for_clause()
.
...
Props jillebehm, kaavyaiyer, hareesh-pillai.
Fixes #49279 .
Built from https://develop.svn.wordpress.org/trunk@50576
git-svn-id: http://core.svn.wordpress.org/trunk@50189 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-03-25 12:39:07 +00:00
Sergey Biryukov
d5a6a1ab44
Taxonomy: Use a consistent check for the $rewrite['hierarchical']
parameter.
...
This avoids a "Trying to access array offset on value of type bool" PHP warning in `get_term_link()` if the `$rewrite` parameter of `register_taxonomy()` is set as `false`.
Props Tkama, SergeyBiryukov.
Fixes #52882 .
Built from https://develop.svn.wordpress.org/trunk@50565
git-svn-id: http://core.svn.wordpress.org/trunk@50178 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-03-23 13:55:03 +00:00
John Blackbourn
6f3a940e64
Plugins: Replace usage of $this
in action and filter parameter docblocks with more appropriate variable names.
...
See #51800 , #52217
Fixes #52243
Built from https://develop.svn.wordpress.org/trunk@49946
git-svn-id: http://core.svn.wordpress.org/trunk@49645 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-01-08 14:30:14 +00:00
John Blackbourn
dfe1f9b322
Docs: Promote many bool
types to true
or false
where only that value is used.
...
See #51800
Built from https://develop.svn.wordpress.org/trunk@49927
git-svn-id: http://core.svn.wordpress.org/trunk@49626 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-01-03 22:04:04 +00:00
Peter Wilson
aaf7710529
Query: Revert post-type specific capability changes.
...
The modified checks of the `read_private_posts` capability could result in unexpected SQL queries when calling `WP_Query` with invalid parameters.
Reverts [49830], [49832] and [49833].
See #48556 .
Built from https://develop.svn.wordpress.org/trunk@49899
git-svn-id: http://core.svn.wordpress.org/trunk@49598 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-12-23 03:02:06 +00:00
Peter Wilson
08acf6606a
Coding Standards: Minor fixes following [49830].
...
See #13509 , #48968 , #48556 .
Built from https://develop.svn.wordpress.org/trunk@49832
git-svn-id: http://core.svn.wordpress.org/trunk@49551 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-12-18 00:19:05 +00:00
Boone Gorges
f124a2e529
Query: Respect post-type specific capabilities when querying for multiple post types.
...
After this change, the relevant `read_private_posts` capability is checked for
each queried post type. This ensures that private posts appear in search and
archive queries for users who have the ability to view those posts.
Props leogermani.
Fixes #13509 , #48968 , #48556 .
Built from https://develop.svn.wordpress.org/trunk@49830
git-svn-id: http://core.svn.wordpress.org/trunk@49549 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-12-17 16:17:07 +00:00
Sergey Biryukov
43bbbf1176
Docs: Document the usage of $wpdb
global in WP_Query::get_posts()
and ::set_found_posts()
.
...
Props jontyravi.
Fixes #52027 .
Built from https://develop.svn.wordpress.org/trunk@49792
git-svn-id: http://core.svn.wordpress.org/trunk@49515 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-12-11 16:53:10 +00:00
John Blackbourn
42fcfa5b3d
Docs: Various docblock corrections.
...
See #51800
Built from https://develop.svn.wordpress.org/trunk@49789
git-svn-id: http://core.svn.wordpress.org/trunk@49512 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-12-10 23:53:07 +00:00
John Blackbourn
40b738335b
Docs: Corrections and improvements to docs for properties of the WP_Query
class.
...
This also adds additional type hinting inside some methods to help IDEs.
See #51800
Built from https://develop.svn.wordpress.org/trunk@49700
git-svn-id: http://core.svn.wordpress.org/trunk@49423 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-11-26 17:04:06 +00:00
John Blackbourn
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
John Blackbourn
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
Sergey Biryukov
ee7ff18b54
Docs: Improve documentation for WP_Query::is_archive()
per the documentation standards.
...
Follow-up to [49504].
See #50545 .
Built from https://develop.svn.wordpress.org/trunk@49506
git-svn-id: http://core.svn.wordpress.org/trunk@49261 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-11-05 09:44:05 +00:00
Sergey Biryukov
f22633f20b
Docs: Consistently place @see
tags after @since
in WP_Query
methods, per the documentation standards.
...
See #50768 .
Built from https://develop.svn.wordpress.org/trunk@49505
git-svn-id: http://core.svn.wordpress.org/trunk@49260 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-11-05 09:42:10 +00:00
Helen Hou-Sandí
cc74786052
General: Make some inline comments more descriptive.
...
Props jorbin.
Fixes #51683 .
Built from https://develop.svn.wordpress.org/trunk@49474
git-svn-id: http://core.svn.wordpress.org/trunk@49233 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-11-02 18:04:07 +00:00
Sergey Biryukov
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
John Blackbourn
6b7ba33d68
Docs: Fix the types for some properties and parameters that use the generic object
type.
...
See #50768
Built from https://develop.svn.wordpress.org/trunk@49119
git-svn-id: http://core.svn.wordpress.org/trunk@48881 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-10-10 19:14:04 +00:00
Sergey Biryukov
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
Sergey Biryukov
2670a6ad14
Docs: Synchronize descriptions of some query functions and their counterpart methods in WP
and WP_Query
classes:
...
* `set_query_var()`
* `get_query_var()`
* `get_queried_object()`
* `get_queried_object_id()`
Switch to third-person singular verbs, per the documentation standards.
See #50768 , #42783 .
Built from https://develop.svn.wordpress.org/trunk@49095
git-svn-id: http://core.svn.wordpress.org/trunk@48857 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-10-06 08:59:04 +00:00
Sergey Biryukov
b66ff2f68d
Docs: Fix typo in *_pre_query
filter DocBlocks.
...
See #50768 .
Built from https://develop.svn.wordpress.org/trunk@48985
git-svn-id: http://core.svn.wordpress.org/trunk@48747 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-09-17 10:45:03 +00:00
Sergey Biryukov
7c60a660f1
Code Modernization: Correct the check for negative post IDs in WP_Query::parse_query()
to work as expected on PHP 8.
...
PHP 8 changes the way string to number comparisons are performed: https://wiki.php.net/rfc/string_to_number_comparison
In particular, checking if an empty string is less than zero in PHP 8 evaluates to `true`, not `false`.
For `WP_Query`, this resulted in unintentionally returning a 404 error for most of front-end requests, instead of the relevant content.
By explicitly casting the value to `int`, we make sure to compare both values as numbers, rather than a string and a number.
Follow-up to [38288].
Props trepmal.
See #50913 .
Built from https://develop.svn.wordpress.org/trunk@48960
git-svn-id: http://core.svn.wordpress.org/trunk@48722 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-09-09 02:35:06 +00:00
Sergey Biryukov
7a8df073cd
Docs: Correct alignment for some DocBlocks in WP_Query::get_posts()
.
...
See #50768 .
Built from https://develop.svn.wordpress.org/trunk@48816
git-svn-id: http://core.svn.wordpress.org/trunk@48578 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-08-18 12:39:03 +00:00
John Blackbourn
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
John Blackbourn
124972f2c6
Docs: Further corrections and improvements to various inline docblocks.
...
See #49572
Built from https://develop.svn.wordpress.org/trunk@48576
git-svn-id: http://core.svn.wordpress.org/trunk@48338 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-07-23 07:39:02 +00:00
Sergey Biryukov
da43de528f
Docs: Correct type and improve description for the $fields
parameter of WP_Query::parse_query()
.
...
Props ocean90, palmiak, johannadevos, noisysocks.
Fixes #44305 .
Built from https://develop.svn.wordpress.org/trunk@48563
git-svn-id: http://core.svn.wordpress.org/trunk@48325 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-07-22 11:37:02 +00:00
John Blackbourn
6b21db7fb9
Docs: Miscellaneous docblock corrections and improvements.
...
See #49572
Built from https://develop.svn.wordpress.org/trunk@48462
git-svn-id: http://core.svn.wordpress.org/trunk@48231 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-07-13 22:10:07 +00:00
Sergey Biryukov
8ef38d34fc
Docs: Improve @return
tags for various conditional tags.
...
Props stevenlinx, SergeyBiryukov.
Fixes #50626 .
Built from https://develop.svn.wordpress.org/trunk@48426
git-svn-id: http://core.svn.wordpress.org/trunk@48195 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-07-10 20:23:06 +00:00
Sergey Biryukov
3311bc8783
Docs: Improve documentation for have_posts()
, have_comments()
, and their WP_Query
counterparts.
...
Props stevenlinx.
Fixes #50610 .
Built from https://develop.svn.wordpress.org/trunk@48406
git-svn-id: http://core.svn.wordpress.org/trunk@48175 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-07-08 11:11:04 +00:00
Sergey Biryukov
4e3bad1770
Query: Make sure the found_posts
property of WP_Query
is always an integer, to match the documented type.
...
This makes the property consistent with similar properties of other classes:
* `WP_Comment_Query::$found_comments`
* `WP_Network_Query::$found_networks`
* `WP_Site_Query::$found_sites`
* `WP_User_Query::$total_users`
Props birgire, PressLabs.
Fixes #42469 .
Built from https://develop.svn.wordpress.org/trunk@48328
git-svn-id: http://core.svn.wordpress.org/trunk@48097 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-07-05 21:34:02 +00:00
Sergey Biryukov
e0d440f77f
Posts, Post Types: Avoid a PHP warning when get_the_content()
is called outside of the loop.
...
This ensures that `$pages` and other globals are only used after they have been set up in `setup_postdata()`.
Follow-up to [44941].
Props tessawatkinsllc, dontdream, spacedmonkey, squarecandy, davidbaumwald, SergeyBiryukov.
Fixes #47824 . See #42814 .
Built from https://develop.svn.wordpress.org/trunk@48114
git-svn-id: http://core.svn.wordpress.org/trunk@47883 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-06-21 10:36:07 +00:00
Sergey Biryukov
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
John Blackbourn
1a77bb81d8
Docs: Remove unnecessary variables names from @return
tags.
...
See #49572 .
Built from https://develop.svn.wordpress.org/trunk@48100
git-svn-id: http://core.svn.wordpress.org/trunk@47869 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-06-19 22:55:12 +00:00
Sergey Biryukov
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
whyisjake
ea8331f00d
REST API: Allow queries other than the main query to be is_home
.
...
Ensure that REST API calls can match the main query of the page.
See #34373 .
Fixes #50213 .
Props: dlh, TimothyBlynJacobs, boonebgorges, joemcgill, whyisjake.
Built from https://develop.svn.wordpress.org/trunk@48053
git-svn-id: http://core.svn.wordpress.org/trunk@47820 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-06-16 06:04:12 +00:00
Sergey Biryukov
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
whyisjake
3ee9488292
Query: Ensure that only a single post can be returned on date/time based queries.
...
Props: sstoqnov, peterwilsoncc.
Built from https://develop.svn.wordpress.org/trunk@47635
git-svn-id: http://core.svn.wordpress.org/trunk@47410 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-04-29 15:28:04 +00:00
Sergey Biryukov
856e1a27b8
Coding Standards: Use strict type check for in_array()
and array_search()
.
...
This addresses all the remaining `WordPress.PHP.StrictInArray.MissingTrueStrict` issues in core.
Includes minor code layout fixes for better readability.
Follow-up to [47550].
See #49542 .
Built from https://develop.svn.wordpress.org/trunk@47557
git-svn-id: http://core.svn.wordpress.org/trunk@47332 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-04-09 15:43:10 +00:00
Sergey Biryukov
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
John Blackbourn
33d4f0573c
Query: Introduce an action which gets fired when a 404 is triggered.
...
Fixes #48061
Built from https://develop.svn.wordpress.org/trunk@47509
git-svn-id: http://core.svn.wordpress.org/trunk@47284 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-03-26 17:43:07 +00:00
Sergey Biryukov
e041a3a8f3
Docs: Use more specific type in parameter descriptions for is_page()
, is_single()
, is_singular()
, and their WP_Query
counterpart methods.
...
Props marekdedic, shaharia.azam, shaampk1.
Fixes #48354 . See #48303 .
Built from https://develop.svn.wordpress.org/trunk@47402
git-svn-id: http://core.svn.wordpress.org/trunk@47189 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-03-01 17:29:06 +00:00
Sergey Biryukov
abce2d8d6c
Docs: Synchronize parameter descriptions for conditional tags with their WP_Query
counterpart methods.
...
See #48354 , #48303 .
Built from https://develop.svn.wordpress.org/trunk@47401
git-svn-id: http://core.svn.wordpress.org/trunk@47188 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-03-01 17:21:06 +00:00
John Blackbourn
056dad9c2c
Docs: Use more specific types in parameter descriptions in place of mixed
.
...
See #48303 .
Built from https://develop.svn.wordpress.org/trunk@47397
git-svn-id: http://core.svn.wordpress.org/trunk@47184 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-03-01 10:38:07 +00:00