inretio/WordPress-Plugin-Boilerplate
1
0
Fork 0
mirror of https://github.com/inretio/WordPress-Plugin-Boilerplate synced 2024-12-22 20:03:53 +02:00
Code Issues Releases Wiki Activity
511 commits 2 branches 15 tags 959 KiB
Commit graph

254 commits

Author SHA1 Message Date
Ulrich Pogson
3067be69b5 Remove duplicate documentation 2014-07-30 21:59:15 +02:00
Ulrich Pogson
67dc6fb7a2 Update uninstall header for consistency 2014-07-30 21:55:26 +02:00
Ulrich Pogson
836d85d1c8 Move text domain lower down 2014-07-30 21:52:41 +02:00
Tom McFarlin
efa4d08df3 Updating code comments for require and function 
Fixes #192
 2014-07-30 15:23:18 -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
8ee0c49bd7 Fixes #195 
Updating the header so that it conforms to PHP DocBlock standards and WP Plugin Standards
 2014-07-30 14:56:37 -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
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
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
2a66ff4d50 finalizing docblocks 
Making sure that the code comments strictly follow the WordPress PHP Documentation Standards
 2014-07-29 15:48:33 -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
e29a775e76 completely refactoring the main plugin file 
* leaving the de/activation code here for now
* moving all bootstrap code into class-plugin-name.php
* 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:33:47 -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
0fdaeaa67c fixing a small type, documentation the imports, changing the way in which the plugin is instantiated 2014-05-08 18:09:50 -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
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
71f40d5e7a updating the calls to the plugin loader so that they appropriately call add_action and add_filter 2014-05-06 09:54:13 -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
f6a587372a extending the new plugin name base class 2014-05-05 00:17:13 -04:00
Tom McFarlin
e503be7e38 changing the working name and URL of the plugin so not to conflict with another file in the repository. 
changing the ways in which the plugin loader, plugin components, and plugin works
 2014-05-05 00:16:52 -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
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
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
8cfee0e67a updating the docblocks and actually registering the demo scripts and styles 2014-05-03 15:27:01 -04:00
Tom McFarlin
b3451b717f instantiating and loading the dashboard-specific and public-facing areas of the plugin 
also updating the docblocks to explain what each hooked function is doing
 2014-05-03 15:26:22 -04:00
Tom McFarlin
91273f37d4 updating the docblocks 2014-05-03 15:07:38 -04:00
Tom McFarlin
135920036b updating the docblocks with clearer descriptions as to what each tag and line should contain. 2014-05-03 15:07:24 -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
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
4f2719b2eb updating the docblocks 2014-05-03 15:06:13 -04:00
Tom McFarlin
ecb940ed22 defining a constant for use throughout the boilerplate 2014-05-01 23:43:32 -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
6271822cb1 adding simple public-facing code comments 2014-04-30 22:56:27 -04:00
Tom McFarlin
98b6bf3f65 adding simple code comments for the public-facing code comments 2014-04-30 22:56:17 -04:00
Tom McFarlin
fc2b3109dd defining the loader functionality to be used via dependency injection 2014-04-30 22:56:05 -04:00
Tom McFarlin
a5864a9d96 adding whitespace 2014-04-30 22:55:42 -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
c05ae57e91 defining the basic code comments for the dashboard-specific 2014-04-30 22:55:06 -04:00
Tom McFarlin
4b7dde5553 defining the basic code comments and the public facing partial 2014-04-30 22:54:48 -04:00
Tom McFarlin
a392f3f9db updating the documentation for the core public plugin file 
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 public loader
 2014-04-30 22:54:25 -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
fbf09acbdb spacing out the code in the docblock 2014-04-30 22:34:39 -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
5666bb7ddc Completing the first round of docblocks for the activation / deactivation classes 2014-04-30 22:32:27 -04:00
Tom McFarlin
b7d17e4122 updating the docblocks for proper use of TODO and @TODO 2014-04-30 22:06:19 -04:00
Tom McFarlin
b8132f4b9d removing unnecessary closing parens. 
Signed-off-by: Tom McFarlin <tom@tommcfarlin.com>
 2014-04-26 17:42:21 -04:00
Tom McFarlin
9f71476166 updating the docblocks to the match the wpcs 
http://make.wordpress.org/core/handbook/inline-documentation-standards/php-documentation-standards/
Signed-off-by: Tom McFarlin <tom@tommcfarlin.com>
 2014-04-25 19:00:08 -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
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
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
e91be4101d updating the code comments as per the handbook 
Signed-off-by: Tom McFarlin <tom@tommcfarlin.com>
 2014-04-11 10:36:57 -04:00
Tom McFarlin
3bee4f4272 updating the code comments as per the handbook 
Signed-off-by: Tom McFarlin <tom@tommcfarlin.com>
 2014-04-11 10:36:47 -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
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
b690a0cb63 adding a copy of the gpl 
Signed-off-by: Tom McFarlin <tom@tommcfarlin.com>
 2014-04-09 15:47:56 -04:00
Tom McFarlin
2c359bad76 adding the read me skeleton 
Signed-off-by: Tom McFarlin <tom@tommcfarlin.com>
 2014-04-09 15:44:22 -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
Tom McFarlin
eecfb8a4cd Restarting at ground zero. 
Signed-off-by: Tom McFarlin <tom@tommcfarlin.com>
 2014-03-13 10:28:40 -04:00
Tom McFarlin
87a5d4e5e1 Merge pull request #128 from grappler/patch-1 
Add load_plugin_textdomain
 2014-01-26 06:38:17 -08:00
Thane
97163ca358 Replaced 'plugin' w/ 'plugin-name' 
Replacement `class-plugin-name-admin.php` for `class-plugin-admin.php` was made in `plugin-name.php` on line 72.  The change better allows find-replace functionality.
 2014-01-15 09:03:33 -06:00
Chad Warren
36742f327a Update @copyright date to reflect new year 2014-01-02 16:44:06 -05:00
Chad Warren
4c0f5d2666 Update @copyright date to reflect new year 2014-01-02 16:43:49 -05:00
Chad Warren
5341a73090 Update class-plugin-name.php 2014-01-02 16:43:28 -05:00
Chad Warren
026ef8fcf9 Update @copyright date to reflect new year 2014-01-02 16:43:07 -05:00
Chad Warren
a1801f0340 Update @copyright date to reflect new year 2014-01-02 16:42:35 -05:00
Chad Warren
7bc9cf2c35 Update @copyright date to reflect new year 2014-01-02 16:42:02 -05:00
Barry Ceelen
ee1bc1dfbe Missing space in code comment 2013-12-15 01:00:36 +01:00
jrivera84
da682578c9 Depreciated Function 
Screen Icon function has been depreciated and CSS output is hidden in MP6. 
http://core.trac.wordpress.org/ticket/26119
 2013-12-10 13:37:43 -05:00