1
0
Fork 0
mirror of https://github.com/inretio/WordPress-Plugin-Boilerplate synced 2024-05-19 11:42:09 +03:00

Compare commits

...

208 commits

Author SHA1 Message Date
Gytis Repečka a57e6e7460
Add shortcode support. 2020-07-17 16:58:32 +03:00
Devin a8291082b5
Merge pull request #508 from alertmybanjos/patch-2
Update README.md
2019-02-22 11:15:41 -05:00
Devin d2f6b21b80
Merge pull request #507 from alertmybanjos/patch-1
Update README.md
2019-02-22 11:15:26 -05:00
Jason Tremblay f142df8c45
Update README.md
More specific, case sensitive string changes for initial setup.
2019-02-22 06:29:41 -05:00
Jason Tremblay 611c80cce1
Update README.md
Clarify the renaming step to align with the actual file names, which are currently named with dashes, not underscores.
2019-02-22 05:56:58 -05:00
Devin 60940a9761
Merge pull request #456 from manzoorwanijk/patch-1
Typo correction
2018-01-06 15:40:49 -05:00
Manzoor Wani b02101400e
Typo correction 2017-12-07 14:29:48 +05:30
Devin bc3e07be2a
Merge pull request #453 from Ipstenu/Ipstenu-rtfm
Documentation update for Plugin Version constant. Thank you @Ipstenu
2017-11-27 17:34:45 -05:00
Ipstenu (Mika Epstein) 95844fec48
Inline doc 2017-11-27 14:09:08 -08:00
Ipstenu (Mika Epstein) 696db21ed7
Clarifying directions 2017-11-27 14:07:36 -08:00
Devin 7af6de6dd2 Merge pull request #446 from jonathanbossenger/master
Updating PLUGIN_VERSION constant. Fixes #446
2017-09-27 19:37:57 -04:00
Jonathan Bossenger 04f90ff5ff Updating PLUGIN_VERSION to PLUGIN_NAME_VERSION to follow plugin standards for renaming 2017-09-27 16:13:29 +02:00
Devin 1f36abcedd Merge pull request #443 from Tmeister/master
Wraps the PLUGIN_VERSION constant in single quotes
2017-09-12 08:53:40 -04:00
Enrique Chavez 65a87940e9 Wraps the PLUGIN_VERSION constant in single quotes
* Fix #442
* Avoids the notice output
2017-09-11 11:33:00 -05:00
Devin 1f3c2acbe2 Merge pull request #417 from davidshq/patch-1
Small Spelling / Grammar Changes
2017-08-30 09:13:14 -04:00
Devin 77baf0b2f5 Merge pull request #429 from cliffordp/patch-2
Typo: "he" to "The"
2017-08-30 09:11:44 -04:00
Devin 19809447ec Merge pull request #353 from TalAter/patch-1
Fixed mistake in comment.
2017-08-30 09:11:20 -04:00
Devin 872c67477a Merge pull request #439 from jonathanbossenger/feature/version-constant
Adding a version constant
2017-08-30 09:04:32 -04:00
Jonathan Bossenger 5af56b19a5 Adding a version constant 2017-07-17 10:04:31 +02:00
Clifford ded444099b Typo: "he" to "The" 2017-05-19 17:39:12 -05:00
Dave Mackey c719bf9fc7 Small Spelling / Grammar Changes
Corrected a few small spelling / grammar issues throughout - very minor.
2017-01-19 21:41:23 -05:00
Devin Vinson 923fbaf0c8 Merge branch 'remove-var-translation' 2015-12-11 12:58:15 -05:00
Devin Vinson 0c099e4208 Use plugin-name directly instead of passing a variable through
This should fix the incorrect pattern of using a variable where we
should be using the plugin-name instead. Same goes for any translatable
strings within the plugin (no more using $this->plugin-name etc).
2015-12-05 20:46:30 -05:00
Tal Ater 579fb9823a Fixed mistake in comment. 2015-11-25 20:48:25 -05:00
Devin 39cb7ccfb3 Merge pull request #350 from hareesh-pillai/master
Update URL for Documentation Standards
2015-11-20 11:42:26 -05:00
Devin 6f217e9efd Merge pull request #349 from pieroit/patch-1
Update plugin-name-admin.js
2015-11-20 11:42:00 -05:00
Hareesh 0ea2ae758e Update URL for Documentation Standards 2015-11-15 01:23:52 +05:30
Piero Savastano fcd4669f35 Update plugin-name-admin.js
typo in the comment
2015-11-11 16:33:27 +01:00
Devin 2508a4567b Merge pull request #340 from LeeRobertsMe/patch-1
Update class-plugin-name-public.php so the correct file type is defined.
2015-11-03 08:25:04 -05:00
Devin 1b487de0db Merge pull request #342 from LeeRobertsMe/patch-5
Update plugin-name-public.js
2015-11-03 08:24:26 -05:00
Devin 84741e2c1b Merge pull request #343 from LeeRobertsMe/patch-4
Update plugin-name-admin.js
2015-11-03 08:24:03 -05:00
Devin 4e84183fd4 Merge pull request #339 from Shelob9/loader-docs-338
Add corrected inline docs in the loader class
2015-10-21 08:36:14 -04:00
LeeRobertsMe 360c8ea6e4 Update plugin-name-admin.js 2015-10-08 13:35:24 +01:00
LeeRobertsMe a11edd3138 Update plugin-name-public.js 2015-10-08 13:29:18 +01:00
LeeRobertsMe 1fe19e455f Update class-plugin-name-public.php 2015-10-08 12:25:28 +01:00
Josh Pollock 897fa95e23 Add inline docs in the loader class #338 2015-10-02 15:35:30 -04:00
Devin 55f28eeb9f Merge pull request #324 from javy-/patch-1
Update CHANGELOG with correct year.md
2015-08-13 09:45:17 -04:00
javy- ff46923e03 Update CHANGELOG.md
Fix latest change date year (2014->2015)
2015-08-08 16:48:17 -04:00
Devin 5d51804dea Merge pull request #323 from davidshq/master
Update README.md
2015-08-01 01:01:05 -04:00
Dave Mackey 6f0aabf3be Update README.md
Changed "this feature" to "these features"
2015-07-31 12:48:05 -04:00
Devin Vinson 5391e0ca27 Remove .org parent folder structure
Flattening the folder structure for a bit easier auto-inclusion into
projects and local development.

See:
https://github.com/DevinVinson/WordPress-Plugin-Boilerplate/issues/295
2015-07-03 23:33:03 -04:00
Devin 3d3f181924 Merge pull request #266 from jancbeck/admin-area-dashboard-wording
changed wording from "dashboard" to "admin area"
2015-03-09 09:58:10 -04:00
Devin Vinson a5e181192b Updated Readme
Added a note about current project lead and pointing inquires away from
Tom’s contact form.
2015-03-04 15:21:25 -05:00
Jan Beck 9c14d6e3eb changed "dashboard" to "admin area"
dashboard-specific becomes admin-specific
2015-02-13 14:31:40 -04:00
Tom McFarlin b469237bda Merge pull request #260 from slushman/master
Function docs should be @param not @var.
2015-02-03 12:18:42 -05:00
Chris Wilcoxson 2683f494ea Function docs should be @param not @var. 2015-02-03 11:15:28 -06:00
Tom McFarlin 474e64911c Merge pull request #254 from donnapep/chore/change-loader-class-names
Fix incorrect class names
2015-01-19 09:51:22 -05:00
Donna Murphy 582ccadde0 Fix incorrect class names 2015-01-17 12:45:15 -05:00
Tom McFarlin 470d0ec13c Merge pull request #250 from swalkinshaw/CHANGELOG-fix
Fix CHANGELOG filename
2015-01-05 13:01:35 -05:00
Scott Walkinshaw 78624f6cdd Fix CHANGELOG filename 2015-01-05 11:42:45 -05:00
Tom McFarlin 629b1628ca Merge pull request #243 from tnorthcutt/patch-1
Fix minor typo in README.md
2014-12-01 14:52:30 -05:00
Travis Northcutt 411b1d19b9 Fix minor typo in README.md 2014-11-26 09:57:22 -06:00
Tom McFarlin 72cda6eeaf Merge pull request #238 from gosukiwi/patch-1
Use the same syntax for all included files.

Fixes #238
2014-11-19 13:59:21 -05:00
Federico Ramirez 042c13b7b1 Use the same syntax for all included files
I was having issues activating the plugin, and it was because of the way the files were beeing included, this fixes it.
2014-11-19 09:25:59 -03:00
Tom McFarlin ec4c52c115 Merge pull request #237 from feskehau/master
Create functions for activation and deactivation hooks.
2014-11-17 12:32:39 -05:00
Tony Hesjevik e015b9cd7c Create functions for activation and deactivation hooks.
Moving the activation and deactivation hooks into its own functions, makes so we dont have to include class-plugin-name-deactivator and class-plugin-name-activator on every page load.
2014-11-17 23:33:00 +11:00
Tom McFarlin 3c47bc0b5a Merge pull request #235 from barryceelen/patch-1
Fix code comment typo
2014-11-10 14:15:37 -05:00
Barry Ceelen f51ee23a1f Fix code comment typo 2014-11-10 16:57:08 +01:00
Tom McFarlin f11711f07e Merge pull request #231 from NikV/patch-1
Fixing require() vs require_once()
2014-11-05 12:08:34 -05:00
Nikhil Vimal 2960b6c1c8 Fixing require() vs require_once()
See : https://github.com/tommcfarlin/WordPress-Plugin-Boilerplate/issues/222. I believe this was in favor of doing it "correctly"?
2014-11-04 16:47:16 -06: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
Tom McFarlin f112840426 Merge pull request #220 from iamdmitrymayorov/master
Minor comment fix.
2014-10-07 16:34:23 -04:00
Dmitry Mayorov 7a12d6aa66 Update class-plugin-name-public.php
Updated @subpackage from 'admin' to 'public'
2014-10-05 19:36:55 +06:00
Dmitry Mayorov 163c2a86c1 Update class-plugin-name-admin.php
Changed @subpackage from 'includes' to 'admin'.
2014-10-05 19:35:03 +06:00
Tom McFarlin b08802742d Merge pull request #216 from JustinSainton/please-stop-shouting-at-me
Please stop shouting at me. I do hate when my parents shout.
2014-09-11 06:46:59 -04: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 f4bbb821c2 Merge branch 'master' of https://github.com/tommcfarlin/WordPress-Plugin-Boilerplate 2014-09-04 09:45:48 -04:00
Tom McFarlin 16c93f8548 Adding instructions for Windows symlinks
Fixes #213
2014-09-04 09:44:54 -04:00
Tom McFarlin d5bb3c526f Merge pull request #214 from jessertaylor/master
Fixed deactivation hook in plugin_name.php
2014-09-03 10:57:25 -04:00
jessertaylor 8f002bfc4d Fixed deactivation hook in plugin_name.php 2014-09-03 15:11:55 +01:00
Tom McFarlin 06605429d3 describe how to install the Boilerplate.
Updating the `README` to describe how to install the Boilerplate.

Fixes #213
2014-09-03 09:26:49 -04:00
Tom McFarlin c8bd2e38af Merge pull request #211 from rob/patch-1
Fix typo in plugin-name.php
2014-09-02 13:55:18 -04:00
Rob Gabaree 50f2a612f8 Fix typo in plugin-name.php 2014-09-02 13:16:20 -04:00
Tom McFarlin 097afb19b7 Merge pull request #210 from rob/patch-1
Fix incorrect date in ChangeLog.md
2014-09-02 12:27:35 -04:00
Rob Gabaree d2a71ed513 Fix incorrect date in ChangeLog.md 2014-09-02 12:26:08 -04:00
Tom McFarlin cda33620e7 Merge remote-tracking branch 'origin/master' into develop
Conflicts:
	ChangeLog.md
	README.md
	plugin-name/admin/class-plugin-name-admin.php
	plugin-name/plugin-name.php
	plugin-name/public/class-plugin-name.php
	plugin-name/trunk/README.txt
	plugin-name/uninstall.php
2014-09-01 20:42:08 -04:00
Tom McFarlin c3c95e0a81 updating credits 2014-09-01 10:38:09 -04:00
Tom McFarlin e387eabfc1 update to the README 2014-09-01 10:33:51 -04:00
Tom McFarlin 0d21f63eda Adding the initial version of the README 2014-09-01 10:32:22 -04:00
Tom McFarlin 436ca4a72b cleaning up the changelog 2014-09-01 10:30:10 -04:00
Tom McFarlin 39275f0cbf Merge branch 'develop' of https://github.com/tommcfarlin/WordPress-Plugin-Boilerplate into develop 2014-09-01 09:46:44 -04:00
Tom McFarlin 15de548f39 adding a placeholder for the plugin icon 2014-09-01 09:45:57 -04:00
Tom McFarlin 0694bf9302 Merge pull request #206 from michaelbeil/patch-2
added periods in first list for consistency
2014-08-21 12:32:11 -04:00
Michael Beil fc2a90f412 added periods in first list for consistency 2014-08-21 11:30:45 -05:00
Tom McFarlin f62930975f Merge pull request #203 from michaelbeil/patch-1
Us to use
2014-08-21 10:05:38 -04:00
Michael Beil 4a092e1a77 Us to use 2014-08-20 17:42:18 -05:00
Tom McFarlin 56a494c944 Merge pull request #202 from douglsmith/patch-1
Fix minor typo in plugin-name.php description text
2014-08-19 16:07:17 -04:00
Doug Smith b8a357b336 Fix minor typo in plugin-name.php description text 2014-08-19 15:06:09 -05:00
Tom McFarlin b421ddaaaa Updating notes and updated date. 2014-08-19 08:51:56 -04: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 6782bb5ec3 Updating a comment 2014-08-16 16:30:16 -04:00
Tom McFarlin bcc1d91782 Update the 'last updated' date 2014-08-05 16:43:31 -04:00
Tom McFarlin 2e9ae6ac99 Populating the DocBlock
Fixes #123
2014-08-05 16:43:08 -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 35650c1b7b Setting the reference using the proper variable 2014-08-01 16:59:31 -04:00
Tom McFarlin aea004af54 Chaing the doc from 'slug' to 'string' 2014-08-01 16:59:19 -04:00
Tom McFarlin ef63ff4a91 Merge branch 'develop' of https://github.com/tommcfarlin/WordPress-Plugin-Boilerplate into develop 2014-08-01 16:56:38 -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 bfb7e6fb58 Merge pull request #197 from grappler/plugin-header
Move text domain lower down
2014-07-30 16:15:43 -04:00
Tom McFarlin 9b5afad159 Merge pull request #198 from grappler/uninstall-header
Update uninstall header for consistency
2014-07-30 16:14:59 -04:00
Tom McFarlin 0eb25eefba Merge pull request #200 from grappler/duplicate-doc
Remove duplicate documentation
2014-07-30 16:14:36 -04:00
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 3154e38822 updating the 'last updated' date 2014-07-07 16:59:02 -04:00
Tom McFarlin 3ae56a6460 adding a comma that was preventing a syntax problem 2014-07-07 16:56:54 -04:00
Tom McFarlin a3cce1d965 updating 'last updated' dates 2014-06-26 16:46:14 -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 547319a8b6 Merge pull request #187 from defries/master
Added grunt-wp-i18n solution for i18n-ing the plugin
2014-06-10 10:48:59 -04:00
Remkus de Vries ddc916762b Added grunt-wp-i18n solution for i18n-ing the plugin 2014-06-10 14:25:26 +02:00
Tom McFarlin 5efc89dc3b Merge pull request #186 from grappler/activate-deactivate
Move restore_current_blog in the correct position
2014-05-31 22:05:10 -04:00
Ulrich Pogson e75e6e2c57 Move restore_current_blog in the correct position 2014-06-01 00:06:29 +02:00
Tom McFarlin b7caa3e958 updating last updated dates 2014-05-08 23:35:44 -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 24c1cca493 updating the read me and change log to reflect the latest changes of the plugin 2014-05-03 15:29:17 -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 96018e57b0 updating the change log to reflect notes on the version of the boilerplate 2014-05-01 23:44:12 -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 92e4693a8f updating the last updated date and what the final tag name will be 2014-05-01 23:27:41 -04:00
Tom McFarlin d5446ad5c1 updating the date in the core README 2014-05-01 23:26:55 -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 bbf95fd0e2 updating the read me to reference the change log as per the rewrite
Signed-off-by: Tom McFarlin <tom@tommcfarlin.com>
2014-03-18 21:53:35 -04:00
Tom McFarlin efaf29f5d8 restarting the change log for this branch
we'll merge this change log with the master branch when we merge the two branches together

Signed-off-by: Tom McFarlin <tom@tommcfarlin.com>
2014-03-18 21:53:23 -04:00
Tom McFarlin 8489c37749 Updating the read me to explain the changes that are coming in this branch.
Signed-off-by: Tom McFarlin <tom@tommcfarlin.com>
2014-03-13 10:28:54 -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
41 changed files with 942 additions and 1029 deletions

5
CHANGELOG.md Normal file
View file

@ -0,0 +1,5 @@
# Changelog
* (3 July 2015). Flattened the folder structure so there is no .org repo parent folder.
* (4 September 2014). Updating the `README` with Windows symbolic link instructions.
* (3 September 2014). Updating the `README` to describe how to install the Boilerplate.
* (1 September 2014). Initial Release.

View file

@ -1,172 +0,0 @@
## 2.6.2 (9 May 2014)
* Moving `$wpdb` outside of the conditional so both cases work
## 2.6.1 (20 November 2013)
* Updating the localization functions to that `load_textdomain` is called.
* Removing plugin textdomain
* Changing 'decomment' to 'uncomment'
* changing all 'TODO' to '@TODO'
* Removed the trailing slash (@jameswlane)
* Revert "Extended and aligned comment header" (@franz-josef-kaiser)
* Extended and aligned comment header (@franz-josef-kaiser)
* Update class-plugin-name-admin.php (@rockaut)
* Replaced deleted comment block (@akshayraje)
* Updated plugin-name.php to get all name replacement changes at one place (@akshayraje)
* Fix textdomain not loading (@neverything)
* Fix $plugin_basename to allow plugin_action_links (@neverything)
## 2.6.0 (1 November 2013)
* Adding includes, admin/includes, public/includes for housing libraries and dependecies (garyjones)
* Merging changes from the previous, untagged version, into this version
* Removing left over files from the plugin root
* Moving all public-specific functionality into the public subdirectory
* Moving all admin-specific functionality into the admin subdirectory
* Loading the admin class only if the dashboard is being loaded
* Added a TODO for Plugin_Name::Version (grappler)
* Replacing plugin-name with plugin_slug and removed a TODO (grappler)
* Added a 'TODO' to prmpt the user to change the plugin name (haleeben)
* Updating the class-plugin-name.admin.php (will83)
* Updating references to the languages directory
* Update plugin-name.pos (grappler)
* Including more information about the GitHub Upater
* Updating the read me to include the new features of the boilerplate
* Adding whitespace between the header and the markup of the views
* Removing a lot of whitespace, updating function comments, and comment blocks within a function, and making sure no comments exceed 80 characters
* Adding a 'TODO' so users can more easily find where all they need to supply the name of their plugin
* Update README.txt (grappler)
* Defining a section to provide links for recommended tools
* Adding a 'GitHub Plugin URI' to the wordpress-plugin header
* Updating the javascript to include more whitespace as per the WordPress JavaScript Coding Standards
* Update inline documentation (grappler)
* Add admin class (grappler)
* Update $plugin_slug comment (barryceelen)
* Place options page under 'Settings' in stead of 'Plugins' menu (barryceelen)
* Replace plugin-name with $this->plugin_slug in add_action_links (barryceelen)
* Removes 'Change 'plugin-name' to the name of your plugin' from DocBlock (barryceelen)
* Mention uninstall.php in code comment (barryceelen)
* Removes reference to register_uninstall_hook from code comment (barryceelen)
* Initialize plugin on plugins_loaded hook (barryceelen)
* Change default capability to 'manage_options' (nextgenthemes)
* Make WP_LANG_DIR constant safer (GaryJones)
* Replacing `$this->version` by the new class constant (GeertDD)
* Update activate_new_site did_action to become Yoda condition (thuijssoon)
* Fix typo and move add_filter under menu add_action (Grappler)
* Storing plugin version in a class constant (GeertDD)
* Removing useless closing php tags (GeertDD)
* Fix loading textdomain when the plugin is symlinked (andrejcremoznik)
* Fix typo (grappler)
* Add action link to plugin page (grappler)
* Replacing all instances of PluginName with PluginName as per the WordPress Coding Standards
* Added multisite activation/deactivation functionality. (thuijssoon)
* Adding index.php with silence is golden security method (danielantunes)
* Added empty array for dependency to fix version number. (tokkonopapa)
* Updating `PluginName` to `Plugin_Name` to follow the WordPress Coding Standards
* Removing some whitespace in the first line of the README file
* Removing an unnecessary apostrophe from the Boilerplate README.txt
## 2.5.1 (17 May 2013)
* Updating a reference to the plugin slug
## 2.5.0 (16 May 2013)
* Updating `readme.txt` to be up to standard with the current WordPress Plugin Repository demo
* Updating page-level DocBlocks for consistency
## 2.4.0 (15 May 2013)
* Renaming and updating references in the pot file to match the new file names
* Renaming all `display` files to `public` (i.e., `display.js` to `public.js`)
* Updating references in comments and in code to the plugin class files and plugin files
* Updating the way the plugin terminates execution if accessed directly
* Updating code comments, clearing extraneous whitespace
* Renaming files to be more consistent with the example name of the plugin
* Renaming 'plugin-boilerplate' to 'plugin-name' to be more consistent with the naming conventions of the class file
* Adding a sample screenshot to match the example WordPress Plugin Repository `readme.txt`
* Removing the plugin version constant in favor of a property in the plugin class
* Adding proper page-level DocBlocks
## 2.3.0 (13 May 2013)
* Moving the activation hooks outside of the class and marking the methods as static
* Removing the @version tag from everything but the core plugin class
* Removing deprecating @subpackage tags
* Renaming the changelog filename to follow the canonical convention
* Including an `assets` directory with sample images and instructions for how to use it
* Finalized page-level documentation to the PHP files
* Moving to the plugin boilerplate to its own class
* Adding DocBlocks to the views
* Generalizing the name, language, and email address in the `.pot` file
* Updating the DocBlock in the uninstall file
* Adding the 'Domain Path' to the header of the plugin file
* Moving the changelog into its own file
* Updating GPL licensing and adding a note about licensing with the GPL and the Apache license
* Removing terminating code comments from the admin view
* Removing the localization functions from plugin page parameters
* Adding 'Text Domain' to the plugin header
* Adding gettext and plural forms to the `.pot` file
* Replacing all midline tabs and replacing them with tabs
* Removing tabs and spaces from empty lines
* Adding a security check to prevent the plugin file from being accessed directly
* Improving spacing to better comply with coding conventions
* Adding LICENSE.txt and removing it from the plugin's header
## 2.2.1 (10 May 2013)
* Updating the `.pot` file as it was resulting in a minor error in one of the translation tools.
## 2.2.0 (10 May 2013)
* Updating the README so the demo changelog is more accurate
* Renaming the core plugin file to match the name of the plugin (specifically `plugin-boilerplate.php` from `plugin.php`)
* Removing the default `.po` file and introducing the `plugin-boilerplate.pot` catalog
* Removing all terminating code block comments
* Adding braces around the `uninstall.php` conditional
* Changing access modifiers from `private` to `protected`. See [this discussion](https://github.com/tommcfarlin/WordPress-Plugin-Boilerplate/issues/36) for more details.
* Removing redundant headers since properties, constructors, and methods are clearly defined and segmented throughout the code.
## 2.1.0 (9 May 2013)
* Refactoring the ternary operator in the constructor to make the code more readable for developers and to avoid returning an orphaned object
* Updating certain function names to use verbs to be clearer in their purpose
* Updating versioning in the plugin and in the `README` to use the `x.y.z` convention rather than the `x.y` convention
* Adding class property DocBlocks
* Adding `@since` tags to each of the DocBlocks for methods
* Cleaning up the PHP code formatting for easier readability
* Adding a note about POEdit and it being used as my preferred translations
* Automatically displaying the name of the plugin admin page
* Changing 'directives' to 'tags'
* Updating page-level DocBlocks for `plugin.php` and for `uninstall.php`
## 2.0.1 (7 May 2013)
* Updating the year of the release of 2.0
## 2.0.0 (7 May 2013)
* Disabling the admin menu by default
* Initializing the attributes
* Combining the `admin_open` and `admin_close` into a single `admin` view
* Bringing some of the code up to the WordPress coding standards
* Added access modifiers for functions
* Implemented the single pattern
* **japh**. Merged upstream changes, maintained separation of uninstall functionality
* **mikkelbreum**. Restricted scripts and styles to load only on plugin settings page if it is enabled.
* **mikkelbreum**. Added the option for a plugin settings page
* **mikkelbreum**. Removed the need to customize the URL for `wp_enqueue_style` and `wp_enqueue_scripts`
* **mikkelbreum**. Corrected action book for `register_admin_styles`
* **tbwiii**. Listed jQuery as a dependency for both JavaScript sources
* **japh**. Added an `uninstall.php` placeholder
* **leewillis77**. Improved the way language files are loaded
* **wesbos**. Updated the year to 2013
## 1.0 (29 November 2012)
* Official Release
## Author Information
The WordPress Plugin Boilerplate was originally started and is maintained by [Tom McFarlin](http://twitter.com/tommcfarlin/), but is constantly under development thanks to the contributions from the many WordPress developers throughout the world.

123
README.md
View file

@ -1,85 +1,62 @@
# WordPress Plugin Boilerplate
The WordPress Plugin Boilerplate serves as a foundation and aims to provide a clear and consistent guide for building your WordPress plugins. Just download, replace a few instances of 'plugin-name' with the name of your own plugin, and you'll get to the meat of coding your plugin in no time!.
## Features
* The Plugin Boilerplate is fully-based on the WordPress [Plugin API](http://codex.wordpress.org/Plugin_API).
* Uses [PHPDoc](http://en.wikipedia.org/wiki/PHPDoc) conventions to document the code.
* Example values are given, so you can see what needs to be changed.
* Uses a strict file organization scheme to make sure the assets are easily maintainable.
* Note that this boilerplate includes a `.pot` as a starting translation file.
* Notes on managing assets prior to deployment are covered below
* Tools used for translation are below
A standardized, organized, object-oriented foundation for building high-quality WordPress Plugins.
## Contents
The WordPress Plugin Boilerplate includes the following files:
* This README, a ChangeLog, and a `gitignore` file.
* A subdirectory called `plugin-name` that represents the core plugin file.
* `.gitignore`. Used to exclude certain files from the repository.
* `CHANGELOG.md`. The list of changes to the core project.
* `README.md`. The file that youre currently reading.
* A `plugin-name` directory that contains the source code - a fully executable WordPress plugin.
## Features
* The Boilerplate is based on the [Plugin API](http://codex.wordpress.org/Plugin_API), [Coding Standards](http://codex.wordpress.org/WordPress_Coding_Standards), and [Documentation Standards](https://make.wordpress.org/core/handbook/best-practices/inline-documentation-standards/php/).
* All classes, functions, and variables are documented so that you know what you need to change.
* The Boilerplate uses a strict file organization scheme that corresponds both to the WordPress Plugin Repository structure, and that makes it easy to organize the files that compose the plugin.
* The project includes a `.pot` file as a starting point for internationalization.
## Installation
1. Copy the `plugin-name` directory into your `wp-content/plugins` directory
2. Navigate to the *Plugins* dashboard page
3. Locate the menu item that reads *TODO*
4. Click on *Activate*
The Boilerplate can be installed directly into your plugins folder "as-is". You will want to rename it and the classes inside of it to fit your needs. For example, if your plugin is named 'example-me' then:
This will activate the WordPress Plugin Boilerplate. Because the Boilerplate has no real functionality, nothing will be added to WordPress; however, this demonstrates exactly how your plugin should behave while you're working with the Boilerplate.
* rename files from `plugin-name` to `example-me`
* change `plugin_name` to `example_me`
* change `plugin-name` to `example-me`
* change `Plugin_Name` to `Example_Me`
* change `PLUGIN_NAME_` to `EXAMPLE_ME_`
It's safe to activate the plugin at this point. Because the Boilerplate has no real functionality there will be no menu items, meta boxes, or custom post types added until you write the code.
## WordPress.org Preparation
The original launch of this version of the boilerplate included the folder structure needed for using your plugin on WordPress.org. That folder structure has been moved to its own repo here: https://github.com/DevinVinson/Plugin-Directory-Boilerplate
## Recommended Tools
### Localization Tools
### i18n Tools
The WordPress Plugin Boilerplate uses a variable to store the text domain used when internationalizing strings throughout the Boilerplate. To take advantage of this method,
there are tools that are recommended for providing correct, translatable files:
The WordPress Plugin Boilerplate uses a variable to store the text domain used when internationalizing strings throughout the Boilerplate. To take advantage of this method, there are tools that are recommended for providing correct, translatable files:
* [Poedit](http://www.poedit.net/)
* [makepot](http://i18n.svn.wordpress.org/tools/trunk/)
* [i18n](https://github.com/grappler/i18n)
Any of the above tools should provide you with the proper tooling to localize the plugin.
### GitHub Updater
The WordPress Plugin Boilerplate includes native support for the [GitHub Updater](https://github.com/afragen/github-updater) which allows you to provide updates to your WordPress plugin from GitHub.
This uses a new tag in the plugin header:
> `* GitHub Plugin URI: https://github.com/<owner>/<repo>`
Here's how to take advantage of this feature:
1. Install the [GitHub Updater](https://github.com/afragen/github-updater)
2. Replace `<owner>` with your username and `<repo>` with the repository of your plugin
3. Push commits to the master branch
4. Enjoy your plugin being updated in the WordPress dashboard
The current version of the GitHub Updater supports tags/branches - whichever has the highest number.
To specify a branch that you would like to use for updating, just add a `GitHub Branch:` header. GitHub Updater will preferentially use a tag over a branch having the same or lesser version number. If the version number of the specified branch is greater then the update will pull from the branch and not from the tag.
The default state is either `GitHub Branch: master` or nothing at all. They are equivalent.
All that info is in [the project](https://github.com/afragen/github-updater).
Any of the above tools should provide you with the proper tooling to internationalize the plugin.
## License
The WordPress Plugin Boilerplate is licensed under the GPL v2 or later.
> This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License, version 2, as
published by the Free Software Foundation.
> This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, version 2, as published by the Free Software Foundation.
> This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
> This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
> You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
> You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
A copy of the license is included in the root of the plugins directory. The file is named `LICENSE`.
## Important Notes
@ -93,34 +70,30 @@ For reference, [here's a discussion](http://make.wordpress.org/themes/2013/03/04
Note that if you include your own classes, or third-party libraries, there are three locations in which said files may go:
1. `plugin-name/includes` is where shared functionality should be placed between `public` and `admin`
2. `plugin-name/admin/includes` is where dashboard-specific classes and dependencies should be placed
3. `plugin-name/public/includes` is where public-specific classes and dependencies should be placed
* `plugin-name/includes` is where functionality shared between the admin area and the public-facing parts of the site reside
* `plugin-name/admin` is for all admin-specific functionality
* `plugin-name/public` is for all public-facing functionality
## Assets
Note that previous versions of the Boilerplate did not include `Plugin_Name_Loader` but this class is used to register all filters and actions with WordPress.
The assets directory provides two files that are used to represent plugin header images.
The example code provided shows how to register your hooks with the Loader class.
When committing your work to the WordPress Plugin Repository, these files should reside in their own `assets` directory, not in the root of the plugin. The initial repository will contain three directories:
### What About Other Features?
1. `branches`
2. `tags`
3. `trunk`
The previous version of the WordPress Plugin Boilerplate included support for a number of different projects such as the [GitHub Updater](https://github.com/afragen/github-updater).
You'll need to add an `assets` directory into the root of the repository. So the final directory structure should include *four* directories:
These tools are not part of the core of this Boilerplate, as I see them as being additions, forks, or other contributions to the Boilerplate.
1. `assets`
2. `branches`
3. `tags`
4. `trunk`
The same is true of using tools like Grunt, Composer, etc. These are all fantastic tools, but not everyone uses them. In order to keep the core Boilerplate as light as possible, these features have been removed and will be introduced in other editions, and will be listed and maintained on the project homepage.
Next, copy the contents of the `assets` directory that are bundled with the Boilerplate into the root of the repository. This is how the WordPress Plugin Repository will retrieve the plugin header image.
# Credits
Of course, you'll want to customize the header images from the place holders that are provided with the Boilerplate.
The WordPress Plugin Boilerplate was started in 2011 by [Tom McFarlin](http://twitter.com/tommcfarlin/) and has since included a number of great contributions. In March of 2015 the project was handed over by Tom to Devin Vinson.
For more, in-depth information about this, read [this post](http://make.wordpress.org/plugins/2012/09/13/last-december-we-added-header-images-to-the/) by [Otto](https://twitter.com/Otto42).
The current version of the Boilerplate was developed in conjunction with [Josh Eaton](https://twitter.com/jjeaton), [Ulrich Pogson](https://twitter.com/grapplerulrich), and [Brad Vincent](https://twitter.com/themergency).
Plugin screenshots can be saved to one of two locations:
The homepage is based on a design as provided by [HTML5Up](http://html5up.net), the Boilerplate logo was designed by Rob McCaskill of [BungaWeb](http://bungaweb.com), and the site `favicon` was created by [Mickey Kay](https://twitter.com/McGuive7).
1. The old way is to keep them in the root of the plugin directory. This will increase the size of the download of the plugin, but make the images accessible for those who install it. This is deprecated in the WordPress Plugin Boilerplate
2. With the alternative way, you can save the screenshots in the `assets` directory, as well. The repository will look here for the screenshot files as well; however, they will not be included in the plugin download thus reducing the size of the plugin. As of its latest version, the WordPress Plugin Boilerplate now follows this convention.
## Documentation, FAQs, and More
If youre interested in writing any documentation or creating tutorials please [let me know](http://devinvinson.com/contact/) .

View file

@ -1,10 +1,10 @@
=== @TODO: Plugin Name ===
Contributors: (this should be a list of wordpress.org userids)
=== Plugin Name ===
Contributors: (this should be a list of wordpress.org userid's)
Donate link: http://example.com/
Tags: comments, spam
Requires at least: 3.5.1
Tested up to: 3.6
Stable tag: 1.0.0
Requires at least: 3.0.1
Tested up to: 3.4
Stable tag: 4.3
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
@ -43,28 +43,9 @@ This section describes how to install the plugin and get it working.
e.g.
= Using The WordPress Dashboard =
1. Navigate to the 'Add New' in the plugins dashboard
2. Search for 'plugin-name'
3. Click 'Install Now'
4. Activate the plugin on the Plugin dashboard
= Uploading in WordPress Dashboard =
1. Navigate to the 'Add New' in the plugins dashboard
2. Navigate to the 'Upload' area
3. Select `plugin-name.zip` from your computer
4. Click 'Install Now'
5. Activate the plugin in the Plugin dashboard
= Using FTP =
1. Download `plugin-name.zip`
2. Extract the `plugin-name` directory to your computer
3. Upload the `plugin-name` directory to the `/wp-content/plugins/` directory
4. Activate the plugin in the Plugin dashboard
1. Upload `plugin-name.php` to the `/wp-content/plugins/` directory
1. Activate the plugin through the 'Plugins' menu in WordPress
1. Place `<?php do_action('plugin_name_hook'); ?>` in your templates
== Frequently Asked Questions ==
@ -107,7 +88,27 @@ You may provide arbitrary sections, in the same format as the ones above. This
plugins where more information needs to be conveyed that doesn't fit into the categories of "description" or
"installation." Arbitrary sections will be shown below the built-in sections outlined above.
== Updates ==
== A brief Markdown Example ==
The basic structure of this plugin was cloned from the [WordPress-Plugin-Boilerplate](https://github.com/tommcfarlin/WordPress-Plugin-Boilerplate) project.
This plugin supports the [GitHub Updater](https://github.com/afragen/github-updater) plugin, so if you install that, this plugin becomes automatically updateable direct from GitHub. Any submission to WP.org repo will make this redundant.
Ordered list:
1. Some feature
1. Another feature
1. Something else about the plugin
Unordered list:
* something
* something else
* third thing
Here's a link to [WordPress](http://wordpress.org/ "Your favorite software") and one to [Markdown's Syntax Documentation][markdown syntax].
Titles are optional, naturally.
[markdown syntax]: http://daringfireball.net/projects/markdown/syntax
"Markdown is what the parser uses to process much of the readme file"
Markdown uses email style notation for blockquotes and I've been told:
> Asterisks for *emphasis*. Double it up for **strong**.
`<?php code(); // goes in backticks ?>`

View file

@ -1 +0,0 @@
/* This stylesheet is used to style the admin option form of the plugin. */

View file

@ -1,10 +0,0 @@
(function ( $ ) {
"use strict";
$(function () {
// Place your administration-specific JavaScript here
});
}(jQuery));

View file

@ -1,250 +1,103 @@
<?php
/**
* Plugin Name.
* The admin-specific functionality of the plugin.
*
* @package Plugin_Name_Admin
* @author Your Name <email@example.com>
* @license GPL-2.0+
* @link http://example.com
* @copyright 2014 Your Name or Company Name
* @link http://example.com
* @since 1.0.0
*
* @package Plugin_Name
* @subpackage Plugin_Name/admin
*/
/**
* Plugin class. This class should ideally be used to work with the
* administrative side of the WordPress site.
* The admin-specific functionality of the plugin.
*
* If you're interested in introducing public-facing
* functionality, then refer to `class-plugin-name.php`
* Defines the plugin name, version, and two examples hooks for how to
* enqueue the admin-specific stylesheet and JavaScript.
*
* @TODO: Rename this class to a proper name for your plugin.
*
* @package Plugin_Name_Admin
* @author Your Name <email@example.com>
* @package Plugin_Name
* @subpackage Plugin_Name/admin
* @author Your Name <email@example.com>
*/
class Plugin_Name_Admin {
/**
* Instance of this class.
* The ID of this plugin.
*
* @since 1.0.0
*
* @var object
* @access private
* @var string $plugin_name The ID of this plugin.
*/
protected static $instance = null;
private $plugin_name;
/**
* Slug of the plugin screen.
* The version of this plugin.
*
* @since 1.0.0
*
* @var string
* @access private
* @var string $version The current version of this plugin.
*/
protected $plugin_screen_hook_suffix = null;
private $version;
/**
* Initialize the plugin by loading admin scripts & styles and adding a
* settings page and menu.
* Initialize the class and set its properties.
*
* @since 1.0.0
* @since 1.0.0
* @param string $plugin_name The name of this plugin.
* @param string $version The version of this plugin.
*/
private function __construct() {
public function __construct( $plugin_name, $version ) {
/*
* @TODO :
$this->plugin_name = $plugin_name;
$this->version = $version;
}
/**
* Register the stylesheets for the admin area.
*
* @since 1.0.0
*/
public function enqueue_styles() {
/**
* This function is provided for demonstration purposes only.
*
* - Uncomment following lines if the admin class should only be available for super admins
* An instance of this class should be passed to the run() function
* defined in Plugin_Name_Loader as all of the hooks are defined
* in that particular class.
*
* The Plugin_Name_Loader will then create the relationship
* between the defined hooks and the functions defined in this
* class.
*/
/* if( ! is_super_admin() ) {
return;
} */
/*
* Call $plugin_slug from public plugin class.
wp_enqueue_style( $this->plugin_name, plugin_dir_url( __FILE__ ) . 'css/plugin-name-admin.css', array(), $this->version, 'all' );
}
/**
* Register the JavaScript for the admin area.
*
* @since 1.0.0
*/
public function enqueue_scripts() {
/**
* This function is provided for demonstration purposes only.
*
* @TODO:
*
* - Rename "Plugin_Name" to the name of your initial plugin class
* An instance of this class should be passed to the run() function
* defined in Plugin_Name_Loader as all of the hooks are defined
* in that particular class.
*
* The Plugin_Name_Loader will then create the relationship
* between the defined hooks and the functions defined in this
* class.
*/
$plugin = Plugin_Name::get_instance();
$this->plugin_slug = $plugin->get_plugin_slug();
// Load admin style sheet and JavaScript.
add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_admin_styles' ) );
add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_admin_scripts' ) );
wp_enqueue_script( $this->plugin_name, plugin_dir_url( __FILE__ ) . 'js/plugin-name-admin.js', array( 'jquery' ), $this->version, false );
// Add the options page and menu item.
add_action( 'admin_menu', array( $this, 'add_plugin_admin_menu' ) );
// Add an action link pointing to the options page.
$plugin_basename = plugin_basename( plugin_dir_path( realpath( dirname( __FILE__ ) ) ) . $this->plugin_slug . '.php' );
add_filter( 'plugin_action_links_' . $plugin_basename, array( $this, 'add_action_links' ) );
/*
* Define custom functionality.
*
* Read more about actions and filters:
* http://codex.wordpress.org/Plugin_API#Hooks.2C_Actions_and_Filters
*/
add_action( '@TODO', array( $this, 'action_method_name' ) );
add_filter( '@TODO', array( $this, 'filter_method_name' ) );
}
/**
* Return an instance of this class.
*
* @since 1.0.0
*
* @return object A single instance of this class.
*/
public static function get_instance() {
/*
* @TODO :
*
* - Uncomment following lines if the admin class should only be available for super admins
*/
/* if( ! is_super_admin() ) {
return;
} */
// If the single instance hasn't been set, set it now.
if ( null == self::$instance ) {
self::$instance = new self;
}
return self::$instance;
}
/**
* Register and enqueue admin-specific style sheet.
*
* @TODO:
*
* - Rename "Plugin_Name" to the name your plugin
*
* @since 1.0.0
*
* @return null Return early if no settings page is registered.
*/
public function enqueue_admin_styles() {
if ( ! isset( $this->plugin_screen_hook_suffix ) ) {
return;
}
$screen = get_current_screen();
if ( $this->plugin_screen_hook_suffix == $screen->id ) {
wp_enqueue_style( $this->plugin_slug .'-admin-styles', plugins_url( 'assets/css/admin.css', __FILE__ ), array(), Plugin_Name::VERSION );
}
}
/**
* Register and enqueue admin-specific JavaScript.
*
* @TODO:
*
* - Rename "Plugin_Name" to the name your plugin
*
* @since 1.0.0
*
* @return null Return early if no settings page is registered.
*/
public function enqueue_admin_scripts() {
if ( ! isset( $this->plugin_screen_hook_suffix ) ) {
return;
}
$screen = get_current_screen();
if ( $this->plugin_screen_hook_suffix == $screen->id ) {
wp_enqueue_script( $this->plugin_slug . '-admin-script', plugins_url( 'assets/js/admin.js', __FILE__ ), array( 'jquery' ), Plugin_Name::VERSION );
}
}
/**
* Register the administration menu for this plugin into the WordPress Dashboard menu.
*
* @since 1.0.0
*/
public function add_plugin_admin_menu() {
/*
* Add a settings page for this plugin to the Settings menu.
*
* NOTE: Alternative menu locations are available via WordPress administration menu functions.
*
* Administration Menus: http://codex.wordpress.org/Administration_Menus
*
* @TODO:
*
* - Change 'Page Title' to the title of your plugin admin page
* - Change 'Menu Text' to the text for menu item for the plugin settings page
* - Change 'manage_options' to the capability you see fit
* For reference: http://codex.wordpress.org/Roles_and_Capabilities
*/
$this->plugin_screen_hook_suffix = add_options_page(
__( 'Page Title', $this->plugin_slug ),
__( 'Menu Text', $this->plugin_slug ),
'manage_options',
$this->plugin_slug,
array( $this, 'display_plugin_admin_page' )
);
}
/**
* Render the settings page for this plugin.
*
* @since 1.0.0
*/
public function display_plugin_admin_page() {
include_once( 'views/admin.php' );
}
/**
* Add settings action link to the plugins page.
*
* @since 1.0.0
*/
public function add_action_links( $links ) {
return array_merge(
array(
'settings' => '<a href="' . admin_url( 'options-general.php?page=' . $this->plugin_slug ) . '">' . __( 'Settings', $this->plugin_slug ) . '</a>'
),
$links
);
}
/**
* NOTE: Actions are points in the execution of a page or process
* lifecycle that WordPress fires.
*
* Actions: http://codex.wordpress.org/Plugin_API#Actions
* Reference: http://codex.wordpress.org/Plugin_API/Action_Reference
*
* @since 1.0.0
*/
public function action_method_name() {
// @TODO: Define your action hook callback here
}
/**
* NOTE: Filters are points of execution in which WordPress modifies data
* before saving it or sending it to the browser.
*
* Filters: http://codex.wordpress.org/Plugin_API#Filters
* Reference: http://codex.wordpress.org/Plugin_API/Filter_Reference
*
* @since 1.0.0
*/
public function filter_method_name() {
// @TODO: Define your filter hook callback here
}
}

View file

@ -0,0 +1,4 @@
/**
* All of the CSS for your admin-specific functionality should be
* included in this file.
*/

View file

@ -1 +0,0 @@
<?php // Silence is golden

View file

@ -0,0 +1,32 @@
(function( $ ) {
'use strict';
/**
* All of the code for your admin-facing JavaScript source
* should reside in this file.
*
* Note: It has been assumed you will write jQuery code here, so the
* $ function reference has been prepared for usage within the scope
* of this function.
*
* This enables you to define handlers, for when the DOM is ready:
*
* $(function() {
*
* });
*
* When the window is loaded:
*
* $( window ).load(function() {
*
* });
*
* ...and/or other possibilities.
*
* Ideally, it is not considered best practise to attach more than a
* single DOM-ready or window-load handler for a particular page.
* Although scripts in the WordPress core, Plugins and Themes may be
* practising this, we should strive to set a better example in our own work.
*/
})( jQuery );

View file

@ -0,0 +1,16 @@
<?php
/**
* Provide a admin area view for the plugin
*
* This file is used to markup the admin-facing aspects of the plugin.
*
* @link http://example.com
* @since 1.0.0
*
* @package Plugin_Name
* @subpackage Plugin_Name/admin/partials
*/
?>
<!-- This file should primarily consist of HTML with a little bit of PHP. -->

View file

@ -1,22 +0,0 @@
<?php
/**
* Represents the view for the administration dashboard.
*
* This includes the header, options, and other information that should provide
* The User Interface to the end user.
*
* @package Plugin_Name
* @author Your Name <email@example.com>
* @license GPL-2.0+
* @link http://example.com
* @copyright 2014 Your Name or Company Name
*/
?>
<div class="wrap">
<h2><?php echo esc_html( get_admin_page_title() ); ?></h2>
<!-- @TODO: Provide markup for your options page here. -->
</div>

View file

@ -1 +0,0 @@
<?php // Silence is golden

Binary file not shown.

Before

Width:  |  Height:  |  Size: 23 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 12 KiB

View file

@ -1 +0,0 @@
<?php // Silence is golden

Binary file not shown.

Before

Width:  |  Height:  |  Size: 450 KiB

View file

@ -0,0 +1,36 @@
<?php
/**
* Fired during plugin activation
*
* @link http://example.com
* @since 1.0.0
*
* @package Plugin_Name
* @subpackage Plugin_Name/includes
*/
/**
* Fired during plugin activation.
*
* This class defines all code necessary to run during the plugin's activation.
*
* @since 1.0.0
* @package Plugin_Name
* @subpackage Plugin_Name/includes
* @author Your Name <email@example.com>
*/
class Plugin_Name_Activator {
/**
* Short Description. (use period)
*
* Long Description.
*
* @since 1.0.0
*/
public static function activate() {
}
}

View file

@ -0,0 +1,36 @@
<?php
/**
* Fired during plugin deactivation
*
* @link http://example.com
* @since 1.0.0
*
* @package Plugin_Name
* @subpackage Plugin_Name/includes
*/
/**
* Fired during plugin deactivation.
*
* This class defines all code necessary to run during the plugin's deactivation.
*
* @since 1.0.0
* @package Plugin_Name
* @subpackage Plugin_Name/includes
* @author Your Name <email@example.com>
*/
class Plugin_Name_Deactivator {
/**
* Short Description. (use period)
*
* Long Description.
*
* @since 1.0.0
*/
public static function deactivate() {
}
}

View file

@ -0,0 +1,47 @@
<?php
/**
* Define the internationalization functionality
*
* Loads and defines the internationalization files for this plugin
* so that it is ready for translation.
*
* @link http://example.com
* @since 1.0.0
*
* @package Plugin_Name
* @subpackage Plugin_Name/includes
*/
/**
* Define the internationalization functionality.
*
* Loads and defines the internationalization files for this plugin
* so that it is ready for translation.
*
* @since 1.0.0
* @package Plugin_Name
* @subpackage Plugin_Name/includes
* @author Your Name <email@example.com>
*/
class Plugin_Name_i18n {
/**
* Load the plugin text domain for translation.
*
* @since 1.0.0
*/
public function load_plugin_textdomain() {
load_plugin_textdomain(
'plugin-name',
false,
dirname( dirname( plugin_basename( __FILE__ ) ) ) . '/languages/'
);
}
}

View file

@ -0,0 +1,155 @@
<?php
/**
* Register all actions and filters for the plugin
*
* @link http://example.com
* @since 1.0.0
*
* @package Plugin_Name
* @subpackage Plugin_Name/includes
*/
/**
* Register all actions and filters for the plugin.
*
* Maintain a list of all hooks that are registered throughout
* the plugin, and register them with the WordPress API. Call the
* run function to execute the list of actions and filters.
*
* @package Plugin_Name
* @subpackage Plugin_Name/includes
* @author Your Name <email@example.com>
*/
class Plugin_Name_Loader {
/**
* The array of actions registered with WordPress.
*
* @since 1.0.0
* @access protected
* @var array $actions The actions registered with WordPress to fire when the plugin loads.
*/
protected $actions;
/**
* The array of filters registered with WordPress.
*
* @since 1.0.0
* @access protected
* @var array $filters The filters registered with WordPress to fire when the plugin loads.
*/
protected $filters;
/**
* The array of shortcode registered with WordPress.
*
* @since 1.0.0
* @access protected
* @var array $shortcodes The shortcode registered with WordPress to fire when the plugin loads.
*/
protected $shortcodes;
/**
* Initialize the collections used to maintain the actions and filters.
*
* @since 1.0.0
*/
public function __construct() {
$this->actions = array();
$this->filters = array();
$this->shortcodes = array();
}
/**
* Add a new action to the collection to be registered with WordPress.
*
* @since 1.0.0
* @param string $hook The name of the WordPress action that is being registered.
* @param object $component A reference to the instance of the object on which the action is defined.
* @param string $callback The name of the function definition on the $component.
* @param int $priority Optional. The priority at which the function should be fired. Default is 10.
* @param int $accepted_args Optional. The number of arguments that should be passed to the $callback. Default is 1.
*/
public function add_action( $hook, $component, $callback, $priority = 10, $accepted_args = 1 ) {
$this->actions = $this->add( $this->actions, $hook, $component, $callback, $priority, $accepted_args );
}
/**
* Add a new filter to the collection to be registered with WordPress.
*
* @since 1.0.0
* @param string $hook The name of the WordPress filter that is being registered.
* @param object $component A reference to the instance of the object on which the filter is defined.
* @param string $callback The name of the function definition on the $component.
* @param int $priority Optional. The priority at which the function should be fired. Default is 10.
* @param int $accepted_args Optional. The number of arguments that should be passed to the $callback. Default is 1
*/
public function add_filter( $hook, $component, $callback, $priority = 10, $accepted_args = 1 ) {
$this->filters = $this->add( $this->filters, $hook, $component, $callback, $priority, $accepted_args );
}
/**
* Add a new shortcode to the collection to be registered with WordPress
*
* @since 1.0.0
* @param string $tag The name of the new shortcode.
* @param object $component A reference to the instance of the object on which the shortcode is defined.
* @param string $callback The name of the function that defines the shortcode.
*/
public function add_shortcode( $tag, $component, $callback, $priority = 10, $accepted_args = 1 ) {
$this->shortcodes = $this->add( $this->shortcodes, $tag, $component, $callback, $priority, $accepted_args );
}
/**
* A utility function that is used to register the actions and hooks into a single
* collection.
*
* @since 1.0.0
* @access private
* @param array $hooks The collection of hooks that is being registered (that is, actions or filters).
* @param string $hook The name of the WordPress filter that is being registered.
* @param object $component A reference to the instance of the object on which the filter is defined.
* @param string $callback The name of the function definition on the $component.
* @param int $priority The priority at which the function should be fired.
* @param int $accepted_args The number of arguments that should be passed to the $callback.
* @return array The collection of actions and filters registered with WordPress.
*/
private function add( $hooks, $hook, $component, $callback, $priority, $accepted_args ) {
$hooks[] = array(
'hook' => $hook,
'component' => $component,
'callback' => $callback,
'priority' => $priority,
'accepted_args' => $accepted_args
);
return $hooks;
}
/**
* Register the filters and actions with WordPress.
*
* @since 1.0.0
*/
public function run() {
foreach ( $this->filters as $hook ) {
add_filter( $hook['hook'], array( $hook['component'], $hook['callback'] ), $hook['priority'], $hook['accepted_args'] );
}
foreach ( $this->actions as $hook ) {
add_action( $hook['hook'], array( $hook['component'], $hook['callback'] ), $hook['priority'], $hook['accepted_args'] );
}
foreach ( $this->shortcodes as $hook ) {
add_shortcode( $hook['hook'], array( $hook['component'], $hook['callback'] ), $hook['priority'], $hook['accepted_args'] );
}
}
}

View file

@ -0,0 +1,220 @@
<?php
/**
* The file that defines the core plugin class
*
* A class definition that includes attributes and functions used across both the
* public-facing side of the site and the admin area.
*
* @link http://example.com
* @since 1.0.0
*
* @package Plugin_Name
* @subpackage Plugin_Name/includes
*/
/**
* The core plugin class.
*
* This is used to define internationalization, admin-specific hooks, and
* public-facing site hooks.
*
* Also maintains the unique identifier of this plugin as well as the current
* version of the plugin.
*
* @since 1.0.0
* @package Plugin_Name
* @subpackage Plugin_Name/includes
* @author Your Name <email@example.com>
*/
class Plugin_Name {
/**
* The loader that's responsible for maintaining and registering all hooks that power
* the plugin.
*
* @since 1.0.0
* @access protected
* @var Plugin_Name_Loader $loader Maintains and registers all hooks for the plugin.
*/
protected $loader;
/**
* The unique identifier of this plugin.
*
* @since 1.0.0
* @access protected
* @var string $plugin_name The string used to uniquely identify this plugin.
*/
protected $plugin_name;
/**
* The current version of the plugin.
*
* @since 1.0.0
* @access protected
* @var string $version The current version of the plugin.
*/
protected $version;
/**
* Define the core functionality of the plugin.
*
* Set the plugin name and the plugin version that can be used throughout the plugin.
* Load the dependencies, define the locale, and set the hooks for the admin area and
* the public-facing side of the site.
*
* @since 1.0.0
*/
public function __construct() {
if ( defined( 'PLUGIN_NAME_VERSION' ) ) {
$this->version = PLUGIN_NAME_VERSION;
} else {
$this->version = '1.0.0';
}
$this->plugin_name = 'plugin-name';
$this->load_dependencies();
$this->set_locale();
$this->define_admin_hooks();
$this->define_public_hooks();
}
/**
* Load the required dependencies for this plugin.
*
* Include the following files that make up the plugin:
*
* - Plugin_Name_Loader. Orchestrates the hooks of the plugin.
* - Plugin_Name_i18n. Defines internationalization functionality.
* - Plugin_Name_Admin. Defines all hooks for the admin area.
* - Plugin_Name_Public. Defines all hooks for the public side of the site.
*
* Create an instance of the loader which will be used to register the hooks
* with WordPress.
*
* @since 1.0.0
* @access private
*/
private function load_dependencies() {
/**
* The class responsible for orchestrating the actions and filters of the
* core plugin.
*/
require_once plugin_dir_path( dirname( __FILE__ ) ) . 'includes/class-plugin-name-loader.php';
/**
* The class responsible for defining internationalization functionality
* of the plugin.
*/
require_once plugin_dir_path( dirname( __FILE__ ) ) . 'includes/class-plugin-name-i18n.php';
/**
* The class responsible for defining all actions that occur in the admin area.
*/
require_once plugin_dir_path( dirname( __FILE__ ) ) . 'admin/class-plugin-name-admin.php';
/**
* The class responsible for defining all actions that occur in the public-facing
* side of the site.
*/
require_once plugin_dir_path( dirname( __FILE__ ) ) . 'public/class-plugin-name-public.php';
$this->loader = new Plugin_Name_Loader();
}
/**
* Define the locale for this plugin for internationalization.
*
* Uses the Plugin_Name_i18n class in order to set the domain and to register the hook
* with WordPress.
*
* @since 1.0.0
* @access private
*/
private function set_locale() {
$plugin_i18n = new Plugin_Name_i18n();
$this->loader->add_action( 'plugins_loaded', $plugin_i18n, 'load_plugin_textdomain' );
}
/**
* Register all of the hooks related to the admin area functionality
* of the plugin.
*
* @since 1.0.0
* @access private
*/
private function define_admin_hooks() {
$plugin_admin = new Plugin_Name_Admin( $this->get_plugin_name(), $this->get_version() );
$this->loader->add_action( 'admin_enqueue_scripts', $plugin_admin, 'enqueue_styles' );
$this->loader->add_action( 'admin_enqueue_scripts', $plugin_admin, 'enqueue_scripts' );
}
/**
* Register all of the hooks related to the public-facing functionality
* of the plugin.
*
* @since 1.0.0
* @access private
*/
private function define_public_hooks() {
$plugin_public = new Plugin_Name_Public( $this->get_plugin_name(), $this->get_version() );
$this->loader->add_action( 'wp_enqueue_scripts', $plugin_public, 'enqueue_styles' );
$this->loader->add_action( 'wp_enqueue_scripts', $plugin_public, 'enqueue_scripts' );
$this->loader->add_shortcode( 'plugin-name-shortcode', $plugin_public, 'plugin_name_shortcode_func' );
}
/**
* Run the loader to execute all of the hooks with WordPress.
*
* @since 1.0.0
*/
public function run() {
$this->loader->run();
}
/**
* The name of the plugin used to uniquely identify it within the context of
* WordPress and to define internationalization functionality.
*
* @since 1.0.0
* @return string The name of the plugin.
*/
public function get_plugin_name() {
return $this->plugin_name;
}
/**
* The reference to the class that orchestrates the hooks with the plugin.
*
* @since 1.0.0
* @return Plugin_Name_Loader Orchestrates the hooks of the plugin.
*/
public function get_loader() {
return $this->loader;
}
/**
* Retrieve the version number of the plugin.
*
* @since 1.0.0
* @return string The version number of the plugin.
*/
public function get_version() {
return $this->version;
}
}

View file

@ -1 +0,0 @@
<?php // Silence is golden

View file

@ -1,31 +0,0 @@
# Copyright (C) 2013 TODO
# This file is distributed under the same license as the TODO package.
msgid ""
msgstr ""
"Project-Id-Version: TODO 1.0.0\n"
"Report-Msgid-Bugs-To: http://wordpress.org/plugins/plugin-name\n"
"POT-Creation-Date: 2013-05-10 11:23:19+00:00\n"
"PO-Revision-Date: 2013-05-10 10:37-0500\n"
"Last-Translator: FULL NAME <email@example.com>\n"
"Language-Team: LANGUAGE <translations@example.com >\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"X-Generator: Poedit 1.5.7\n"
"X-Poedit-KeywordsList: __;_e;_n;_x;esc_html_e;esc_html__;esc_attr_e;"
"esc_attr__;_ex:1,2c;_nx:4c,1,2;_nx_noop:4c,1,2;_x:1,2c;_n:1,2\n"
"X-Poedit-Basepath: ../\n"
"Plural-Forms: nplurals=2; plural=n != 1;\n"
"X-Poedit-SearchPath-0: .\n"
#: class-plugin-name-admin.php:170
msgid "Page Title"
msgstr ""
#: class-plugin-name-admin.php:171
msgid "Menu Text"
msgstr ""
#: class-plugin-name-admin.php:197
msgid "Settings"
msgstr ""

View file

@ -1,29 +1,28 @@
<?php
/**
* The WordPress Plugin Boilerplate.
* The plugin bootstrap file
*
* A foundation off of which to build well-documented WordPress plugins that
* also follow WordPress Coding Standards and PHP best practices.
* This file is read by WordPress to generate the plugin information in the plugin
* admin area. This file also includes all of the dependencies used by the plugin,
* registers the activation and deactivation functions, and defines a function
* that starts the plugin.
*
* @package Plugin_Name
* @author Your Name <email@example.com>
* @license GPL-2.0+
* @link http://example.com
* @copyright 2014 Your Name or Company Name
* @link http://example.com
* @since 1.0.0
* @package Plugin_Name
*
* @wordpress-plugin
* Plugin Name: @TODO
* Plugin URI: @TODO
* Description: @TODO
* Plugin Name: WordPress Plugin Boilerplate
* Plugin URI: http://example.com/plugin-name-uri/
* Description: This is a short description of what the plugin does. It's displayed in the WordPress admin area.
* Version: 1.0.0
* Author: @TODO
* Author URI: @TODO
* Text Domain: plugin-name-locale
* Author: Your Name or Your Company
* Author URI: http://example.com/
* License: GPL-2.0+
* License URI: http://www.gnu.org/licenses/gpl-2.0.txt
* Text Domain: plugin-name
* Domain Path: /languages
* GitHub Plugin URI: https://github.com/<owner>/<repo>
* WordPress-Plugin-Boilerplate: v2.6.1
*/
// If this file is called directly, abort.
@ -31,61 +30,53 @@ if ( ! defined( 'WPINC' ) ) {
die;
}
/*----------------------------------------------------------------------------*
* Public-Facing Functionality
*----------------------------------------------------------------------------*/
/*
* @TODO:
*
* - replace `class-plugin-name.php` with the name of the plugin's class file
*
/**
* Currently plugin version.
* Start at version 1.0.0 and use SemVer - https://semver.org
* Rename this for your plugin and update it as you release new versions.
*/
require_once( plugin_dir_path( __FILE__ ) . 'public/class-plugin-name.php' );
define( 'PLUGIN_NAME_VERSION', '1.0.0' );
/*
* Register hooks that are fired when the plugin is activated or deactivated.
* When the plugin is deleted, the uninstall.php file is loaded.
*
* @TODO:
*
* - replace Plugin_Name with the name of the class defined in
* `class-plugin-name.php`
/**
* The code that runs during plugin activation.
* This action is documented in includes/class-plugin-name-activator.php
*/
register_activation_hook( __FILE__, array( 'Plugin_Name', 'activate' ) );
register_deactivation_hook( __FILE__, array( 'Plugin_Name', 'deactivate' ) );
function activate_plugin_name() {
require_once plugin_dir_path( __FILE__ ) . 'includes/class-plugin-name-activator.php';
Plugin_Name_Activator::activate();
}
/*
* @TODO:
*
* - replace Plugin_Name with the name of the class defined in
* `class-plugin-name.php`
/**
* The code that runs during plugin deactivation.
* This action is documented in includes/class-plugin-name-deactivator.php
*/
add_action( 'plugins_loaded', array( 'Plugin_Name', 'get_instance' ) );
function deactivate_plugin_name() {
require_once plugin_dir_path( __FILE__ ) . 'includes/class-plugin-name-deactivator.php';
Plugin_Name_Deactivator::deactivate();
}
/*----------------------------------------------------------------------------*
* Dashboard and Administrative Functionality
*----------------------------------------------------------------------------*/
register_activation_hook( __FILE__, 'activate_plugin_name' );
register_deactivation_hook( __FILE__, 'deactivate_plugin_name' );
/*
* @TODO:
*
* - replace `class-plugin-name-admin.php` with the name of the plugin's admin file
* - replace Plugin_Name_Admin with the name of the class defined in
* `class-plugin-name-admin.php`
*
* If you want to include Ajax within the dashboard, change the following
* conditional to:
*
* if ( is_admin() ) {
* ...
* }
*
* The code below is intended to to give the lightest footprint possible.
/**
* The core plugin class that is used to define internationalization,
* admin-specific hooks, and public-facing site hooks.
*/
if ( is_admin() && ( ! defined( 'DOING_AJAX' ) || ! DOING_AJAX ) ) {
require plugin_dir_path( __FILE__ ) . 'includes/class-plugin-name.php';
require_once( plugin_dir_path( __FILE__ ) . 'admin/class-plugin-name-admin.php' );
add_action( 'plugins_loaded', array( 'Plugin_Name_Admin', 'get_instance' ) );
/**
* Begins execution of the plugin.
*
* Since everything within the plugin is registered via hooks,
* then kicking off the plugin from this point in the file does
* not affect the page life cycle.
*
* @since 1.0.0
*/
function run_plugin_name() {
$plugin = new Plugin_Name();
$plugin->run();
}
run_plugin_name();

View file

@ -1 +0,0 @@
<?php // Silence is golden

View file

@ -1 +0,0 @@
/* This stylesheet is used to style the public-facing components of the plugin. */

View file

@ -1 +0,0 @@
<?php // Silence is golden

View file

@ -1 +0,0 @@
<?php // Silence is golden

View file

@ -1,10 +0,0 @@
(function ( $ ) {
"use strict";
$(function () {
// Place your public-facing JavaScript here
});
}(jQuery));

View file

@ -0,0 +1,117 @@
<?php
/**
* The public-facing functionality of the plugin.
*
* @link http://example.com
* @since 1.0.0
*
* @package Plugin_Name
* @subpackage Plugin_Name/public
*/
/**
* The public-facing functionality of the plugin.
*
* Defines the plugin name, version, and two examples hooks for how to
* enqueue the public-facing stylesheet and JavaScript.
*
* @package Plugin_Name
* @subpackage Plugin_Name/public
* @author Your Name <email@example.com>
*/
class Plugin_Name_Public {
/**
* The ID of this plugin.
*
* @since 1.0.0
* @access private
* @var string $plugin_name The ID of this plugin.
*/
private $plugin_name;
/**
* The version of this plugin.
*
* @since 1.0.0
* @access private
* @var string $version The current version of this plugin.
*/
private $version;
/**
* Initialize the class and set its properties.
*
* @since 1.0.0
* @param string $plugin_name The name of the plugin.
* @param string $version The version of this plugin.
*/
public function __construct( $plugin_name, $version ) {
$this->plugin_name = $plugin_name;
$this->version = $version;
}
/**
* Register the stylesheets for the public-facing side of the site.
*
* @since 1.0.0
*/
public function enqueue_styles() {
/**
* This function is provided for demonstration purposes only.
*
* An instance of this class should be passed to the run() function
* defined in Plugin_Name_Loader as all of the hooks are defined
* in that particular class.
*
* The Plugin_Name_Loader will then create the relationship
* between the defined hooks and the functions defined in this
* class.
*/
wp_enqueue_style( $this->plugin_name, plugin_dir_url( __FILE__ ) . 'css/plugin-name-public.css', array(), $this->version, 'all' );
}
/**
* Register the JavaScript for the public-facing side of the site.
*
* @since 1.0.0
*/
public function enqueue_scripts() {
/**
* This function is provided for demonstration purposes only.
*
* An instance of this class should be passed to the run() function
* defined in Plugin_Name_Loader as all of the hooks are defined
* in that particular class.
*
* The Plugin_Name_Loader will then create the relationship
* between the defined hooks and the functions defined in this
* class.
*/
wp_enqueue_script( $this->plugin_name, plugin_dir_url( __FILE__ ) . 'js/plugin-name-public.js', array( 'jquery' ), $this->version, false );
}
/**
* Shortcode processing function.
* Shortcode can take arguments like [plugin-name-shortcode argm='123']
*/
public function plugin_name_shortcode_func($atts) {
$a = shortcode_atts( array(
'argm' => '0',
), $atts
);
return (
$a['argm']
);
}
}

View file

@ -1,308 +0,0 @@
<?php
/**
* Plugin Name.
*
* @package Plugin_Name
* @author Your Name <email@example.com>
* @license GPL-2.0+
* @link http://example.com
* @copyright 2014 Your Name or Company Name
*/
/**
* Plugin class. This class should ideally be used to work with the
* public-facing side of the WordPress site.
*
* If you're interested in introducing administrative or dashboard
* functionality, then refer to `class-plugin-name-admin.php`
*
* @TODO: Rename this class to a proper name for your plugin.
*
* @package Plugin_Name
* @author Your Name <email@example.com>
*/
class Plugin_Name {
/**
* Plugin version, used for cache-busting of style and script file references.
*
* @since 1.0.0
*
* @var string
*/
const VERSION = '1.0.0';
/**
* @TODO - Rename "plugin-name" to the name of your plugin
*
* Unique identifier for your plugin.
*
*
* The variable name is used as the text domain when internationalizing strings
* of text. Its value should match the Text Domain file header in the main
* plugin file.
*
* @since 1.0.0
*
* @var string
*/
protected $plugin_slug = 'plugin-name';
/**
* Instance of this class.
*
* @since 1.0.0
*
* @var object
*/
protected static $instance = null;
/**
* Initialize the plugin by setting localization and loading public scripts
* and styles.
*
* @since 1.0.0
*/
private function __construct() {
// Load plugin text domain
add_action( 'init', array( $this, 'load_plugin_textdomain' ) );
// Activate plugin when new blog is added
add_action( 'wpmu_new_blog', array( $this, 'activate_new_site' ) );
// Load public-facing style sheet and JavaScript.
add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_styles' ) );
add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_scripts' ) );
/* Define custom functionality.
* Refer To http://codex.wordpress.org/Plugin_API#Hooks.2C_Actions_and_Filters
*/
add_action( '@TODO', array( $this, 'action_method_name' ) );
add_filter( '@TODO', array( $this, 'filter_method_name' ) );
}
/**
* Return the plugin slug.
*
* @since 1.0.0
*
* @return Plugin slug variable.
*/
public function get_plugin_slug() {
return $this->plugin_slug;
}
/**
* Return an instance of this class.
*
* @since 1.0.0
*
* @return object A single instance of this class.
*/
public static function get_instance() {
// If the single instance hasn't been set, set it now.
if ( null == self::$instance ) {
self::$instance = new self;
}
return self::$instance;
}
/**
* Fired when the plugin is activated.
*
* @since 1.0.0
*
* @param boolean $network_wide True if WPMU superadmin uses
* "Network Activate" action, false if
* WPMU is disabled or plugin is
* activated on an individual blog.
*/
public static function activate( $network_wide ) {
if ( function_exists( 'is_multisite' ) && is_multisite() ) {
if ( $network_wide ) {
// Get all blog ids
$blog_ids = self::get_blog_ids();
foreach ( $blog_ids as $blog_id ) {
switch_to_blog( $blog_id );
self::single_activate();
}
restore_current_blog();
} else {
self::single_activate();
}
} else {
self::single_activate();
}
}
/**
* Fired when the plugin is deactivated.
*
* @since 1.0.0
*
* @param boolean $network_wide True if WPMU superadmin uses
* "Network Deactivate" action, false if
* WPMU is disabled or plugin is
* deactivated on an individual blog.
*/
public static function deactivate( $network_wide ) {
if ( function_exists( 'is_multisite' ) && is_multisite() ) {
if ( $network_wide ) {
// Get all blog ids
$blog_ids = self::get_blog_ids();
foreach ( $blog_ids as $blog_id ) {
switch_to_blog( $blog_id );
self::single_deactivate();
}
restore_current_blog();
} else {
self::single_deactivate();
}
} else {
self::single_deactivate();
}
}
/**
* Fired when a new site is activated with a WPMU environment.
*
* @since 1.0.0
*
* @param int $blog_id ID of the new blog.
*/
public function activate_new_site( $blog_id ) {
if ( 1 !== did_action( 'wpmu_new_blog' ) ) {
return;
}
switch_to_blog( $blog_id );
self::single_activate();
restore_current_blog();
}
/**
* Get all blog ids of blogs in the current network that are:
* - not archived
* - not spam
* - not deleted
*
* @since 1.0.0
*
* @return array|false The blog ids, false if no matches.
*/
private static function get_blog_ids() {
global $wpdb;
// get an array of blog ids
$sql = "SELECT blog_id FROM $wpdb->blogs
WHERE archived = '0' AND spam = '0'
AND deleted = '0'";
return $wpdb->get_col( $sql );
}
/**
* Fired for each blog when the plugin is activated.
*
* @since 1.0.0
*/
private static function single_activate() {
// @TODO: Define activation functionality here
}
/**
* Fired for each blog when the plugin is deactivated.
*
* @since 1.0.0
*/
private static function single_deactivate() {
// @TODO: Define deactivation functionality here
}
/**
* Load the plugin text domain for translation.
*
* @since 1.0.0
*/
public function load_plugin_textdomain() {
$domain = $this->plugin_slug;
$locale = apply_filters( 'plugin_locale', get_locale(), $domain );
load_textdomain( $domain, trailingslashit( WP_LANG_DIR ) . $domain . '/' . $domain . '-' . $locale . '.mo' );
load_plugin_textdomain( $domain, FALSE, basename( plugin_dir_path( dirname( __FILE__ ) ) ) . '/languages/' );
}
/**
* Register and enqueue public-facing style sheet.
*
* @since 1.0.0
*/
public function enqueue_styles() {
wp_enqueue_style( $this->plugin_slug . '-plugin-styles', plugins_url( 'assets/css/public.css', __FILE__ ), array(), self::VERSION );
}
/**
* Register and enqueues public-facing JavaScript files.
*
* @since 1.0.0
*/
public function enqueue_scripts() {
wp_enqueue_script( $this->plugin_slug . '-plugin-script', plugins_url( 'assets/js/public.js', __FILE__ ), array( 'jquery' ), self::VERSION );
}
/**
* NOTE: Actions are points in the execution of a page or process
* lifecycle that WordPress fires.
*
* Actions: http://codex.wordpress.org/Plugin_API#Actions
* Reference: http://codex.wordpress.org/Plugin_API/Action_Reference
*
* @since 1.0.0
*/
public function action_method_name() {
// @TODO: Define your action hook callback here
}
/**
* NOTE: Filters are points of execution in which WordPress modifies data
* before saving it or sending it to the browser.
*
* Filters: http://codex.wordpress.org/Plugin_API#Filters
* Reference: http://codex.wordpress.org/Plugin_API/Filter_Reference
*
* @since 1.0.0
*/
public function filter_method_name() {
// @TODO: Define your filter hook callback here
}
}

View file

@ -0,0 +1,4 @@
/**
* All of the CSS for your public-facing functionality should be
* included in this file.
*/

View file

@ -1 +0,0 @@
<?php // Silence is golden

View file

@ -0,0 +1,32 @@
(function( $ ) {
'use strict';
/**
* All of the code for your public-facing JavaScript source
* should reside in this file.
*
* Note: It has been assumed you will write jQuery code here, so the
* $ function reference has been prepared for usage within the scope
* of this function.
*
* This enables you to define handlers, for when the DOM is ready:
*
* $(function() {
*
* });
*
* When the window is loaded:
*
* $( window ).load(function() {
*
* });
*
* ...and/or other possibilities.
*
* Ideally, it is not considered best practise to attach more than a
* single DOM-ready or window-load handler for a particular page.
* Although scripts in the WordPress core, Plugins and Themes may be
* practising this, we should strive to set a better example in our own work.
*/
})( jQuery );

View file

@ -0,0 +1,16 @@
<?php
/**
* Provide a public-facing view for the plugin
*
* This file is used to markup the public-facing aspects of the plugin.
*
* @link http://example.com
* @since 1.0.0
*
* @package Plugin_Name
* @subpackage Plugin_Name/public/partials
*/
?>
<!-- This file should primarily consist of HTML with a little bit of PHP. -->

View file

@ -1 +0,0 @@
<?php // Silence is golden

View file

@ -1,16 +0,0 @@
<?php
/**
* Represents the view for the public-facing component of the plugin.
*
* This typically includes any information, if any, that is rendered to the
* frontend of the theme when the plugin is activated.
*
* @package Plugin_Name
* @author Your Name <email@example.com>
* @license GPL-2.0+
* @link http://example.com
* @copyright 2014 Your Name or Company Name
*/
?>
<!-- This file is used to markup the public facing aspect of the plugin. -->

View file

@ -1,76 +1,31 @@
<?php
/**
* Fired when the plugin is uninstalled.
*
* @package Plugin_Name
* @author Your Name <email@example.com>
* @license GPL-2.0+
* @link http://example.com
* @copyright 2014 Your Name or Company Name
* When populating this file, consider the following flow
* of control:
*
* - This method should be static
* - Check if the $_REQUEST content actually is the plugin name
* - Run an admin referrer check to make sure it goes through authentication
* - Verify the output of $_GET makes sense
* - Repeat with other user roles. Best directly by using the links/query string parameters.
* - Repeat things for multisite. Once for a single site in the network, once sitewide.
*
* This file may be updated more in future version of the Boilerplate; however, this is the
* general skeleton and outline for how the file should work.
*
* For more information, see the following discussion:
* https://github.com/tommcfarlin/WordPress-Plugin-Boilerplate/pull/123#issuecomment-28541913
*
* @link http://example.com
* @since 1.0.0
*
* @package Plugin_Name
*/
// If uninstall not called from WordPress, then exit
// If uninstall not called from WordPress, then exit.
if ( ! defined( 'WP_UNINSTALL_PLUGIN' ) ) {
exit;
}
global $wpdb;
if ( is_multisite() ) {
$blogs = $wpdb->get_results( "SELECT blog_id FROM {$wpdb->blogs}", ARRAY_A );
/* @TODO: delete all transient, options and files you may have added
delete_transient( 'TRANSIENT_NAME' );
delete_option('OPTION_NAME');
//info: remove custom file directory for main site
$upload_dir = wp_upload_dir();
$directory = $upload_dir['basedir'] . DIRECTORY_SEPARATOR . "CUSTOM_DIRECTORY_NAME" . DIRECTORY_SEPARATOR;
if (is_dir($directory)) {
foreach(glob($directory.'*.*') as $v){
unlink($v);
}
rmdir($directory);
}
*/
if ( $blogs ) {
foreach ( $blogs as $blog ) {
switch_to_blog( $blog['blog_id'] );
/* @TODO: delete all transient, options and files you may have added
delete_transient( 'TRANSIENT_NAME' );
delete_option('OPTION_NAME');
//info: remove custom file directory for main site
$upload_dir = wp_upload_dir();
$directory = $upload_dir['basedir'] . DIRECTORY_SEPARATOR . "CUSTOM_DIRECTORY_NAME" . DIRECTORY_SEPARATOR;
if (is_dir($directory)) {
foreach(glob($directory.'*.*') as $v){
unlink($v);
}
rmdir($directory);
}
//info: remove and optimize tables
$GLOBALS['wpdb']->query("DROP TABLE `".$GLOBALS['wpdb']->prefix."TABLE_NAME`");
$GLOBALS['wpdb']->query("OPTIMIZE TABLE `" .$GLOBALS['wpdb']->prefix."options`");
*/
restore_current_blog();
}
}
} else {
/* @TODO: delete all transient, options and files you may have added
delete_transient( 'TRANSIENT_NAME' );
delete_option('OPTION_NAME');
//info: remove custom file directory for main site
$upload_dir = wp_upload_dir();
$directory = $upload_dir['basedir'] . DIRECTORY_SEPARATOR . "CUSTOM_DIRECTORY_NAME" . DIRECTORY_SEPARATOR;
if (is_dir($directory)) {
foreach(glob($directory.'*.*') as $v){
unlink($v);
}
rmdir($directory);
}
//info: remove and optimize tables
$GLOBALS['wpdb']->query("DROP TABLE `".$GLOBALS['wpdb']->prefix."TABLE_NAME`");
$GLOBALS['wpdb']->query("OPTIMIZE TABLE `" .$GLOBALS['wpdb']->prefix."options`");
*/
}