1
0
Fork 0
mirror of https://github.com/inretio/WordPress-Plugin-Boilerplate synced 2024-12-23 12:23:54 +02:00
Commit graph

51 commits

Author SHA1 Message Date
Jan Beck
9c14d6e3eb changed "dashboard" to "admin area"
dashboard-specific becomes admin-specific
2015-02-13 14:31:40 -04:00
Chris Wilcoxson
2683f494ea Function docs should be @param not @var. 2015-02-03 11:15:28 -06:00
Barry Ceelen
f51ee23a1f Fix code comment typo 2014-11-10 16:57:08 +01:00
Justin Sainton
50bc541455 Please stop shouting at me. I do hate when my parents shout.
But in all seriousness, shouting types is bad form.
2014-09-10 21:19:37 -07:00
Tom McFarlin
ef28c5a351 Updating the docblock 2014-08-18 17:08:36 -04:00
Tom McFarlin
4d6a0dfa3e Finalizing code for beta
* Updating DocBlocks
* Fixing typos
* Adjusting whitespace
2014-08-18 17:00:09 -04:00
Tom McFarlin
96f957d6e9 Updating doc block
* class-plugin-name now includes different file and class documentation
* changing a URL to an example URL
2014-08-01 17:06:09 -04:00
Tom McFarlin
aea004af54 Chaing the doc from 'slug' to 'string' 2014-08-01 16:59:19 -04:00
Tom McFarlin
f3133d8cb5 Improving docblocks
* Documenting the plugin file
* Changing the docblock to read 'class', not 'file'

Related #199
2014-08-01 16:47:08 -04:00
Tom McFarlin
6d6f6399f7 Removing a duplicate line of code
Related #199
2014-08-01 16:44:57 -04:00
Tom McFarlin
57205587af Making the file headers more conssitent
Improving the documentation for each file, as well.

Fix #193
2014-07-30 15:16:32 -04:00
Tom McFarlin
43ee54a0ee Adding documentation to two missing functions
Fixes #192
2014-07-30 15:03:33 -04:00
Tom McFarlin
918ee9e5f9 Removing public @access tags
Following the guide of the PHPDoc Block Formatting

> @access (for functions: only use if private)

Fix #191
2014-07-30 15:00:57 -04:00
Tom McFarlin
4d9f666e0f Merge pull request #196 from grappler/remove-spaces
Remove spaces before code
2014-07-30 14:57:11 -04:00
Tom McFarlin
ec29ebc95b Renaming the plugin slug to the plugin name
Also renaming the text domain in the header of the core plugin file to match that of the plugin name

Fixes #194
2014-07-30 13:58:41 -04:00
Ulrich Pogson
48e0a373dd Remove spaces before code 2014-07-30 16:04:18 +02:00
Tom McFarlin
81b3c8bd6d Updating the arguments passed to the classes 2014-07-29 17:10:31 -04:00
Tom McFarlin
0f4aaa9693 Updating the docblocks for this function 2014-07-29 17:10:09 -04:00
Tom McFarlin
560e5959a5 Documenting classes
Documenting classes that are core to each plugin, while also leaving other classes undocumented for an implementation-specific basis.
2014-07-29 16:56:18 -04:00
Tom McFarlin
f09ca373d8 Removing the trailingslash from the URL 2014-07-29 16:55:10 -04:00
Tom McFarlin
b706dc3291 Updating code comments
Making sure that the code comments strictly follow that of the WordPress PHP Documentation Standards
2014-07-29 16:03:09 -04:00
Tom McFarlin
2af01cf653 Updating the code comments
Making sure that the code comments strictly follow that of the WordPress PHP Documentation Standards
2014-07-29 15:56:12 -04:00
Tom McFarlin
3ae56a6460 adding a comma that was preventing a syntax problem 2014-07-07 16:56:54 -04:00
Tom McFarlin
23235f94d7 completing the initial round of PHP documentation as per the WPCS
http://make.wordpress.org/core/handbook/inline-documentation-standards/php-documentation-standards/#1-functions-and-class-methods
2014-06-26 16:19:57 -04:00
Tom McFarlin
9f5ffbf597 adding a priority argument to the loader (defaulting to 10 as per wordpress codex) 2014-06-26 15:43:18 -04:00
Tom McFarlin
f89752180f adding TODO docblocks 2014-05-08 23:34:38 -04:00
Tom McFarlin
bb3c56b0c2 adding TODO code docblocks 2014-05-08 23:34:29 -04:00
Tom McFarlin
f332130569 moving all bootstrap code into this file, adding some getters for dependencies
setting up this file to fire the plugin so that it's prepared to handle any hooks given to the loader
2014-05-08 23:34:16 -04:00
Tom McFarlin
9a23715ba7 de-subclassing this class and defining a domain attribute provided by setter injection 2014-05-08 18:10:22 -04:00
Tom McFarlin
0d63ec21e5 adding getters for the protected properties 2014-05-08 18:10:04 -04:00
Tom McFarlin
00c5f7d733 adding a public getter for the plugin slug so that external classes can reference it
ht @garyjoes b5549d5f9c (commitcomment-6236733)
2014-05-08 16:50:23 -04:00
Tom McFarlin
d5bb1de8fb adding a collection for hooks and filters to distinguish between the hooks being added 2014-05-06 09:53:16 -04:00
Tom McFarlin
7e64091fd4 updating the foreach loop from a previous version of the loop 2014-05-05 00:28:02 -04:00
Tom McFarlin
5265d1f0ae introducing the single, shared loader class 2014-05-05 00:18:13 -04:00
Tom McFarlin
b5549d5f9c defining a base class from which all other components can inherit
also getting rid of the version constant in place of a properly, defining a single entry point with the run function, and defining the plugin slug as a property
2014-05-05 00:18:04 -04:00
Tom McFarlin
d29ebf7dc8 extending the new plugin name base class and implementing localization 2014-05-05 00:17:23 -04:00
Tom McFarlin
8c0b11ca1b adding a @TODO tag for localization class 2014-05-03 15:28:23 -04:00
Tom McFarlin
c83aa5434d updating the docblocks 2014-05-03 15:28:04 -04:00
Tom McFarlin
4114ad703e updating the docblocks 2014-05-03 15:07:05 -04:00
Tom McFarlin
821e24a9ea updating the docblocks 2014-05-03 15:06:57 -04:00
Tom McFarlin
793797ae71 removing all of the @TODO references
as per GaryJones notes, "You can't have tags come before the short / long description, otherwise the descriptions end up as part of a multiline tag."

removing these @TODO's until the team decides whether or not to replace them with something clearer, or to discuss it to the documentation
2014-05-01 23:26:16 -04:00
Tom McFarlin
0896f0836c defining the core shared plugin name
this file is used to be shared between the dashboard and public-facing functionality. it's hooks should be defined in the specific loader
2014-04-30 22:55:34 -04:00
Tom McFarlin
5666bb7ddc Completing the first round of docblocks for the activation / deactivation classes 2014-04-30 22:32:27 -04:00
Tom McFarlin
026515da85 adding docblocks consistent with the wpcs for the files in includes
http://make.wordpress.org/core/handbook/inline-documentation-standards/php-documentation-standards/
Signed-off-by: Tom McFarlin <tom@tommcfarlin.com>
2014-04-25 18:58:07 -04:00
Tom McFarlin
2cf4ba8223 adding a trailing whitespace to all of our defined files
this helps with cleaner diffs. It's also on one of the PSRs, and it's one of the WPCS rules. (ht @garyjones for the reminder)

Signed-off-by: Tom McFarlin <tom@tommcfarlin.com>
2014-04-25 18:39:31 -04:00
Tom McFarlin
5ab1805db8 removing '@TODO' in favor of 'TODO'
WordPress doesn't like '@TODO' and doesn't honor it when displaying it in the dashboard

Signed-off-by: Tom McFarlin <tom@tommcfarlin.com>
2014-04-25 18:21:25 -04:00
Tom McFarlin
b426fbe514 renaming the plugin activation and deactivation classes
Signed-off-by: Tom McFarlin <tom@tommcfarlin.com>
2014-04-11 10:36:13 -04:00
Tom McFarlin
766b47b643 Updating the text of the index file so that it matches all other WordPress files
Signed-off-by: Tom McFarlin <tom@tommcfarlin.com>
2014-04-11 10:35:40 -04:00
Tom McFarlin
28da2f7c41 checking in the start of the docblocks for the various PHP files of the boilerplate
Signed-off-by: Tom McFarlin <tom@tommcfarlin.com>
2014-04-09 16:22:44 -04:00
Tom McFarlin
0c6d8418f6 adding the index.php files for protecting directory contents
Signed-off-by: Tom McFarlin <tom@tommcfarlin.com>
2014-04-09 15:51:18 -04:00