Commit Graph

3 Commits

Author SHA1 Message Date
Drew Jaynes
10278a11d3 Docs: The Comment API is singular.
See #33701.


git-svn-id: https://develop.svn.wordpress.org/trunk@34409 602fd350-edb4-49c9-b593-d223f7449a82
2015-09-22 13:42:15 +00:00
Drew Jaynes
46af2b9cd9 Docs: Add complete file, class, property, and method documentation for the new WP_Comment class, introduced in [33891].
It's important for new functionality, especially something as significant as a new class to have complete documentation upon initial commit – not after the fact.

See #32619.


git-svn-id: https://develop.svn.wordpress.org/trunk@33893 602fd350-edb4-49c9-b593-d223f7449a82
2015-09-03 19:57:15 +00:00
Scott Taylor
60ba8b05e4 Introduce WP_Comment class to model/strongly-type rows from the comments database table. Inclusion of this class is a pre-req for some more general comment cleanup and sanity.
* Takes inspiration from `WP_Post` and adds sanity to comment caching. 
* Clarifies when the current global value for `$comment` is returned. The current implementation in `get_comment()` introduces side effects and an occasion stale global value for `$comment` when comment caches are cleaned.
* Strongly-types `@param` docs
* This class is marked `final` for now

Props wonderboymusic, nacin.

See #32619.


git-svn-id: https://develop.svn.wordpress.org/trunk@33891 602fd350-edb4-49c9-b593-d223f7449a82
2015-09-03 18:16:35 +00:00