John Blackbourn
679ccc35e6
Docs: Promote many bool types to true or false where only that value is used.
...
See #51800
git-svn-id: https://develop.svn.wordpress.org/trunk@49927 602fd350-edb4-49c9-b593-d223f7449a82
2021-01-03 22:02:13 +00:00
John Blackbourn
6b1440e29a
Docs: Standardise the type name for booleans and integers.
...
This brings these docs inline with the documentation standards.
Props ravipatel, justinahinon
Fixes #51426
git-svn-id: https://develop.svn.wordpress.org/trunk@49120 602fd350-edb4-49c9-b593-d223f7449a82
2020-10-10 20:00:30 +00:00
Sergey Biryukov
79703088c4
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 .
git-svn-id: https://develop.svn.wordpress.org/trunk@49108 602fd350-edb4-49c9-b593-d223f7449a82
2020-10-08 21:13:57 +00:00
Sergey Biryukov
a1c40b346c
Docs: Improve documentation for WP_Http::processHeaders().
...
Document the `@return` value using hash notation.
Props marekdedic, valchovski, davidbaumwald, deepaklalwani, thimalw, SergeyBiryukov.
Fixes #48350 .
git-svn-id: https://develop.svn.wordpress.org/trunk@48630 602fd350-edb4-49c9-b593-d223f7449a82
2020-07-26 22:43:47 +00:00
John Blackbourn
285fa03b3a
Docs: First pass at some inline docs fixes mostly made by PHPCBF.
...
See #49572 , #50744
git-svn-id: https://develop.svn.wordpress.org/trunk@48586 602fd350-edb4-49c9-b593-d223f7449a82
2020-07-23 19:59:16 +00:00
John Blackbourn
f36c42c700
Docs: Miscellaneous docblock corrections and improvements.
...
See #49572
git-svn-id: https://develop.svn.wordpress.org/trunk@48462 602fd350-edb4-49c9-b593-d223f7449a82
2020-07-13 22:08:16 +00:00
Sergey Biryukov
cdf3431ac9
Docs: Remove @staticvar tags from core.
...
The tag was supported in phpDocumentor 1.x, but is no longer supported in 2.x and 3.x.
Usage of static variables is considered an internal implementation detail and has no information value for someone reading the docs.
Props alishanvr, jrf.
Fixes #50426 .
git-svn-id: https://develop.svn.wordpress.org/trunk@48109 602fd350-edb4-49c9-b593-d223f7449a82
2020-06-20 12:38:55 +00:00
Sergey Biryukov
806c94fe0a
Docs: Remove an empty line between @param and @return tags, per the documentation standards.
...
See #49572 .
git-svn-id: https://develop.svn.wordpress.org/trunk@48102 602fd350-edb4-49c9-b593-d223f7449a82
2020-06-20 11:16:12 +00:00
Sergey Biryukov
3bdf8b7b02
Docs: Consistently include an empty line between @since tag and @see, @link, or @global, per the documentation standards.
...
See #49572 .
git-svn-id: https://develop.svn.wordpress.org/trunk@48067 602fd350-edb4-49c9-b593-d223f7449a82
2020-06-16 21:05:20 +00:00
Sergey Biryukov
6742d0d7a6
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 .
git-svn-id: https://develop.svn.wordpress.org/trunk@47808 602fd350-edb4-49c9-b593-d223f7449a82
2020-05-16 18:40:52 +00:00
Sergey Biryukov
055d1c6749
Code Modernization: Remove error suppression from parse_url() calls.
...
Previously, the `@` operator was used to prevent possible warnings emitted by `parse_url()` in PHP < 5.3.3 when URL parsing failed.
Now that the minimum version of PHP required by WordPress is 5.6.20, this is no longer needed.
Props netpassprodsr, Howdy_McGee.
Fixes #49980 . See #24780 .
git-svn-id: https://develop.svn.wordpress.org/trunk@47617 602fd350-edb4-49c9-b593-d223f7449a82
2020-04-24 07:26:57 +00:00
Sergey Biryukov
d8c502e966
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 .
git-svn-id: https://develop.svn.wordpress.org/trunk@47557 602fd350-edb4-49c9-b593-d223f7449a82
2020-04-09 15:41:04 +00:00
Sergey Biryukov
0b4e2c4604
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 .
git-svn-id: https://develop.svn.wordpress.org/trunk@47550 602fd350-edb4-49c9-b593-d223f7449a82
2020-04-05 03:00:44 +00:00
Sergey Biryukov
84764d4cee
Docs: Add a @staticvar entry for $transports in WP_Http::_dispatch_request().
...
Props utsav72640.
Fixes #48774 .
git-svn-id: https://develop.svn.wordpress.org/trunk@47346 602fd350-edb4-49c9-b593-d223f7449a82
2020-02-22 19:10:47 +00:00
Sergey Biryukov
130751cda3
Coding Standards: Use Yoda conditions where appropriate.
...
See #49222 .
git-svn-id: https://develop.svn.wordpress.org/trunk@47219 602fd350-edb4-49c9-b593-d223f7449a82
2020-02-09 16:52:28 +00:00
Sergey Biryukov
e72fff9cef
Code Modernization: Replace dirname( __FILE__ ) calls with __DIR__ magic constant.
...
This avoids the performance overhead of the function call every time `dirname( __FILE__ )` was used instead of `__DIR__`.
This commit also includes:
* Removing unnecessary parentheses from `include`/`require` statements. These are language constructs, not function calls.
* Replacing `include` statements for several files with `require_once`, for consistency:
* `wp-admin/admin-header.php`
* `wp-admin/admin-footer.php`
* `wp-includes/version.php`
Props ayeshrajans, desrosj, valentinbora, jrf, joostdevalk, netweb.
Fixes #48082 .
git-svn-id: https://develop.svn.wordpress.org/trunk@47198 602fd350-edb4-49c9-b593-d223f7449a82
2020-02-06 06:31:22 +00:00
Sergey Biryukov
73e75195eb
Docs: Add more specific description for WP_Http::processResponse() return value.
...
Props marekdedic, takeshifurusato.
Fixes #48351 .
git-svn-id: https://develop.svn.wordpress.org/trunk@47161 602fd350-edb4-49c9-b593-d223f7449a82
2020-02-02 03:25:57 +00:00
Sergey Biryukov
cfc3b57488
Docs: Improve inline comments per the documentation standards.
...
Includes minor code layout fixes for better readability.
See #48303 .
git-svn-id: https://develop.svn.wordpress.org/trunk@47122 602fd350-edb4-49c9-b593-d223f7449a82
2020-01-29 00:43:23 +00:00
Sergey Biryukov
79391187c9
Docs: Correct DocBlock formatting for filters accepting the $parsed_args parameter.
...
Follow-up to [45667].
See #48303 .
git-svn-id: https://develop.svn.wordpress.org/trunk@47096 602fd350-edb4-49c9-b593-d223f7449a82
2020-01-21 15:39:17 +00:00
Sergey Biryukov
4c2ee4e9ff
Docs: In various @return tags, list the expected type first, instead of false.
...
Follow-up to [46696].
See #48303 .
git-svn-id: https://develop.svn.wordpress.org/trunk@47060 602fd350-edb4-49c9-b593-d223f7449a82
2020-01-11 18:30:58 +00:00
Sergey Biryukov
7261695f7d
Docs: Correct @type for timeout argument in WP_Http::request().
...
Props georgestephanis, benedictsinger.
Fixes #49005 .
git-svn-id: https://develop.svn.wordpress.org/trunk@46970 602fd350-edb4-49c9-b593-d223f7449a82
2019-12-17 15:23:33 +00:00
Sergey Biryukov
a31133173d
Coding Standards: Fix WPCS issue in [46690].
...
See #41880 .
git-svn-id: https://develop.svn.wordpress.org/trunk@46692 602fd350-edb4-49c9-b593-d223f7449a82
2019-11-10 01:43:55 +00:00
Sergey Biryukov
99132f8abc
Docs: Improve documentation for WP_Http per the documentation standards.
...
Props hareesh-pillai, adnan.limdi, isabel_brison.
Fixes #41880 .
git-svn-id: https://develop.svn.wordpress.org/trunk@46690 602fd350-edb4-49c9-b593-d223f7449a82
2019-11-10 01:17:00 +00:00
John Blackbourn
4f281f1650
Docs: Switch more docs over to typed array notation, plus some fixes.
...
See #48303 , #41756
git-svn-id: https://develop.svn.wordpress.org/trunk@46596 602fd350-edb4-49c9-b593-d223f7449a82
2019-10-26 21:07:10 +00:00
John Blackbourn
cda19de292
Docs: Fix and improve inline documentation for the HTTP API.
...
See #47110
git-svn-id: https://develop.svn.wordpress.org/trunk@46468 602fd350-edb4-49c9-b593-d223f7449a82
2019-10-12 18:03:22 +00:00
John Blackbourn
86b0faf219
Docs: Miscellaneous inline docs corrections and improvements.
...
See #47110
git-svn-id: https://develop.svn.wordpress.org/trunk@46424 602fd350-edb4-49c9-b593-d223f7449a82
2019-10-07 19:06:41 +00:00
John Blackbourn
6bd7097626
Docs: Docblock corrections and improvements, mostly related to various pre_* filters.
...
See #47110
git-svn-id: https://develop.svn.wordpress.org/trunk@46232 602fd350-edb4-49c9-b593-d223f7449a82
2019-09-21 17:40:58 +00:00
Sergey Biryukov
e5a0610d53
Coding Standards: Rename $r variable used with wp_parse_args() to $parsed_args for clarity.
...
Props freewebmentor.
Fixes #45059 .
git-svn-id: https://develop.svn.wordpress.org/trunk@45667 602fd350-edb4-49c9-b593-d223f7449a82
2019-07-25 00:47:53 +00:00
Gary Pendergast
4503f93961
Coding Standards: Fix the Squiz.PHP.DisallowMultipleAssignments violations in wp-includes.
...
See #47632 .
git-svn-id: https://develop.svn.wordpress.org/trunk@45590 602fd350-edb4-49c9-b593-d223f7449a82
2019-07-02 23:41:16 +00:00
Gary Pendergast
ef5a9dfda6
Coding Standards: Fix/ignore the WordPress.NamingConventions.ValidFunctionName violations.
...
See #47632
git-svn-id: https://develop.svn.wordpress.org/trunk@45580 602fd350-edb4-49c9-b593-d223f7449a82
2019-07-01 08:00:12 +00:00
johnbillion
ea0a34c649
HTTP API: Ensure the http_api_debug hook is fired for all responses.
...
This means that logging and debugging functionality can access the error code and error message for erroneous responses under all conditions. The hook is not fired when a request is short-circuited with the `pre_http_request` filter, because this filter itself can be used in that situation.
Fixes #25747
git-svn-id: https://develop.svn.wordpress.org/trunk@45504 602fd350-edb4-49c9-b593-d223f7449a82
2019-06-08 17:09:02 +00:00
Gary Pendergast
3652d05fcf
HTTP: Add support for the host-only flag to Wp_Http_Cookie.
...
Props soulseekah.
Fixes #43231 .
git-svn-id: https://develop.svn.wordpress.org/trunk@45135 602fd350-edb4-49c9-b593-d223f7449a82
2019-04-08 05:31:35 +00:00
Jonathan Desrosiers
ce6fc7a8f4
Docs: Update since annotation for new $url parameter for several HTTP related filters.
...
Introduced in [42682].
Fixes #42186 .
git-svn-id: https://develop.svn.wordpress.org/trunk@44397 602fd350-edb4-49c9-b593-d223f7449a82
2019-01-04 21:57:06 +00:00
Sergey Biryukov
a5e6c8a7d8
Docs: Update @deprecated tag for WP_Http::_dispatch_request(). See [42766].
...
Fixes #43414 .
git-svn-id: https://develop.svn.wordpress.org/trunk@44346 602fd350-edb4-49c9-b593-d223f7449a82
2018-12-20 01:58:13 +00:00
John Blackbourn
6449cc7970
Docs: Add missing HTTP methods to the list of those supported.
...
See #42505
git-svn-id: https://develop.svn.wordpress.org/trunk@43258 602fd350-edb4-49c9-b593-d223f7449a82
2018-05-14 15:22:45 +00:00
John Blackbourn
cf400b9bc4
Docs: Correct and improve various inline documentation.
...
See #42505
git-svn-id: https://develop.svn.wordpress.org/trunk@42877 602fd350-edb4-49c9-b593-d223f7449a82
2018-03-25 19:34:31 +00:00
Sergey Biryukov
b15919c8dd
Docs: Mark WP_Http::_dispatch_request() as deprecated. It's no longer used since [37428].
...
Fixes #43414 .
git-svn-id: https://develop.svn.wordpress.org/trunk@42766 602fd350-edb4-49c9-b593-d223f7449a82
2018-02-28 03:47:14 +00:00
Sergey Biryukov
ba26942df6
Docs: Remove erroneous @static notation from WP_Http::_dispatch_request(), added in [32650].
...
The method was never user as static.
Props birgire.
See #42803 .
git-svn-id: https://develop.svn.wordpress.org/trunk@42751 602fd350-edb4-49c9-b593-d223f7449a82
2018-02-25 21:34:09 +00:00
Sergey Biryukov
1bd0df76cf
Docs: Remove duplicated DocBlock for http_response hook in WP_Http::_dispatch_request().
...
The filter is already documented in `WP_Http::request()`.
See #42505 .
git-svn-id: https://develop.svn.wordpress.org/trunk@42750 602fd350-edb4-49c9-b593-d223f7449a82
2018-02-25 21:31:26 +00:00
Sergey Biryukov
c6c4edb47a
Docs: Remove @static notations from method DocBlocks in wp-includes/* classes.
...
This tag has been used in the past, but should no longer be used. Just using the `static` keyword in code is enough for PhpDocumentor on PHP5+ to recognize static variables and methods, and PhpDocumentor will mark them as static.
Props birgire.
See #42803 .
git-svn-id: https://develop.svn.wordpress.org/trunk@42746 602fd350-edb4-49c9-b593-d223f7449a82
2018-02-25 20:21:37 +00:00
John Blackbourn
9f154bbf21
HTTP API: Add the URL as a paramter to various HTTP related filters.
...
Props paulschreiber, purnendu
Fixes #42186
git-svn-id: https://develop.svn.wordpress.org/trunk@42682 602fd350-edb4-49c9-b593-d223f7449a82
2018-02-09 18:10:15 +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
John Blackbourn
ff1d2b5ccb
HTTP API: Add a WP_Http class constant for the HTTP status code 301.
...
Fixes #42490
git-svn-id: https://develop.svn.wordpress.org/trunk@42208 602fd350-edb4-49c9-b593-d223f7449a82
2017-11-20 20:53:20 +00:00
Sergey Biryukov
cb3abb4abc
Docs: Correct type and description for the $data parameter in WP_Http::browser_redirect_compatibility().
...
Fixes #41380 .
git-svn-id: https://develop.svn.wordpress.org/trunk@41907 602fd350-edb4-49c9-b593-d223f7449a82
2017-10-18 16:37:08 +00:00
Sergey Biryukov
8906b0cdf9
Docs: Change $args to $r in the DocBlock for http_api_debug filter to match the variable name.
...
Props bor0, ronakganatra.
Fixes #41379 .
git-svn-id: https://develop.svn.wordpress.org/trunk@41562 602fd350-edb4-49c9-b593-d223f7449a82
2017-09-22 09:32:30 +00:00
Drew Jaynes
70027dd170
Docs: Add missing documentation for the $data parameter for WP_Http::browser_redirect_compatibility().
...
Props ronakganatra for the initial patch.
Fixes #41380 .
git-svn-id: https://develop.svn.wordpress.org/trunk@41218 602fd350-edb4-49c9-b593-d223f7449a82
2017-08-03 15:23:25 +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
Sergey Biryukov
6229dd05b5
Docs: Change @version entry for WP_Http::buildCookieHeader() to @since.
...
See #41381 .
git-svn-id: https://develop.svn.wordpress.org/trunk@41105 602fd350-edb4-49c9-b593-d223f7449a82
2017-07-20 13:14:50 +00:00
Sergey Biryukov
c6ba869397
Docs: Add @access entries for WP_Http::block_request(), ::handle_redirects(), and ::is_ip_address().
...
Props ronakganatra.
Fixes #41381 .
git-svn-id: https://develop.svn.wordpress.org/trunk@41104 602fd350-edb4-49c9-b593-d223f7449a82
2017-07-20 13:13:09 +00:00
Sergey Biryukov
84fa8a9ff1
Docs: Add a missing quote in user-agent argument description in WP_Http::request().
...
Props ixkaito.
Fixes #41154 .
git-svn-id: https://develop.svn.wordpress.org/trunk@40934 602fd350-edb4-49c9-b593-d223f7449a82
2017-06-25 06:59:41 +00:00