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

37 commits

Author SHA1 Message Date
Chris Wilcoxson
2683f494ea Function docs should be @param not @var. 2015-02-03 11:15:28 -06:00
Donna Murphy
582ccadde0 Fix incorrect class names 2015-01-17 12:45:15 -05:00
Tom McFarlin
025d61efee Merge pull request #224 from mAAdhaTTah/variable-fix
Change name -> plugin_name for consistency
2014-10-07 16:46:49 -04:00
mAAdhaTTah
dbf2c73757 Change name -> plugin_name for consistency 2014-10-07 16:43:55 -04:00
Dmitry Mayorov
163c2a86c1 Update class-plugin-name-admin.php
Changed @subpackage from 'includes' to 'admin'.
2014-10-05 19:35:03 +06: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
4d6a0dfa3e Finalizing code for beta
* Updating DocBlocks
* Fixing typos
* Adjusting whitespace
2014-08-18 17:00:09 -04:00
Ulrich Pogson
3067be69b5 Remove duplicate documentation 2014-07-30 21:59:15 +02: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
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
Ulrich Pogson
48e0a373dd Remove spaces before code 2014-07-30 16:04:18 +02:00
Tom McFarlin
370c439bb2 Adding the plugin slug to the constructor args 2014-07-29 17:09:55 -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
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
cc6df31722 de-subclassing the file, adding a version attribute, setting it in the constructor 2014-05-08 18:09:10 -04:00
Tom McFarlin
f6a587372a extending the new plugin name base class 2014-05-05 00:17:13 -04:00
Tom McFarlin
6e46a1f439 removing the individual loaders in order to consolidate them into a single, shared loader 2014-05-05 00:16:13 -04:00
Tom McFarlin
ee79eb4582 adding type hinting to the run function's arguments 2014-05-03 15:27:38 -04:00
Tom McFarlin
0abff96cfc removing whitespace 2014-05-03 15:27:15 -04:00
Tom McFarlin
af315d7145 adding whitespace and additional instructions 2014-05-03 15:06:50 -04:00
Tom McFarlin
c10b371d67 updating the docblocks and adding whitespace to the end of the file 2014-05-03 15:06:38 -04:00
Tom McFarlin
a9e071aef8 removing the original example functions and replacing them with functions that use existing boilerplate files 2014-05-01 23:43:07 -04:00
Tom McFarlin
40fd22a297 adding hooks to include the styles and scripts for the dashboard 2014-05-01 23:42:46 -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
c05ae57e91 defining the basic code comments for the dashboard-specific 2014-04-30 22:55:06 -04:00
Tom McFarlin
71ff4b6ec7 updating the documentation
updating the documentation for the core admin plugin file with docblocks and example functions for how they should be used and their relationship to the admin loader
2014-04-30 22:54:00 -04:00
Tom McFarlin
4504d3a4fd adding example documentation
adding example documentation and code for how to user the admin loader via dependency injection
2014-04-30 22:53:22 -04:00
Tom McFarlin
a4fc32fa59 providing a first pass at the docblocks for the admin loader
eventually, this class will be responsible for defining all of the hooks for the admin-facing side of the plugin
2014-04-30 22:34:19 -04:00
Tom McFarlin
284dc26054 adding basic comments to the admin stylesheets
this may eventually be removed and placed into the boilerplate's documentation on the official website, but until that exists, it will remain here.
2014-04-30 22:33:30 -04:00
Tom McFarlin
deadcc668b adding basic documentation for the admin javascript file
this may eventually be removed and placed into the boilerplate's documentation on the official website, but until that exists, it will remain here.
2014-04-30 22:33:06 -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
72690b6771 introducing the empty loader files
this are the files that will be used to define the actions and filters for their respective area of the plugin

Signed-off-by: Tom McFarlin <tom@tommcfarlin.com>
2014-04-25 18:35:52 -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
b868c5da02 initial commit of the skeletons for the javascript files
Signed-off-by: Tom McFarlin <tom@tommcfarlin.com>
2014-04-09 16:10:27 -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
Tom McFarlin
83f6ea69c6 initial commit
initial commit of the skeleton structure of the wordpress plugin boilerplate

Signed-off-by: Tom McFarlin <tom@tommcfarlin.com>
2014-03-18 21:53:57 -04:00