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

212 commits

Author SHA1 Message Date
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
Andy Fragen
f9afb7c4c7 more instructions for using GitHub Updater 2013-11-25 18:23:50 -08:00
Ulrich Pogson
09a565b1b5 Add load_plugin_textdomain
If there is no `load_plugin_textdomain` then the translations will not be loaded from the languages folder.
2013-11-22 22:54:43 +01:00
Tom McFarlin
01319c57e3 removing plugin textdomain
related #120

Signed-off-by: Tom McFarlin <tom@tommcfarlin.com>
2013-11-19 17:24:35 -05:00
Tom McFarlin
8c5083ba20 updating the localization functions to that load_textdomain is called.
Removing `load_plugin_textdomain` and leaving only `load_textdomain`.

This is standard as per new WordPress practices[0].

Ultimately, it makes language files more portable as they are still accessible via WordPress even if the plugin developer did not include them with the plugin itself.

Related #120

[0] d2eb67079b (commitcomment-4644357)

Signed-off-by: Tom McFarlin <tom@tommcfarlin.com>
2013-11-19 17:24:08 -05:00
Tom McFarlin
d2eb67079b removing white space, fixing text domain not loading
fixes #120

Signed-off-by: Tom McFarlin <tom@tommcfarlin.com>
2013-11-18 13:18:36 -05:00
Tom McFarlin
7f35f11508 Changing 'decomment' to 'uncomment'
Signed-off-by: Tom McFarlin <tom@tommcfarlin.com>
2013-11-16 12:39:42 -05:00
Tom McFarlin
119c874120 changing all 'TODO' to '@TODO'
changing all 'TODO' to '@TODO' so that they are easier to find in IDE's that support @TODO tags

Signed-off-by: Tom McFarlin <tom@tommcfarlin.com>
2013-11-16 12:30:18 -05:00
Tom McFarlin
adeb21c1c7 Merge pull request #126 from jameswlane/patch-1
Removed the trailing slash
2013-11-15 05:23:10 -08:00
James W. Lane III
0768adb25e Removed the trailing slash
According to http://codex.wordpress.org/Function_Reference/plugin_dir_path, plugin_dir_path gets the filesystem directory path with trailing slash. Even tho two slashes will not cause an error, the extra slash can be removed.
2013-11-15 05:40:35 -06:00
James W. Lane III
46c78c9dc5 Removed the trailing slash
According to http://codex.wordpress.org/Function_Reference/plugin_dir_path, plugin_dir_path gets the filesystem directory path with trailing slash. Even tho two slashes will not cause an error, the extra slash can be removed.
2013-11-15 05:35:07 -06:00
Tom McFarlin
0275b33691 Revert "Extended and aligned comment header (via franz-josef-kaiser)"
This reverts commit 0f2675ddb4.
2013-11-12 09:29:25 -05:00
Tom McFarlin
0f2675ddb4 Extended and aligned comment header (via franz-josef-kaiser) 2013-11-12 09:00:31 -05:00
rockaut
66bf2e2a73 Update class-plugin-name-admin.php
added possibility for super admin check in constructor and get_instance()
2013-11-11 22:43:43 +01:00
Tom McFarlin
5396453073 Revert "Updated plugin-name.php to get all name replacement changes at one place"
This reverts commit a80b2ca7a4.
2013-11-08 16:54:33 -05:00
Tom McFarlin
c3a94e9fd7 Revert "Replaced deleted comment block"
This reverts commit 630408340f.
2013-11-08 16:54:29 -05:00
Tom McFarlin
b45971682f Revert "merge conflict resolution"
This reverts commit f293c94419.
2013-11-08 16:54:18 -05:00
Tom McFarlin
09e87acdcc Merge branch 'master' of https://github.com/tommcfarlin/WordPress-Plugin-Boilerplate 2013-11-08 16:53:30 -05:00
Tom McFarlin
f293c94419 merge conflict resolution 2013-11-08 16:53:27 -05:00
akshayraje
630408340f Replaced deleted comment block 2013-11-08 14:01:01 +05:30
akshayraje
a80b2ca7a4 Updated plugin-name.php to get all name replacement changes at one place 2013-11-08 13:51:30 +05:30
Silvan Hagen
7dbfeb95bd Fix textdomain not loading
Before: public/languages
After: plugin-name/languages
2013-11-07 17:41:03 +01:00
Silvan Hagen
f844d0a075 Fix $plugin_basename to allow plugin_action_links
With the move to /admin and /public directory, the class-plugin-name-admin.php needed to be changed to use __DIR__ instead of __FILE__ to create the $plugin_basename, otherwise the hook would be something like plugin_action_links_plugin-name/admin/plugin-name.php which doesn't work.
2013-11-04 16:26:19 +01:00
Ulrich Pogson
b463e3398c Place the TODOs in the correct position 2013-11-01 14:53:10 +01:00
Tom McFarlin
1de634b31f adding empty includes directories as a place for shared functionality
related #100
2013-11-01 08:31:52 -04:00
Tom McFarlin
a36f3079bd removing files from the plugin root
related #100
2013-10-30 16:51:33 -04:00
Tom McFarlin
aa9368a81f updating a comment 2013-10-30 16:50:42 -04:00
Tom McFarlin
9d8f38b339 moving all public related code to a self-contained subdirectory
related #100
2013-10-30 16:50:36 -04:00
Tom McFarlin
ba5bddf891 adding public and admin comments. conditionally loading the admin class.
related #104
2013-10-30 16:50:09 -04:00
Tom McFarlin
32884b0515 removing files from the main plugin directory in favor of admin and public specific directories
related #100
2013-10-30 16:49:30 -04:00
Tom McFarlin
0796e8e638 moving all of the admin-specific functionality into the admin subdirectory
related #100
2013-10-30 16:49:01 -04:00
Tom McFarlin
f894ee25c0 loading the admin class only if the dashboard is being loaded
fixes #104
2013-10-30 16:27:26 -04:00
Ulrich Pogson
037e246074 Add TODO for Plugin_Name::VERSION 2013-10-27 20:55:36 +01:00
Ulrich Pogson
fc3de2376c Replace plugin-name with plugin_slug & remove TODO 2013-10-27 19:51:20 +01:00
Tom McFarlin
fcac09e874 removing a redundant comment delimiter 2013-10-27 14:29:01 -04:00
haleeben
60d06f6446 Added a TODO to prompt the user to change the plugin-name 2013-10-27 16:37:26 +11:00
will83
62769f4225 Update class-plugin-name-admin.php 2013-10-24 19:06:37 +02:00
Tom McFarlin
25c4fdcf70 updating the references to the languages directory as per @grappler's original implementation 2013-10-21 07:30:40 -04:00
Ulrich Pogson
a77b1a7463 Update plugin-name.pot 2013-10-19 14:42:33 +02:00
Tom McFarlin
f211910b4a removing the scope qualifier on the constant 2013-10-17 16:35:14 -04:00
Tom McFarlin
70ff70f537 adding whitespace between the header and the markup 2013-10-17 16:32:25 -04:00
Tom McFarlin
aa01ca281c removing extraneous whitespace, making sure comment lines don't exceed 80 characters, and providing updated comment blocks for functions, inline comments, and documentation for the new admin class 2013-10-17 16:23:04 -04:00
Tom McFarlin
467d5e290f removing extraneous whitespace, making sure comment lines don't exceed 80 characters, and providing updated comment blocks for functions, inline comments, and documentation for the new admin class 2013-10-17 16:22:57 -04:00