Commit Graph

41 Commits

Author SHA1 Message Date
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
19c0a55711 Docs: Standardise the format used for documenting parameters passed by reference.
See #35974, #41017


git-svn-id: https://develop.svn.wordpress.org/trunk@41688 602fd350-edb4-49c9-b593-d223f7449a82
2017-10-02 22:13:04 +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
Drew Jaynes
de79ff87b3 Docs: Remove a few more superfluous @package WordPress and @subpackage notations outside of file headers missed in [40988].
See #41017.


git-svn-id: https://develop.svn.wordpress.org/trunk@40989 602fd350-edb4-49c9-b593-d223f7449a82
2017-07-01 17:10:37 +00:00
Drew Jaynes
f6399c9950 Improve the usefulness of several _deprecated_function() calls by passing known replacement functions, methods, or hooks.
Props jrf.
See #41121.


git-svn-id: https://develop.svn.wordpress.org/trunk@40929 602fd350-edb4-49c9-b593-d223f7449a82
2017-06-25 00:04:11 +00:00
Drew Jaynes
297076eda4 Docs: Fix multiple trivial typos throughout a variety of core files.
Props ottok.
Fixes #38489.


git-svn-id: https://develop.svn.wordpress.org/trunk@39051 602fd350-edb4-49c9-b593-d223f7449a82
2016-10-31 06:27:53 +00:00
Scott Taylor
3605bd7633 Multisite: use get_current_blog_id() where applicable, in lieu of plucking the $blog_id global from outer space.
See #37699.


git-svn-id: https://develop.svn.wordpress.org/trunk@38457 602fd350-edb4-49c9-b593-d223f7449a82
2016-08-31 04:55:01 +00:00
Scott Taylor
da8597c76b Cache: in WP_Object_Cache, $cache_misses is public, but $cache_hits is private. They should both be public, because they're useful for debugging purposes.
Props danielbachhuber.
Fixes #37726.


git-svn-id: https://develop.svn.wordpress.org/trunk@38335 602fd350-edb4-49c9-b593-d223f7449a82
2016-08-23 14:37:31 +00:00
Sergey Biryukov
920f29616a Docs: Use 3-digit, x.x.x-style semantic versioning for _doing_it_wrong(), _deprecated_function(), _deprecated_argument(), and _deprecated_file() throughout core.
Props metodiew.
Fixes #36495.

git-svn-id: https://develop.svn.wordpress.org/trunk@37985 602fd350-edb4-49c9-b593-d223f7449a82
2016-07-06 12:39:01 +00:00
Drew Jaynes
e6afe609a5 Docs: Fix an incorrect Codex link in the file header for wp-includes/cache.php.
Introduced in [7990].

Props michaelbeil.
See #36880.


git-svn-id: https://develop.svn.wordpress.org/trunk@37460 602fd350-edb4-49c9-b593-d223f7449a82
2016-05-18 22:06:39 +00:00
Drew Jaynes
195572596b Docs: Standardize on 'backward compatibility/compatible' nomenclature in core inline docs.
Also use 'back-compat' in some inline comments where backward compatibility is the subject and shorthand feels more natural.

Note: 'backwards compatibility/compatibile' can also be considered correct, though it's primary seen in regular use in British English.

Props ocean90.
Fixes #36835.


git-svn-id: https://develop.svn.wordpress.org/trunk@37431 602fd350-edb4-49c9-b593-d223f7449a82
2016-05-13 18:40:19 +00:00
Sergey Biryukov
4669eb2706 Docs: Fix typo in wp_cache_switch_to_blog() and WP_Object_Cache::switch_to_blog() description.
Props bobbingwide.
Fixes #36548.

git-svn-id: https://develop.svn.wordpress.org/trunk@37216 602fd350-edb4-49c9-b593-d223f7449a82
2016-04-16 12:36:56 +00:00
Dominik Schilling (ocean90)
9a7488aaf8 Spelling: Standardize on "front end"/"back end" (noun) and "front-end"/"back-end" (adjective).
Props obrienlabs, thewanderingbrit.
Fixes #34887.

git-svn-id: https://develop.svn.wordpress.org/trunk@36709 602fd350-edb4-49c9-b593-d223f7449a82
2016-02-25 12:52:33 +00:00
ericlewis
3fde994152 Networks and sites: Replace "blog" usage with "site" in docs.
Multisite functions use the term "blog" to refer to what we now call a "site," e.g. `get_current_blog_id()`. These functions are here to stay because of our commitment to backwards compatibility. What we can do is set the documentation straight.

See #35417.


git-svn-id: https://develop.svn.wordpress.org/trunk@36416 602fd350-edb4-49c9-b593-d223f7449a82
2016-01-28 03:34:02 +00:00
John Blackbourn
a6556195d8 Docs: Miscellaneous docblock corrections.
See #32246


git-svn-id: https://develop.svn.wordpress.org/trunk@36069 602fd350-edb4-49c9-b593-d223f7449a82
2015-12-23 06:30:09 +00:00
Drew Jaynes
a28e35e462 Filesystem: Following the introduction of the KB|MB|GB|TB_IN_BYTES constants in [35286], use them in various places in core.
Props sudar.
Fixes #22405.


git-svn-id: https://develop.svn.wordpress.org/trunk@35325 602fd350-edb4-49c9-b593-d223f7449a82
2015-10-21 14:02:59 +00:00
Drew Jaynes
ff35e34fad Docs: Improve documentation for the WP_Object_Cache class.
Spaces out parameter documentation for readability, fixes some minor syntactical issues, and adds some missing `@access` tags or reorders tags according to the PHP docs standards.

Also, documents `&$found`, the fourth parameter for the `get()` method, and adds missing parameter and return descriptions for the `_exists()` utility method.

See #32246.


git-svn-id: https://develop.svn.wordpress.org/trunk@34227 602fd350-edb4-49c9-b593-d223f7449a82
2015-09-16 10:02:20 +00:00
Drew Jaynes
1075ec80b8 Docs: Remove an errant change made to a _deprecated_function() call in wp_cache_reset() introduced in [34225].
See #32246.


git-svn-id: https://develop.svn.wordpress.org/trunk@34226 602fd350-edb4-49c9-b593-d223f7449a82
2015-09-16 09:41:51 +00:00
Drew Jaynes
741bd4440c Docs: Add more complete documentation for top-level object cache functionality.
Adds some `@see` tags for corresponding `WP_Object_Cache` methods to DocBlocks for top-level functions. Also adds a standard description for the `@global` tags, spacing for parameter docs readability, and finally, properly marks optional parameters as such.

See #32246.


git-svn-id: https://develop.svn.wordpress.org/trunk@34225 602fd350-edb4-49c9-b593-d223f7449a82
2015-09-16 09:39:33 +00:00
Scott Taylor
3b180cf785 Clarify wp-includes/cache.php docs with some more precise language.
Props danielbachhuber.
Fixes #33734.


git-svn-id: https://develop.svn.wordpress.org/trunk@34010 602fd350-edb4-49c9-b593-d223f7449a82
2015-09-10 18:23:45 +00:00
Scott Taylor
75998818a4 Fix copy pasta in wp_cache_decr() doc block.
Props danielbachhuber.
Fixes #33548.


git-svn-id: https://develop.svn.wordpress.org/trunk@33809 602fd350-edb4-49c9-b593-d223f7449a82
2015-08-30 03:03:47 +00:00
Drew Jaynes
2cfd34e85e Docs: Standardize @deprecated tag formatting in the DocBlock for WP_Object_Cache:reset().
Props Alphawolf.
See #28806.


git-svn-id: https://develop.svn.wordpress.org/trunk@33678 602fd350-edb4-49c9-b593-d223f7449a82
2015-08-20 22:38:45 +00:00
Scott Taylor
de7b6c76ab Add/standardize missing doc blocks for cache.php.
See #32444.


git-svn-id: https://develop.svn.wordpress.org/trunk@32539 602fd350-edb4-49c9-b593-d223f7449a82
2015-05-22 04:23:15 +00:00
Scott Taylor
63ab0981fc In cache.php, clarify some return docs. Some WP_Object_Cache methods return void, so those wrapper functions don't need to return at all.
See #32444.


git-svn-id: https://develop.svn.wordpress.org/trunk@32528 602fd350-edb4-49c9-b593-d223f7449a82
2015-05-21 20:21:22 +00:00
Dominik Schilling (ocean90)
b0d6757918 Use HTTPS URLs for codex.wordpress.org.
see #27115.

git-svn-id: https://develop.svn.wordpress.org/trunk@32116 602fd350-edb4-49c9-b593-d223f7449a82
2015-04-12 21:28:58 +00:00
Scott Taylor
253f0dd6cf Declare multisite as a field for WP_Object_Cache.
See #30799.


git-svn-id: https://develop.svn.wordpress.org/trunk@31682 602fd350-edb4-49c9-b593-d223f7449a82
2015-03-09 02:17:30 +00:00
Scott Taylor
1997429498 Empty return statements are unnecessary at the end of functions.
See #30799.


git-svn-id: https://develop.svn.wordpress.org/trunk@31679 602fd350-edb4-49c9-b593-d223f7449a82
2015-03-08 23:08:48 +00:00
Scott Taylor
349e5cb318 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.


git-svn-id: https://develop.svn.wordpress.org/trunk@31126 602fd350-edb4-49c9-b593-d223f7449a82
2015-01-10 06:53:48 +00:00
Scott Taylor
4d46475b3d Improve various @param docs for src/wp-includes/*.
See #30224.


git-svn-id: https://develop.svn.wordpress.org/trunk@30681 602fd350-edb4-49c9-b593-d223f7449a82
2014-12-01 01:33:34 +00:00
Drew Jaynes (DrewAPicture)
a84d50dfa3 Fix some words that aren't words.
See #28885.


git-svn-id: https://develop.svn.wordpress.org/trunk@29454 602fd350-edb4-49c9-b593-d223f7449a82
2014-08-09 19:29:37 +00:00
Drew Jaynes (DrewAPicture)
7ad77d58ee Add periods to short descriptions for magic methods added in [28501], [28521], and [28524].
See #22234 and #28885.


git-svn-id: https://develop.svn.wordpress.org/trunk@29165 602fd350-edb4-49c9-b593-d223f7449a82
2014-07-14 01:11:55 +00:00
Drew Jaynes (DrewAPicture)
d7ff96d00f Fill out inline documentation for magic methods added to the WP_Object_Cache class in [28502], [28521], [28524].
See #27881, #22234 and #28885.


git-svn-id: https://develop.svn.wordpress.org/trunk@29146 602fd350-edb4-49c9-b593-d223f7449a82
2014-07-13 23:45:11 +00:00
Scott Taylor
daecbc9659 Classes that have __set() also need __isset() and __unset().
See #27881, #22234.


git-svn-id: https://develop.svn.wordpress.org/trunk@28524 602fd350-edb4-49c9-b593-d223f7449a82
2014-05-19 06:51:35 +00:00
Scott Taylor
77c6420969 Some classes with __get() method also need __set().
See #27881, #22234.


git-svn-id: https://develop.svn.wordpress.org/trunk@28521 602fd350-edb4-49c9-b593-d223f7449a82
2014-05-19 06:31:00 +00:00
Scott Taylor
e76545e011 Fix fatal error in unit test.
See #27881.


git-svn-id: https://develop.svn.wordpress.org/trunk@28520 602fd350-edb4-49c9-b593-d223f7449a82
2014-05-19 06:24:06 +00:00
Scott Taylor
241d1a4d99 Add access modifiers to methods/members in WP_Object_Cache. Add a magic __get() method for BC.
See #27881.


git-svn-id: https://develop.svn.wordpress.org/trunk@28502 602fd350-edb4-49c9-b593-d223f7449a82
2014-05-19 05:15:20 +00:00
Scott Taylor
05b87717c8 Rather than removing the 3rd argument in WP_Object_Cache::delete(), mark it as $deprecated.
See [27064].
Props SergeyBiryukov.
Fixes #22478.



git-svn-id: https://develop.svn.wordpress.org/trunk@27162 602fd350-edb4-49c9-b593-d223f7449a82
2014-02-11 16:40:30 +00:00
Scott Taylor
a1ffaec8b4 Remove $force argument from WP_Object_Cache::delete(). From @nacin: "This was for internal-use-only, I don't think _deprecated_argument() is needed, but let's put a comment somewhere just so we know we'd have to be careful if we ever want to add a third argument here later."
`$force` argument has been removed, and docs were updated.

Fixes #22478.



git-svn-id: https://develop.svn.wordpress.org/trunk@27064 602fd350-edb4-49c9-b593-d223f7449a82
2014-02-01 22:24:30 +00:00
Drew Jaynes
bd39e26032 First there were two, and now there are three -- in the @since versions that came before and that shall be. And so it will be, says nacin.
Props JustinSainton, SergeyBiryukov, DrewAPicture.
Fixes #26713.


git-svn-id: https://develop.svn.wordpress.org/trunk@26868 602fd350-edb4-49c9-b593-d223f7449a82
2013-12-24 18:56:05 +00:00
Andrew Nacin
80653c01a1 Always pass integer expirations to cache backends.
props SergeyBiryukov, andreasnrb.
fixes #25308.


git-svn-id: https://develop.svn.wordpress.org/trunk@25451 602fd350-edb4-49c9-b593-d223f7449a82
2013-09-16 17:42:49 +00:00
Andrew Nacin
b43712e0f7 New develop.svn.wordpress.org repository based on the old core.svn repository.
* All WordPress files move to a src/ directory.
 * New task runner (Grunt), configured to copy a built WordPress to build/.
 * svn:ignore and .gitignore for Gruntfile.js, wp-config.php, and node.js.
 * Remove Akismet external from develop.svn. Still exists in core.svn.
 * Drop minified files from src/. The build process will now generate these.

props koop.
see #24976.

and see http://wp.me/p2AvED-1AI.



git-svn-id: https://develop.svn.wordpress.org/trunk@25001 602fd350-edb4-49c9-b593-d223f7449a82
2013-08-07 05:25:25 +00:00