[ { "path": ".gitignore", "content": "# Numerous always-ignore extensions\n*.diff\n*.err\n*.orig\n*.log\n*.rej\n*.swo\n*.swp\n*.vi\n*~\n*.sass-cache\n\n# OS or Editor folders\n.DS_Store\nThumbs.db\n.cache\n.project\n.settings\n.tmproj\n*.esproj\nnbproject\n*.sublime-project\n*.sublime-workspace\n\n# Dreamweaver added files\n_notes\ndwsync.xml\n\n# Komodo\n*.komodoproject\n.komodotools\n\n# Folders to ignore\n.hg\n.svn\n.CVS\nintermediate\n.idea\ncache\n" }, { "path": "CHANGELOG.md", "content": "# Changelog\n* (3 July 2015). Flattened the folder structure so there is no .org repo parent folder.\n* (4 September 2014). Updating the `README` with Windows symbolic link instructions.\n* (3 September 2014). Updating the `README` to describe how to install the Boilerplate.\n* (1 September 2014). Initial Release.\n" }, { "path": "README.md", "content": "# WordPress Plugin Boilerplate\n\nA standardized, organized, object-oriented foundation for building high-quality WordPress Plugins.\n\n## Contents\n\nThe WordPress Plugin Boilerplate includes the following files:\n\n* `.gitignore`. Used to exclude certain files from the repository.\n* `CHANGELOG.md`. The list of changes to the core project.\n* `README.md`. The file that you’re currently reading.\n* A `plugin-name` directory that contains the source code - a fully executable WordPress plugin.\n\n## Features\n\n* 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/).\n* All classes, functions, and variables are documented so that you know what you need to change.\n* 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.\n* The project includes a `.pot` file as a starting point for internationalization.\n\n## Installation\n\nThe 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:\n\n* rename files from `plugin-name` to `example-me`\n* change `plugin_name` to `example_me`\n* change `plugin-name` to `example-me`\n* change `Plugin_Name` to `Example_Me`\n* change `PLUGIN_NAME_` to `EXAMPLE_ME_`\n\nIt'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.\n\n## WordPress.org Preparation\n\nThe 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\n\n## Recommended Tools\n\n### i18n Tools\n\nThe 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:\n\n* [Poedit](http://www.poedit.net/)\n* [makepot](http://i18n.svn.wordpress.org/tools/trunk/)\n* [i18n](https://github.com/grappler/i18n)\n\nAny of the above tools should provide you with the proper tooling to internationalize the plugin.\n\n## License\n\nThe WordPress Plugin Boilerplate is licensed under the GPL v2 or later.\n\n> 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.\n\n> 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.\n\n> 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\n\nA copy of the license is included in the root of the plugin’s directory. The file is named `LICENSE`.\n\n## Important Notes\n\n### Licensing\n\nThe WordPress Plugin Boilerplate is licensed under the GPL v2 or later; however, if you opt to use third-party code that is not compatible with v2, then you may need to switch to using code that is GPL v3 compatible.\n\nFor reference, [here's a discussion](http://make.wordpress.org/themes/2013/03/04/licensing-note-apache-and-gpl/) that covers the Apache 2.0 License used by [Bootstrap](http://twitter.github.io/bootstrap/).\n\n### Includes\n\nNote that if you include your own classes, or third-party libraries, there are three locations in which said files may go:\n\n* `plugin-name/includes` is where functionality shared between the admin area and the public-facing parts of the site reside\n* `plugin-name/admin` is for all admin-specific functionality\n* `plugin-name/public` is for all public-facing functionality\n\nNote 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.\n\nThe example code provided shows how to register your hooks with the Loader class.\n\n### What About Other Features?\n\nThe 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).\n\nThese tools are not part of the core of this Boilerplate, as I see them as being additions, forks, or other contributions to the Boilerplate.\n\nThe 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.\n\n# Credits\n\nThe 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.\n\nThe 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).\n\nThe 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).\n\n## Documentation, FAQs, and More\n\nIf you’re interested in writing any documentation or creating tutorials please [let me know](http://devinvinson.com/contact/) .\n" }, { "path": "plugin-name/LICENSE.txt", "content": " GNU GENERAL PUBLIC LICENSE\n Version 2, June 1991\n\n Copyright (C) 1989, 1991 Free Software Foundation, Inc.,\n 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA\n Everyone is permitted to copy and distribute verbatim copies\n of this license document, but changing it is not allowed.\n\n Preamble\n\n The licenses for most software are designed to take away your\nfreedom to share and change it. By contrast, the GNU General Public\nLicense is intended to guarantee your freedom to share and change free\nsoftware--to make sure the software is free for all its users. This\nGeneral Public License applies to most of the Free Software\nFoundation's software and to any other program whose authors commit to\nusing it. (Some other Free Software Foundation software is covered by\nthe GNU Lesser General Public License instead.) You can apply it to\nyour programs, too.\n\n When we speak of free software, we are referring to freedom, not\nprice. Our General Public Licenses are designed to make sure that you\nhave the freedom to distribute copies of free software (and charge for\nthis service if you wish), that you receive source code or can get it\nif you want it, that you can change the software or use pieces of it\nin new free programs; and that you know you can do these things.\n\n To protect your rights, we need to make restrictions that forbid\nanyone to deny you these rights or to ask you to surrender the rights.\nThese restrictions translate to certain responsibilities for you if you\ndistribute copies of the software, or if you modify it.\n\n For example, if you distribute copies of such a program, whether\ngratis or for a fee, you must give the recipients all the rights that\nyou have. You must make sure that they, too, receive or can get the\nsource code. And you must show them these terms so they know their\nrights.\n\n We protect your rights with two steps: (1) copyright the software, and\n(2) offer you this license which gives you legal permission to copy,\ndistribute and/or modify the software.\n\n Also, for each author's protection and ours, we want to make certain\nthat everyone understands that there is no warranty for this free\nsoftware. If the software is modified by someone else and passed on, we\nwant its recipients to know that what they have is not the original, so\nthat any problems introduced by others will not reflect on the original\nauthors' reputations.\n\n Finally, any free program is threatened constantly by software\npatents. We wish to avoid the danger that redistributors of a free\nprogram will individually obtain patent licenses, in effect making the\nprogram proprietary. To prevent this, we have made it clear that any\npatent must be licensed for everyone's free use or not licensed at all.\n\n The precise terms and conditions for copying, distribution and\nmodification follow.\n\n GNU GENERAL PUBLIC LICENSE\n TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION\n\n 0. This License applies to any program or other work which contains\na notice placed by the copyright holder saying it may be distributed\nunder the terms of this General Public License. The \"Program\", below,\nrefers to any such program or work, and a \"work based on the Program\"\nmeans either the Program or any derivative work under copyright law:\nthat is to say, a work containing the Program or a portion of it,\neither verbatim or with modifications and/or translated into another\nlanguage. (Hereinafter, translation is included without limitation in\nthe term \"modification\".) Each licensee is addressed as \"you\".\n\nActivities other than copying, distribution and modification are not\ncovered by this License; they are outside its scope. The act of\nrunning the Program is not restricted, and the output from the Program\nis covered only if its contents constitute a work based on the\nProgram (independent of having been made by running the Program).\nWhether that is true depends on what the Program does.\n\n 1. You may copy and distribute verbatim copies of the Program's\nsource code as you receive it, in any medium, provided that you\nconspicuously and appropriately publish on each copy an appropriate\ncopyright notice and disclaimer of warranty; keep intact all the\nnotices that refer to this License and to the absence of any warranty;\nand give any other recipients of the Program a copy of this License\nalong with the Program.\n\nYou may charge a fee for the physical act of transferring a copy, and\nyou may at your option offer warranty protection in exchange for a fee.\n\n 2. You may modify your copy or copies of the Program or any portion\nof it, thus forming a work based on the Program, and copy and\ndistribute such modifications or work under the terms of Section 1\nabove, provided that you also meet all of these conditions:\n\n a) You must cause the modified files to carry prominent notices\n stating that you changed the files and the date of any change.\n\n b) You must cause any work that you distribute or publish, that in\n whole or in part contains or is derived from the Program or any\n part thereof, to be licensed as a whole at no charge to all third\n parties under the terms of this License.\n\n c) If the modified program normally reads commands interactively\n when run, you must cause it, when started running for such\n interactive use in the most ordinary way, to print or display an\n announcement including an appropriate copyright notice and a\n notice that there is no warranty (or else, saying that you provide\n a warranty) and that users may redistribute the program under\n these conditions, and telling the user how to view a copy of this\n License. (Exception: if the Program itself is interactive but\n does not normally print such an announcement, your work based on\n the Program is not required to print an announcement.)\n\nThese requirements apply to the modified work as a whole. If\nidentifiable sections of that work are not derived from the Program,\nand can be reasonably considered independent and separate works in\nthemselves, then this License, and its terms, do not apply to those\nsections when you distribute them as separate works. But when you\ndistribute the same sections as part of a whole which is a work based\non the Program, the distribution of the whole must be on the terms of\nthis License, whose permissions for other licensees extend to the\nentire whole, and thus to each and every part regardless of who wrote it.\n\nThus, it is not the intent of this section to claim rights or contest\nyour rights to work written entirely by you; rather, the intent is to\nexercise the right to control the distribution of derivative or\ncollective works based on the Program.\n\nIn addition, mere aggregation of another work not based on the Program\nwith the Program (or with a work based on the Program) on a volume of\na storage or distribution medium does not bring the other work under\nthe scope of this License.\n\n 3. You may copy and distribute the Program (or a work based on it,\nunder Section 2) in object code or executable form under the terms of\nSections 1 and 2 above provided that you also do one of the following:\n\n a) Accompany it with the complete corresponding machine-readable\n source code, which must be distributed under the terms of Sections\n 1 and 2 above on a medium customarily used for software interchange; or,\n\n b) Accompany it with a written offer, valid for at least three\n years, to give any third party, for a charge no more than your\n cost of physically performing source distribution, a complete\n machine-readable copy of the corresponding source code, to be\n distributed under the terms of Sections 1 and 2 above on a medium\n customarily used for software interchange; or,\n\n c) Accompany it with the information you received as to the offer\n to distribute corresponding source code. (This alternative is\n allowed only for noncommercial distribution and only if you\n received the program in object code or executable form with such\n an offer, in accord with Subsection b above.)\n\nThe source code for a work means the preferred form of the work for\nmaking modifications to it. For an executable work, complete source\ncode means all the source code for all modules it contains, plus any\nassociated interface definition files, plus the scripts used to\ncontrol compilation and installation of the executable. However, as a\nspecial exception, the source code distributed need not include\nanything that is normally distributed (in either source or binary\nform) with the major components (compiler, kernel, and so on) of the\noperating system on which the executable runs, unless that component\nitself accompanies the executable.\n\nIf distribution of executable or object code is made by offering\naccess to copy from a designated place, then offering equivalent\naccess to copy the source code from the same place counts as\ndistribution of the source code, even though third parties are not\ncompelled to copy the source along with the object code.\n\n 4. You may not copy, modify, sublicense, or distribute the Program\nexcept as expressly provided under this License. Any attempt\notherwise to copy, modify, sublicense or distribute the Program is\nvoid, and will automatically terminate your rights under this License.\nHowever, parties who have received copies, or rights, from you under\nthis License will not have their licenses terminated so long as such\nparties remain in full compliance.\n\n 5. You are not required to accept this License, since you have not\nsigned it. However, nothing else grants you permission to modify or\ndistribute the Program or its derivative works. These actions are\nprohibited by law if you do not accept this License. Therefore, by\nmodifying or distributing the Program (or any work based on the\nProgram), you indicate your acceptance of this License to do so, and\nall its terms and conditions for copying, distributing or modifying\nthe Program or works based on it.\n\n 6. Each time you redistribute the Program (or any work based on the\nProgram), the recipient automatically receives a license from the\noriginal licensor to copy, distribute or modify the Program subject to\nthese terms and conditions. You may not impose any further\nrestrictions on the recipients' exercise of the rights granted herein.\nYou are not responsible for enforcing compliance by third parties to\nthis License.\n\n 7. If, as a consequence of a court judgment or allegation of patent\ninfringement or for any other reason (not limited to patent issues),\nconditions are imposed on you (whether by court order, agreement or\notherwise) that contradict the conditions of this License, they do not\nexcuse you from the conditions of this License. If you cannot\ndistribute so as to satisfy simultaneously your obligations under this\nLicense and any other pertinent obligations, then as a consequence you\nmay not distribute the Program at all. For example, if a patent\nlicense would not permit royalty-free redistribution of the Program by\nall those who receive copies directly or indirectly through you, then\nthe only way you could satisfy both it and this License would be to\nrefrain entirely from distribution of the Program.\n\nIf any portion of this section is held invalid or unenforceable under\nany particular circumstance, the balance of the section is intended to\napply and the section as a whole is intended to apply in other\ncircumstances.\n\nIt is not the purpose of this section to induce you to infringe any\npatents or other property right claims or to contest validity of any\nsuch claims; this section has the sole purpose of protecting the\nintegrity of the free software distribution system, which is\nimplemented by public license practices. Many people have made\ngenerous contributions to the wide range of software distributed\nthrough that system in reliance on consistent application of that\nsystem; it is up to the author/donor to decide if he or she is willing\nto distribute software through any other system and a licensee cannot\nimpose that choice.\n\nThis section is intended to make thoroughly clear what is believed to\nbe a consequence of the rest of this License.\n\n 8. If the distribution and/or use of the Program is restricted in\ncertain countries either by patents or by copyrighted interfaces, the\noriginal copyright holder who places the Program under this License\nmay add an explicit geographical distribution limitation excluding\nthose countries, so that distribution is permitted only in or among\ncountries not thus excluded. In such case, this License incorporates\nthe limitation as if written in the body of this License.\n\n 9. The Free Software Foundation may publish revised and/or new versions\nof the General Public License from time to time. Such new versions will\nbe similar in spirit to the present version, but may differ in detail to\naddress new problems or concerns.\n\nEach version is given a distinguishing version number. If the Program\nspecifies a version number of this License which applies to it and \"any\nlater version\", you have the option of following the terms and conditions\neither of that version or of any later version published by the Free\nSoftware Foundation. If the Program does not specify a version number of\nthis License, you may choose any version ever published by the Free Software\nFoundation.\n\n 10. If you wish to incorporate parts of the Program into other free\nprograms whose distribution conditions are different, write to the author\nto ask for permission. For software which is copyrighted by the Free\nSoftware Foundation, write to the Free Software Foundation; we sometimes\nmake exceptions for this. Our decision will be guided by the two goals\nof preserving the free status of all derivatives of our free software and\nof promoting the sharing and reuse of software generally.\n\n NO WARRANTY\n\n 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY\nFOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN\nOTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES\nPROVIDE THE PROGRAM \"AS IS\" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED\nOR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF\nMERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS\nTO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE\nPROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,\nREPAIR OR CORRECTION.\n\n 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING\nWILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR\nREDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,\nINCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING\nOUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED\nTO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY\nYOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER\nPROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE\nPOSSIBILITY OF SUCH DAMAGES.\n\n END OF TERMS AND CONDITIONS\n\n How to Apply These Terms to Your New Programs\n\n If you develop a new program, and you want it to be of the greatest\npossible use to the public, the best way to achieve this is to make it\nfree software which everyone can redistribute and change under these terms.\n\n To do so, attach the following notices to the program. It is safest\nto attach them to the start of each source file to most effectively\nconvey the exclusion of warranty; and each file should have at least\nthe \"copyright\" line and a pointer to where the full notice is found.\n\n \n Copyright (C) \n\n This program is free software; you can redistribute it and/or modify\n it under the terms of the GNU General Public License as published by\n the Free Software Foundation; either version 2 of the License, or\n (at your option) any later version.\n\n This program is distributed in the hope that it will be useful,\n but WITHOUT ANY WARRANTY; without even the implied warranty of\n MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n GNU General Public License for more details.\n\n You should have received a copy of the GNU General Public License along\n with this program; if not, write to the Free Software Foundation, Inc.,\n 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.\n\nAlso add information on how to contact you by electronic and paper mail.\n\nIf the program is interactive, make it output a short notice like this\nwhen it starts in an interactive mode:\n\n Gnomovision version 69, Copyright (C) year name of author\n Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.\n This is free software, and you are welcome to redistribute it\n under certain conditions; type `show c' for details.\n\nThe hypothetical commands `show w' and `show c' should show the appropriate\nparts of the General Public License. Of course, the commands you use may\nbe called something other than `show w' and `show c'; they could even be\nmouse-clicks or menu items--whatever suits your program.\n\nYou should also get your employer (if you work as a programmer) or your\nschool, if any, to sign a \"copyright disclaimer\" for the program, if\nnecessary. Here is a sample; alter the names:\n\n Yoyodyne, Inc., hereby disclaims all copyright interest in the program\n `Gnomovision' (which makes passes at compilers) written by James Hacker.\n\n , 1 April 1989\n Ty Coon, President of Vice\n\nThis General Public License does not permit incorporating your program into\nproprietary programs. If your program is a subroutine library, you may\nconsider it more useful to permit linking proprietary applications with the\nlibrary. If this is what you want to do, use the GNU Lesser General\nPublic License instead of this License." }, { "path": "plugin-name/README.txt", "content": "=== Plugin Name ===\nContributors: (this should be a list of wordpress.org userid's)\nDonate link: http://example.com/\nTags: comments, spam\nRequires at least: 3.0.1\nTested up to: 3.4\nStable tag: 4.3\nLicense: GPLv2 or later\nLicense URI: http://www.gnu.org/licenses/gpl-2.0.html\n\nHere is a short description of the plugin. This should be no more than 150 characters. No markup here.\n\n== Description ==\n\nThis is the long description. No limit, and you can use Markdown (as well as in the following sections).\n\nFor backwards compatibility, if this section is missing, the full length of the short description will be used, and\nMarkdown parsed.\n\nA few notes about the sections above:\n\n* \"Contributors\" is a comma separated list of wp.org/wp-plugins.org usernames\n* \"Tags\" is a comma separated list of tags that apply to the plugin\n* \"Requires at least\" is the lowest version that the plugin will work on\n* \"Tested up to\" is the highest version that you've *successfully used to test the plugin*. Note that it might work on\nhigher versions... this is just the highest one you've verified.\n* Stable tag should indicate the Subversion \"tag\" of the latest stable version, or \"trunk,\" if you use `/trunk/` for\nstable.\n\n Note that the `readme.txt` of the stable tag is the one that is considered the defining one for the plugin, so\nif the `/trunk/readme.txt` file says that the stable tag is `4.3`, then it is `/tags/4.3/readme.txt` that'll be used\nfor displaying information about the plugin. In this situation, the only thing considered from the trunk `readme.txt`\nis the stable tag pointer. Thus, if you develop in trunk, you can update the trunk `readme.txt` to reflect changes in\nyour in-development version, without having that information incorrectly disclosed about the current stable version\nthat lacks those changes -- as long as the trunk's `readme.txt` points to the correct stable tag.\n\n If no stable tag is provided, it is assumed that trunk is stable, but you should specify \"trunk\" if that's where\nyou put the stable version, in order to eliminate any doubt.\n\n== Installation ==\n\nThis section describes how to install the plugin and get it working.\n\ne.g.\n\n1. Upload `plugin-name.php` to the `/wp-content/plugins/` directory\n1. Activate the plugin through the 'Plugins' menu in WordPress\n1. Place `` in your templates\n\n== Frequently Asked Questions ==\n\n= A question that someone might have =\n\nAn answer to that question.\n\n= What about foo bar? =\n\nAnswer to foo bar dilemma.\n\n== Screenshots ==\n\n1. This screen shot description corresponds to screenshot-1.(png|jpg|jpeg|gif). Note that the screenshot is taken from\nthe /assets directory or the directory that contains the stable readme.txt (tags or trunk). Screenshots in the /assets\ndirectory take precedence. For example, `/assets/screenshot-1.png` would win over `/tags/4.3/screenshot-1.png`\n(or jpg, jpeg, gif).\n2. This is the second screen shot\n\n== Changelog ==\n\n= 1.0 =\n* A change since the previous version.\n* Another change.\n\n= 0.5 =\n* List versions from most recent at top to oldest at bottom.\n\n== Upgrade Notice ==\n\n= 1.0 =\nUpgrade notices describe the reason a user should upgrade. No more than 300 characters.\n\n= 0.5 =\nThis version fixes a security related bug. Upgrade immediately.\n\n== Arbitrary section ==\n\nYou may provide arbitrary sections, in the same format as the ones above. This may be of use for extremely complicated\nplugins where more information needs to be conveyed that doesn't fit into the categories of \"description\" or\n\"installation.\" Arbitrary sections will be shown below the built-in sections outlined above.\n\n== A brief Markdown Example ==\n\nOrdered list:\n\n1. Some feature\n1. Another feature\n1. Something else about the plugin\n\nUnordered list:\n\n* something\n* something else\n* third thing\n\nHere's a link to [WordPress](http://wordpress.org/ \"Your favorite software\") and one to [Markdown's Syntax Documentation][markdown syntax].\nTitles are optional, naturally.\n\n[markdown syntax]: http://daringfireball.net/projects/markdown/syntax\n \"Markdown is what the parser uses to process much of the readme file\"\n\nMarkdown uses email style notation for blockquotes and I've been told:\n> Asterisks for *emphasis*. Double it up for **strong**.\n\n``" }, { "path": "plugin-name/admin/class-plugin-name-admin.php", "content": "\n */\nclass Plugin_Name_Admin {\n\n\t/**\n\t * The ID of this plugin.\n\t *\n\t * @since 1.0.0\n\t * @access private\n\t * @var string $plugin_name The ID of this plugin.\n\t */\n\tprivate $plugin_name;\n\n\t/**\n\t * The version of this plugin.\n\t *\n\t * @since 1.0.0\n\t * @access private\n\t * @var string $version The current version of this plugin.\n\t */\n\tprivate $version;\n\n\t/**\n\t * Initialize the class and set its properties.\n\t *\n\t * @since 1.0.0\n\t * @param string $plugin_name The name of this plugin.\n\t * @param string $version The version of this plugin.\n\t */\n\tpublic function __construct( $plugin_name, $version ) {\n\n\t\t$this->plugin_name = $plugin_name;\n\t\t$this->version = $version;\n\n\t}\n\n\t/**\n\t * Register the stylesheets for the admin area.\n\t *\n\t * @since 1.0.0\n\t */\n\tpublic function enqueue_styles() {\n\n\t\t/**\n\t\t * This function is provided for demonstration purposes only.\n\t\t *\n\t\t * An instance of this class should be passed to the run() function\n\t\t * defined in Plugin_Name_Loader as all of the hooks are defined\n\t\t * in that particular class.\n\t\t *\n\t\t * The Plugin_Name_Loader will then create the relationship\n\t\t * between the defined hooks and the functions defined in this\n\t\t * class.\n\t\t */\n\n\t\twp_enqueue_style( $this->plugin_name, plugin_dir_url( __FILE__ ) . 'css/plugin-name-admin.css', array(), $this->version, 'all' );\n\n\t}\n\n\t/**\n\t * Register the JavaScript for the admin area.\n\t *\n\t * @since 1.0.0\n\t */\n\tpublic function enqueue_scripts() {\n\n\t\t/**\n\t\t * This function is provided for demonstration purposes only.\n\t\t *\n\t\t * An instance of this class should be passed to the run() function\n\t\t * defined in Plugin_Name_Loader as all of the hooks are defined\n\t\t * in that particular class.\n\t\t *\n\t\t * The Plugin_Name_Loader will then create the relationship\n\t\t * between the defined hooks and the functions defined in this\n\t\t * class.\n\t\t */\n\n\t\twp_enqueue_script( $this->plugin_name, plugin_dir_url( __FILE__ ) . 'js/plugin-name-admin.js', array( 'jquery' ), $this->version, false );\n\n\t}\n\n}\n" }, { "path": "plugin-name/admin/css/plugin-name-admin.css", "content": "/**\n * All of the CSS for your admin-specific functionality should be\n * included in this file.\n */" }, { "path": "plugin-name/admin/index.php", "content": "\n\n\n" }, { "path": "plugin-name/includes/class-plugin-name-activator.php", "content": "\n */\nclass Plugin_Name_Activator {\n\n\t/**\n\t * Short Description. (use period)\n\t *\n\t * Long Description.\n\t *\n\t * @since 1.0.0\n\t */\n\tpublic static function activate() {\n\n\t}\n\n}\n" }, { "path": "plugin-name/includes/class-plugin-name-deactivator.php", "content": "\n */\nclass Plugin_Name_Deactivator {\n\n\t/**\n\t * Short Description. (use period)\n\t *\n\t * Long Description.\n\t *\n\t * @since 1.0.0\n\t */\n\tpublic static function deactivate() {\n\n\t}\n\n}\n" }, { "path": "plugin-name/includes/class-plugin-name-i18n.php", "content": "\n */\nclass Plugin_Name_i18n {\n\n\n\t/**\n\t * Load the plugin text domain for translation.\n\t *\n\t * @since 1.0.0\n\t */\n\tpublic function load_plugin_textdomain() {\n\n\t\tload_plugin_textdomain(\n\t\t\t'plugin-name',\n\t\t\tfalse,\n\t\t\tdirname( dirname( plugin_basename( __FILE__ ) ) ) . '/languages/'\n\t\t);\n\n\t}\n\n\n\n}\n" }, { "path": "plugin-name/includes/class-plugin-name-loader.php", "content": "\n */\nclass Plugin_Name_Loader {\n\n\t/**\n\t * The array of actions registered with WordPress.\n\t *\n\t * @since 1.0.0\n\t * @access protected\n\t * @var array $actions The actions registered with WordPress to fire when the plugin loads.\n\t */\n\tprotected $actions;\n\n\t/**\n\t * The array of filters registered with WordPress.\n\t *\n\t * @since 1.0.0\n\t * @access protected\n\t * @var array $filters The filters registered with WordPress to fire when the plugin loads.\n\t */\n\tprotected $filters;\n\n\t/**\n\t * Initialize the collections used to maintain the actions and filters.\n\t *\n\t * @since 1.0.0\n\t */\n\tpublic function __construct() {\n\n\t\t$this->actions = array();\n\t\t$this->filters = array();\n\n\t}\n\n\t/**\n\t * Add a new action to the collection to be registered with WordPress.\n\t *\n\t * @since 1.0.0\n\t * @param string $hook The name of the WordPress action that is being registered.\n\t * @param object $component A reference to the instance of the object on which the action is defined.\n\t * @param string $callback The name of the function definition on the $component.\n\t * @param int $priority Optional. The priority at which the function should be fired. Default is 10.\n\t * @param int $accepted_args Optional. The number of arguments that should be passed to the $callback. Default is 1.\n\t */\n\tpublic function add_action( $hook, $component, $callback, $priority = 10, $accepted_args = 1 ) {\n\t\t$this->actions = $this->add( $this->actions, $hook, $component, $callback, $priority, $accepted_args );\n\t}\n\n\t/**\n\t * Add a new filter to the collection to be registered with WordPress.\n\t *\n\t * @since 1.0.0\n\t * @param string $hook The name of the WordPress filter that is being registered.\n\t * @param object $component A reference to the instance of the object on which the filter is defined.\n\t * @param string $callback The name of the function definition on the $component.\n\t * @param int $priority Optional. The priority at which the function should be fired. Default is 10.\n\t * @param int $accepted_args Optional. The number of arguments that should be passed to the $callback. Default is 1\n\t */\n\tpublic function add_filter( $hook, $component, $callback, $priority = 10, $accepted_args = 1 ) {\n\t\t$this->filters = $this->add( $this->filters, $hook, $component, $callback, $priority, $accepted_args );\n\t}\n\n\t/**\n\t * A utility function that is used to register the actions and hooks into a single\n\t * collection.\n\t *\n\t * @since 1.0.0\n\t * @access private\n\t * @param array $hooks The collection of hooks that is being registered (that is, actions or filters).\n\t * @param string $hook The name of the WordPress filter that is being registered.\n\t * @param object $component A reference to the instance of the object on which the filter is defined.\n\t * @param string $callback The name of the function definition on the $component.\n\t * @param int $priority The priority at which the function should be fired.\n\t * @param int $accepted_args The number of arguments that should be passed to the $callback.\n\t * @return array The collection of actions and filters registered with WordPress.\n\t */\n\tprivate function add( $hooks, $hook, $component, $callback, $priority, $accepted_args ) {\n\n\t\t$hooks[] = array(\n\t\t\t'hook' => $hook,\n\t\t\t'component' => $component,\n\t\t\t'callback' => $callback,\n\t\t\t'priority' => $priority,\n\t\t\t'accepted_args' => $accepted_args\n\t\t);\n\n\t\treturn $hooks;\n\n\t}\n\n\t/**\n\t * Register the filters and actions with WordPress.\n\t *\n\t * @since 1.0.0\n\t */\n\tpublic function run() {\n\n\t\tforeach ( $this->filters as $hook ) {\n\t\t\tadd_filter( $hook['hook'], array( $hook['component'], $hook['callback'] ), $hook['priority'], $hook['accepted_args'] );\n\t\t}\n\n\t\tforeach ( $this->actions as $hook ) {\n\t\t\tadd_action( $hook['hook'], array( $hook['component'], $hook['callback'] ), $hook['priority'], $hook['accepted_args'] );\n\t\t}\n\n\t}\n\n}\n" }, { "path": "plugin-name/includes/class-plugin-name.php", "content": "\n */\nclass Plugin_Name {\n\n\t/**\n\t * The loader that's responsible for maintaining and registering all hooks that power\n\t * the plugin.\n\t *\n\t * @since 1.0.0\n\t * @access protected\n\t * @var Plugin_Name_Loader $loader Maintains and registers all hooks for the plugin.\n\t */\n\tprotected $loader;\n\n\t/**\n\t * The unique identifier of this plugin.\n\t *\n\t * @since 1.0.0\n\t * @access protected\n\t * @var string $plugin_name The string used to uniquely identify this plugin.\n\t */\n\tprotected $plugin_name;\n\n\t/**\n\t * The current version of the plugin.\n\t *\n\t * @since 1.0.0\n\t * @access protected\n\t * @var string $version The current version of the plugin.\n\t */\n\tprotected $version;\n\n\t/**\n\t * Define the core functionality of the plugin.\n\t *\n\t * Set the plugin name and the plugin version that can be used throughout the plugin.\n\t * Load the dependencies, define the locale, and set the hooks for the admin area and\n\t * the public-facing side of the site.\n\t *\n\t * @since 1.0.0\n\t */\n\tpublic function __construct() {\n\t\tif ( defined( 'PLUGIN_NAME_VERSION' ) ) {\n\t\t\t$this->version = PLUGIN_NAME_VERSION;\n\t\t} else {\n\t\t\t$this->version = '1.0.0';\n\t\t}\n\t\t$this->plugin_name = 'plugin-name';\n\n\t\t$this->load_dependencies();\n\t\t$this->set_locale();\n\t\t$this->define_admin_hooks();\n\t\t$this->define_public_hooks();\n\n\t}\n\n\t/**\n\t * Load the required dependencies for this plugin.\n\t *\n\t * Include the following files that make up the plugin:\n\t *\n\t * - Plugin_Name_Loader. Orchestrates the hooks of the plugin.\n\t * - Plugin_Name_i18n. Defines internationalization functionality.\n\t * - Plugin_Name_Admin. Defines all hooks for the admin area.\n\t * - Plugin_Name_Public. Defines all hooks for the public side of the site.\n\t *\n\t * Create an instance of the loader which will be used to register the hooks\n\t * with WordPress.\n\t *\n\t * @since 1.0.0\n\t * @access private\n\t */\n\tprivate function load_dependencies() {\n\n\t\t/**\n\t\t * The class responsible for orchestrating the actions and filters of the\n\t\t * core plugin.\n\t\t */\n\t\trequire_once plugin_dir_path( dirname( __FILE__ ) ) . 'includes/class-plugin-name-loader.php';\n\n\t\t/**\n\t\t * The class responsible for defining internationalization functionality\n\t\t * of the plugin.\n\t\t */\n\t\trequire_once plugin_dir_path( dirname( __FILE__ ) ) . 'includes/class-plugin-name-i18n.php';\n\n\t\t/**\n\t\t * The class responsible for defining all actions that occur in the admin area.\n\t\t */\n\t\trequire_once plugin_dir_path( dirname( __FILE__ ) ) . 'admin/class-plugin-name-admin.php';\n\n\t\t/**\n\t\t * The class responsible for defining all actions that occur in the public-facing\n\t\t * side of the site.\n\t\t */\n\t\trequire_once plugin_dir_path( dirname( __FILE__ ) ) . 'public/class-plugin-name-public.php';\n\n\t\t$this->loader = new Plugin_Name_Loader();\n\n\t}\n\n\t/**\n\t * Define the locale for this plugin for internationalization.\n\t *\n\t * Uses the Plugin_Name_i18n class in order to set the domain and to register the hook\n\t * with WordPress.\n\t *\n\t * @since 1.0.0\n\t * @access private\n\t */\n\tprivate function set_locale() {\n\n\t\t$plugin_i18n = new Plugin_Name_i18n();\n\n\t\t$this->loader->add_action( 'plugins_loaded', $plugin_i18n, 'load_plugin_textdomain' );\n\n\t}\n\n\t/**\n\t * Register all of the hooks related to the admin area functionality\n\t * of the plugin.\n\t *\n\t * @since 1.0.0\n\t * @access private\n\t */\n\tprivate function define_admin_hooks() {\n\n\t\t$plugin_admin = new Plugin_Name_Admin( $this->get_plugin_name(), $this->get_version() );\n\n\t\t$this->loader->add_action( 'admin_enqueue_scripts', $plugin_admin, 'enqueue_styles' );\n\t\t$this->loader->add_action( 'admin_enqueue_scripts', $plugin_admin, 'enqueue_scripts' );\n\n\t}\n\n\t/**\n\t * Register all of the hooks related to the public-facing functionality\n\t * of the plugin.\n\t *\n\t * @since 1.0.0\n\t * @access private\n\t */\n\tprivate function define_public_hooks() {\n\n\t\t$plugin_public = new Plugin_Name_Public( $this->get_plugin_name(), $this->get_version() );\n\n\t\t$this->loader->add_action( 'wp_enqueue_scripts', $plugin_public, 'enqueue_styles' );\n\t\t$this->loader->add_action( 'wp_enqueue_scripts', $plugin_public, 'enqueue_scripts' );\n\n\t}\n\n\t/**\n\t * Run the loader to execute all of the hooks with WordPress.\n\t *\n\t * @since 1.0.0\n\t */\n\tpublic function run() {\n\t\t$this->loader->run();\n\t}\n\n\t/**\n\t * The name of the plugin used to uniquely identify it within the context of\n\t * WordPress and to define internationalization functionality.\n\t *\n\t * @since 1.0.0\n\t * @return string The name of the plugin.\n\t */\n\tpublic function get_plugin_name() {\n\t\treturn $this->plugin_name;\n\t}\n\n\t/**\n\t * The reference to the class that orchestrates the hooks with the plugin.\n\t *\n\t * @since 1.0.0\n\t * @return Plugin_Name_Loader Orchestrates the hooks of the plugin.\n\t */\n\tpublic function get_loader() {\n\t\treturn $this->loader;\n\t}\n\n\t/**\n\t * Retrieve the version number of the plugin.\n\t *\n\t * @since 1.0.0\n\t * @return string The version number of the plugin.\n\t */\n\tpublic function get_version() {\n\t\treturn $this->version;\n\t}\n\n}\n" }, { "path": "plugin-name/includes/index.php", "content": "run();\n\n}\nrun_plugin_name();\n" }, { "path": "plugin-name/public/class-plugin-name-public.php", "content": "\n */\nclass Plugin_Name_Public {\n\n\t/**\n\t * The ID of this plugin.\n\t *\n\t * @since 1.0.0\n\t * @access private\n\t * @var string $plugin_name The ID of this plugin.\n\t */\n\tprivate $plugin_name;\n\n\t/**\n\t * The version of this plugin.\n\t *\n\t * @since 1.0.0\n\t * @access private\n\t * @var string $version The current version of this plugin.\n\t */\n\tprivate $version;\n\n\t/**\n\t * Initialize the class and set its properties.\n\t *\n\t * @since 1.0.0\n\t * @param string $plugin_name The name of the plugin.\n\t * @param string $version The version of this plugin.\n\t */\n\tpublic function __construct( $plugin_name, $version ) {\n\n\t\t$this->plugin_name = $plugin_name;\n\t\t$this->version = $version;\n\n\t}\n\n\t/**\n\t * Register the stylesheets for the public-facing side of the site.\n\t *\n\t * @since 1.0.0\n\t */\n\tpublic function enqueue_styles() {\n\n\t\t/**\n\t\t * This function is provided for demonstration purposes only.\n\t\t *\n\t\t * An instance of this class should be passed to the run() function\n\t\t * defined in Plugin_Name_Loader as all of the hooks are defined\n\t\t * in that particular class.\n\t\t *\n\t\t * The Plugin_Name_Loader will then create the relationship\n\t\t * between the defined hooks and the functions defined in this\n\t\t * class.\n\t\t */\n\n\t\twp_enqueue_style( $this->plugin_name, plugin_dir_url( __FILE__ ) . 'css/plugin-name-public.css', array(), $this->version, 'all' );\n\n\t}\n\n\t/**\n\t * Register the JavaScript for the public-facing side of the site.\n\t *\n\t * @since 1.0.0\n\t */\n\tpublic function enqueue_scripts() {\n\n\t\t/**\n\t\t * This function is provided for demonstration purposes only.\n\t\t *\n\t\t * An instance of this class should be passed to the run() function\n\t\t * defined in Plugin_Name_Loader as all of the hooks are defined\n\t\t * in that particular class.\n\t\t *\n\t\t * The Plugin_Name_Loader will then create the relationship\n\t\t * between the defined hooks and the functions defined in this\n\t\t * class.\n\t\t */\n\n\t\twp_enqueue_script( $this->plugin_name, plugin_dir_url( __FILE__ ) . 'js/plugin-name-public.js', array( 'jquery' ), $this->version, false );\n\n\t}\n\n}\n" }, { "path": "plugin-name/public/css/plugin-name-public.css", "content": "/**\n * All of the CSS for your public-facing functionality should be\n * included in this file.\n */" }, { "path": "plugin-name/public/index.php", "content": "\n\n\n" }, { "path": "plugin-name/uninstall.php", "content": "