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
1d95dcfa2c
Docs: Remove superfluous `@package WordPress` and `@subpackage` notations used outside of file headers in a variety of core files.
...
Per the inline documentation standards for PHP, there should only be one `@package` and/or `@subpackage` notation per file, and only in the file header.
See #41017 .
Built from https://develop.svn.wordpress.org/trunk@40988
git-svn-id: http://core.svn.wordpress.org/trunk@40838 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-07-01 16:58:42 +00:00
4d17b67eed
Load: move `is_wp_error()` to `load.php` so that `WP_Error` is in a file by itself.
...
See #37827 .
Built from https://develop.svn.wordpress.org/trunk@38363
git-svn-id: http://core.svn.wordpress.org/trunk@38304 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-08-26 09:58:28 +00:00
f52a8cb1fa
Docs: Remove/replace invalid inline `@link` tags in DocBlocks in wp-includes/*.
...
Fixes #36910 .
Built from https://develop.svn.wordpress.org/trunk@37487
git-svn-id: http://core.svn.wordpress.org/trunk@37455 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-05-22 17:39:28 +00:00
bd8fafea54
Use `void` instead of `null` where appropriate when pipe-delimiting `@return` types. If a `@return` only contains `void`, remove it.
...
See #32444 .
Built from https://develop.svn.wordpress.org/trunk@32568
git-svn-id: http://core.svn.wordpress.org/trunk@32538 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-05-24 05:40:25 +00:00
fe6b5983df
In PHP 5.0.0, `is_a()` became deprecated in favour of the `instanceof` operator. Calling `is_a()` would result in an `E_STRICT` warning.
...
In PHP 5.3.0, `is_a()` is no longer deprecated, and will therefore no longer throw `E_STRICT` warnings.
To avoid warnings in PHP < 5.3.0, convert all `is_a()` calls to `$var instanceof WP_Class` calls.
`instanceof` does not throw any error if the variable being tested is not an object, it simply returns `false`.
Props markoheijnen, wonderboymusic.
Fixes #25672 .
Built from https://develop.svn.wordpress.org/trunk@31188
git-svn-id: http://core.svn.wordpress.org/trunk@31169 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-01-16 01:06:24 +00:00
d8e5aabab5
In `WP_Error`:
...
* `wp_send_json_error()` accesses `$errors` on an instance, it must be `public`
* `$error_data` is a local message cache for error codes and doesn't particularly hide info, would be the only non-public field or method in the class
Make `$errors` and `$error_data` public and remove magic methods.
See #30891 .
Built from https://develop.svn.wordpress.org/trunk@31138
git-svn-id: http://core.svn.wordpress.org/trunk@31119 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-01-11 00:01:22 +00:00
0a511680f4
Adding a `@return` annotation to constructors is generally not recommended as a constructor does not have a meaningful return value. Constructors do not have meaningful return values, anything that is returned from here is discarded.
...
See #30799 .
Built from https://develop.svn.wordpress.org/trunk@31126
git-svn-id: http://core.svn.wordpress.org/trunk@31107 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-01-10 06:54:23 +00:00
e619abda6e
Improve various `@param` docs for `src/wp-includes/*`.
...
See #30224 .
Built from https://develop.svn.wordpress.org/trunk@30681
git-svn-id: http://core.svn.wordpress.org/trunk@30671 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-12-01 01:34:24 +00:00
2b88252b38
New `remove()` method and some unit tests for the `WP_Error` class.
...
props stephenharris.
fixes #28092 .
Built from https://develop.svn.wordpress.org/trunk@29854
git-svn-id: http://core.svn.wordpress.org/trunk@29617 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-10-08 07:12:18 +00:00
a8583d5f19
Fix some words that aren't words.
...
See #28885 .
Built from https://develop.svn.wordpress.org/trunk@29454
git-svn-id: http://core.svn.wordpress.org/trunk@29232 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-08-09 19:30:17 +00:00
bf3f95f36f
Fill out inline documentation for magic methods added to the `WP_Error` class in [28511].
...
See #27881 , #22234 and #28885 .
Built from https://develop.svn.wordpress.org/trunk@29144
git-svn-id: http://core.svn.wordpress.org/trunk@28928 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-07-13 23:42:14 +00:00
52aa3a5112
Revert [29033] pending further discussion. See #28319 .
...
Built from https://develop.svn.wordpress.org/trunk@29046
git-svn-id: http://core.svn.wordpress.org/trunk@28834 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-07-09 19:19:14 +00:00
1e681c1421
Add a `create_wp_error` action which is called when a `WP_Error` instance is created. Fixes #28319 . Props ebinnion
...
Built from https://develop.svn.wordpress.org/trunk@29033
git-svn-id: http://core.svn.wordpress.org/trunk@28821 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-07-08 18:47:15 +00:00
10e48ccbf2
Improve inline documentation for the `__construct()` and `add()` methods in `WP_Error` class.
...
Props jdgrimes.
Fixes #28203 .
Built from https://develop.svn.wordpress.org/trunk@28660
git-svn-id: http://core.svn.wordpress.org/trunk@28478 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-06-04 06:06:14 +00:00
85f73cf458
Classes that have `__set()` also need `__isset()` and `__unset()`.
...
See #27881 , #22234 .
Built from https://develop.svn.wordpress.org/trunk@28524
git-svn-id: http://core.svn.wordpress.org/trunk@28350 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-19 06:52:14 +00:00
821246b4ae
Some classes with `__get()` method also need `__set()`.
...
See #27881 , #22234 .
Built from https://develop.svn.wordpress.org/trunk@28521
git-svn-id: http://core.svn.wordpress.org/trunk@28347 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-19 06:31:15 +00:00
72d096b007
Add access modifiers to methods/members in `WP_Error`. Add a magic `__get()` method for BC.
...
See #27881 , #22234 .
Built from https://develop.svn.wordpress.org/trunk@28511
git-svn-id: http://core.svn.wordpress.org/trunk@28337 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-19 05:50:14 +00:00
d842da10e7
Correct inline docs for is_wp_error(). props johnbillion. fixes #24637 .
...
git-svn-id: http://core.svn.wordpress.org/trunk@24507 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2013-06-24 18:23:45 +00:00
e3b46b25d3
Lose EOF ?>. Clean up EOF newlines. fixes #12307
...
git-svn-id: http://svn.automattic.com/wordpress/trunk@19712 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2012-01-08 17:01:11 +00:00
e4ed63fc6f
Fix typos in documentation (wp-includes/[a-h]). See #18560 .
...
git-svn-id: http://svn.automattic.com/wordpress/trunk@18633 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2011-09-03 16:02:41 +00:00
04487fc268
Constructor cleanup. Props ocean90. fixes #16768
...
git-svn-id: http://svn.automattic.com/wordpress/trunk@17771 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2011-04-29 20:05:12 +00:00
04deafb31c
File-level phpdoc for new class files. fixes #10287 .
...
git-svn-id: http://svn.automattic.com/wordpress/trunk@16101 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2010-10-30 14:09:05 +00:00
731bf1fb06
Begin the dissolution of classes.php. see #10287 .
...
git-svn-id: http://svn.automattic.com/wordpress/trunk@16099 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2010-10-30 07:02:06 +00:00
Drew Jaynes
Scott Taylor
Konstantin Kovshenin
John Blackbourn
Sergey Biryukov
ryan
duck_
nacin