Commit Graph

13 Commits

Author SHA1 Message Date
Gary Pendergast aaf99e6913 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.


Built from https://develop.svn.wordpress.org/trunk@42343


git-svn-id: http://core.svn.wordpress.org/trunk@42172 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2017-11-30 23:11:00 +00:00
Drew Jaynes 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
Drew Jaynes 6cc13f0c54 Docs: Fix formatting, tense, verb conjugation, and other syntax for wp-includes/* elements introduced or changed in 4.6.
Part 1/2.

See #37318.

Built from https://develop.svn.wordpress.org/trunk@38121


git-svn-id: http://core.svn.wordpress.org/trunk@38062 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-07-20 16:57:32 +00:00
Weston Ruter 6693acdb24 Widgets: Provide PHP 5.2 fallback for `spl_object_hash()` if disabled in logic for registering and unregistering pre-instantiated widgets.
Fixes #28216.

Built from https://develop.svn.wordpress.org/trunk@37333


git-svn-id: http://core.svn.wordpress.org/trunk@37299 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-04-30 22:36:28 +00:00
Weston Ruter 96104fdd30 Widgets: Allow `WP_Widget` subclass instances (objects) to be registered/unregistered in addition to `WP_Widget` subclass names (strings).
Allows widgets to be registered which rely on dependency injection. Also will allow for new widget types to be created dynamically (e.g. a Recent Posts widget for each registered post type).

See #35990.
Props mdwheele, PeterRKnight, westonruter.
Fixes #28216.

Built from https://develop.svn.wordpress.org/trunk@37329


git-svn-id: http://core.svn.wordpress.org/trunk@37295 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-04-29 18:49:26 +00:00
Drew Jaynes e6d9d95f6d Docs: Use third-person singular verbs for method summaries in `WP_Widget_Factory`.
Fixes #36299.

Built from https://develop.svn.wordpress.org/trunk@37063


git-svn-id: http://core.svn.wordpress.org/trunk@37030 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-03-23 04:51:26 +00:00
Drew Jaynes c5ff4f3b47 Docs: Add missing information to constructors DocBlocks for `WP_Widget_Factory`.
See #36299.

Built from https://develop.svn.wordpress.org/trunk@37062


git-svn-id: http://core.svn.wordpress.org/trunk@37029 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-03-23 04:19:27 +00:00
Drew Jaynes bbebd0f74d Docs: Add a missing DocBlock for the `WP_Widget_Factory::$widgets` property.
Props raimy.
See #36299.

Built from https://develop.svn.wordpress.org/trunk@37061


git-svn-id: http://core.svn.wordpress.org/trunk@37028 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-03-23 04:11:28 +00:00
Drew Jaynes 58376954c2 Docs: The Widgets subpackage is plural.
See #33701.

Built from https://develop.svn.wordpress.org/trunk@34413


git-svn-id: http://core.svn.wordpress.org/trunk@34377 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-09-22 13:48:25 +00:00
Drew Jaynes 783876bd1a Docs: The Widget API is singular.
See #33701.

Built from https://develop.svn.wordpress.org/trunk@34392


git-svn-id: http://core.svn.wordpress.org/trunk@34356 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-09-22 12:28:27 +00:00
Drew Jaynes 95dc9825a7 Docs: Clarify the file header summary for class-wp-widget-factory.php, introduced in [33746].
See #33413. See #33701.

Built from https://develop.svn.wordpress.org/trunk@33870


git-svn-id: http://core.svn.wordpress.org/trunk@33838 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-09-03 02:54:22 +00:00
Drew Jaynes 5a77c96ea6 Docs: Add a file header to wp-includes/class-wp-widget-factory.php, created when the `WP_Widget_Factory` class was moved to its own file in [33746].
It's important for every file in WordPress, regardless of makeup or architecture, to have its own file header, even if the file contains nothing but a class. When parsed, files and classes are mutually exclusive and should be documented with this in mind.

See [33746]. See #33413.

Built from https://develop.svn.wordpress.org/trunk@33756


git-svn-id: http://core.svn.wordpress.org/trunk@33724 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-08-26 07:53:21 +00:00
Scott Taylor c3565b2cba Widgets: move classes into their own files, `widgets.php` loads the new files, so this is 100% BC if someone is loading `widgets.php` directly. New files created using `svn cp`.
Creates: 
`class-wp-widget.php` 
`class-wp-widget-factory.php` 
`widget-functions.php` 

`widgets.php` contains only top-level code. Class files only contain classes. Functions file only contains functions.

See #33413.

Built from https://develop.svn.wordpress.org/trunk@33746


git-svn-id: http://core.svn.wordpress.org/trunk@33714 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-08-26 02:40:23 +00:00