mirror of
https://github.com/inretio/WordPress-Plugin-Boilerplate
synced 2024-12-22 11:53:53 +02:00
Restarting at ground zero.
Signed-off-by: Tom McFarlin <tom@tommcfarlin.com>
This commit is contained in:
Tom McFarlin
parent
022dd60d41
commit
eecfb8a4cd
29 changed files with 0 additions and 1245 deletions
|
|
@ -1,339 +0,0 @@
|
||||||
GNU GENERAL PUBLIC LICENSE
|
|
||||||
Version 2, June 1991
|
|
||||||
|
|
||||||
Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
|
|
||||||
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
|
||||||
Everyone is permitted to copy and distribute verbatim copies
|
|
||||||
of this license document, but changing it is not allowed.
|
|
||||||
|
|
||||||
Preamble
|
|
||||||
|
|
||||||
The licenses for most software are designed to take away your
|
|
||||||
freedom to share and change it. By contrast, the GNU General Public
|
|
||||||
License is intended to guarantee your freedom to share and change free
|
|
||||||
software--to make sure the software is free for all its users. This
|
|
||||||
General Public License applies to most of the Free Software
|
|
||||||
Foundation's software and to any other program whose authors commit to
|
|
||||||
using it. (Some other Free Software Foundation software is covered by
|
|
||||||
the GNU Lesser General Public License instead.) You can apply it to
|
|
||||||
your programs, too.
|
|
||||||
|
|
||||||
When we speak of free software, we are referring to freedom, not
|
|
||||||
price. Our General Public Licenses are designed to make sure that you
|
|
||||||
have the freedom to distribute copies of free software (and charge for
|
|
||||||
this service if you wish), that you receive source code or can get it
|
|
||||||
if you want it, that you can change the software or use pieces of it
|
|
||||||
in new free programs; and that you know you can do these things.
|
|
||||||
|
|
||||||
To protect your rights, we need to make restrictions that forbid
|
|
||||||
anyone to deny you these rights or to ask you to surrender the rights.
|
|
||||||
These restrictions translate to certain responsibilities for you if you
|
|
||||||
distribute copies of the software, or if you modify it.
|
|
||||||
|
|
||||||
For example, if you distribute copies of such a program, whether
|
|
||||||
gratis or for a fee, you must give the recipients all the rights that
|
|
||||||
you have. You must make sure that they, too, receive or can get the
|
|
||||||
source code. And you must show them these terms so they know their
|
|
||||||
rights.
|
|
||||||
|
|
||||||
We protect your rights with two steps: (1) copyright the software, and
|
|
||||||
(2) offer you this license which gives you legal permission to copy,
|
|
||||||
distribute and/or modify the software.
|
|
||||||
|
|
||||||
Also, for each author's protection and ours, we want to make certain
|
|
||||||
that everyone understands that there is no warranty for this free
|
|
||||||
software. If the software is modified by someone else and passed on, we
|
|
||||||
want its recipients to know that what they have is not the original, so
|
|
||||||
that any problems introduced by others will not reflect on the original
|
|
||||||
authors' reputations.
|
|
||||||
|
|
||||||
Finally, any free program is threatened constantly by software
|
|
||||||
patents. We wish to avoid the danger that redistributors of a free
|
|
||||||
program will individually obtain patent licenses, in effect making the
|
|
||||||
program proprietary. To prevent this, we have made it clear that any
|
|
||||||
patent must be licensed for everyone's free use or not licensed at all.
|
|
||||||
|
|
||||||
The precise terms and conditions for copying, distribution and
|
|
||||||
modification follow.
|
|
||||||
|
|
||||||
GNU GENERAL PUBLIC LICENSE
|
|
||||||
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
|
|
||||||
|
|
||||||
0. This License applies to any program or other work which contains
|
|
||||||
a notice placed by the copyright holder saying it may be distributed
|
|
||||||
under the terms of this General Public License. The "Program", below,
|
|
||||||
refers to any such program or work, and a "work based on the Program"
|
|
||||||
means either the Program or any derivative work under copyright law:
|
|
||||||
that is to say, a work containing the Program or a portion of it,
|
|
||||||
either verbatim or with modifications and/or translated into another
|
|
||||||
language. (Hereinafter, translation is included without limitation in
|
|
||||||
the term "modification".) Each licensee is addressed as "you".
|
|
||||||
|
|
||||||
Activities other than copying, distribution and modification are not
|
|
||||||
covered by this License; they are outside its scope. The act of
|
|
||||||
running the Program is not restricted, and the output from the Program
|
|
||||||
is covered only if its contents constitute a work based on the
|
|
||||||
Program (independent of having been made by running the Program).
|
|
||||||
Whether that is true depends on what the Program does.
|
|
||||||
|
|
||||||
1. You may copy and distribute verbatim copies of the Program's
|
|
||||||
source code as you receive it, in any medium, provided that you
|
|
||||||
conspicuously and appropriately publish on each copy an appropriate
|
|
||||||
copyright notice and disclaimer of warranty; keep intact all the
|
|
||||||
notices that refer to this License and to the absence of any warranty;
|
|
||||||
and give any other recipients of the Program a copy of this License
|
|
||||||
along with the Program.
|
|
||||||
|
|
||||||
You may charge a fee for the physical act of transferring a copy, and
|
|
||||||
you may at your option offer warranty protection in exchange for a fee.
|
|
||||||
|
|
||||||
2. You may modify your copy or copies of the Program or any portion
|
|
||||||
of it, thus forming a work based on the Program, and copy and
|
|
||||||
distribute such modifications or work under the terms of Section 1
|
|
||||||
above, provided that you also meet all of these conditions:
|
|
||||||
|
|
||||||
a) You must cause the modified files to carry prominent notices
|
|
||||||
stating that you changed the files and the date of any change.
|
|
||||||
|
|
||||||
b) You must cause any work that you distribute or publish, that in
|
|
||||||
whole or in part contains or is derived from the Program or any
|
|
||||||
part thereof, to be licensed as a whole at no charge to all third
|
|
||||||
parties under the terms of this License.
|
|
||||||
|
|
||||||
c) If the modified program normally reads commands interactively
|
|
||||||
when run, you must cause it, when started running for such
|
|
||||||
interactive use in the most ordinary way, to print or display an
|
|
||||||
announcement including an appropriate copyright notice and a
|
|
||||||
notice that there is no warranty (or else, saying that you provide
|
|
||||||
a warranty) and that users may redistribute the program under
|
|
||||||
these conditions, and telling the user how to view a copy of this
|
|
||||||
License. (Exception: if the Program itself is interactive but
|
|
||||||
does not normally print such an announcement, your work based on
|
|
||||||
the Program is not required to print an announcement.)
|
|
||||||
|
|
||||||
These requirements apply to the modified work as a whole. If
|
|
||||||
identifiable sections of that work are not derived from the Program,
|
|
||||||
and can be reasonably considered independent and separate works in
|
|
||||||
themselves, then this License, and its terms, do not apply to those
|
|
||||||
sections when you distribute them as separate works. But when you
|
|
||||||
distribute the same sections as part of a whole which is a work based
|
|
||||||
on the Program, the distribution of the whole must be on the terms of
|
|
||||||
this License, whose permissions for other licensees extend to the
|
|
||||||
entire whole, and thus to each and every part regardless of who wrote it.
|
|
||||||
|
|
||||||
Thus, it is not the intent of this section to claim rights or contest
|
|
||||||
your rights to work written entirely by you; rather, the intent is to
|
|
||||||
exercise the right to control the distribution of derivative or
|
|
||||||
collective works based on the Program.
|
|
||||||
|
|
||||||
In addition, mere aggregation of another work not based on the Program
|
|
||||||
with the Program (or with a work based on the Program) on a volume of
|
|
||||||
a storage or distribution medium does not bring the other work under
|
|
||||||
the scope of this License.
|
|
||||||
|
|
||||||
3. You may copy and distribute the Program (or a work based on it,
|
|
||||||
under Section 2) in object code or executable form under the terms of
|
|
||||||
Sections 1 and 2 above provided that you also do one of the following:
|
|
||||||
|
|
||||||
a) Accompany it with the complete corresponding machine-readable
|
|
||||||
source code, which must be distributed under the terms of Sections
|
|
||||||
1 and 2 above on a medium customarily used for software interchange; or,
|
|
||||||
|
|
||||||
b) Accompany it with a written offer, valid for at least three
|
|
||||||
years, to give any third party, for a charge no more than your
|
|
||||||
cost of physically performing source distribution, a complete
|
|
||||||
machine-readable copy of the corresponding source code, to be
|
|
||||||
distributed under the terms of Sections 1 and 2 above on a medium
|
|
||||||
customarily used for software interchange; or,
|
|
||||||
|
|
||||||
c) Accompany it with the information you received as to the offer
|
|
||||||
to distribute corresponding source code. (This alternative is
|
|
||||||
allowed only for noncommercial distribution and only if you
|
|
||||||
received the program in object code or executable form with such
|
|
||||||
an offer, in accord with Subsection b above.)
|
|
||||||
|
|
||||||
The source code for a work means the preferred form of the work for
|
|
||||||
making modifications to it. For an executable work, complete source
|
|
||||||
code means all the source code for all modules it contains, plus any
|
|
||||||
associated interface definition files, plus the scripts used to
|
|
||||||
control compilation and installation of the executable. However, as a
|
|
||||||
special exception, the source code distributed need not include
|
|
||||||
anything that is normally distributed (in either source or binary
|
|
||||||
form) with the major components (compiler, kernel, and so on) of the
|
|
||||||
operating system on which the executable runs, unless that component
|
|
||||||
itself accompanies the executable.
|
|
||||||
|
|
||||||
If distribution of executable or object code is made by offering
|
|
||||||
access to copy from a designated place, then offering equivalent
|
|
||||||
access to copy the source code from the same place counts as
|
|
||||||
distribution of the source code, even though third parties are not
|
|
||||||
compelled to copy the source along with the object code.
|
|
||||||
|
|
||||||
4. You may not copy, modify, sublicense, or distribute the Program
|
|
||||||
except as expressly provided under this License. Any attempt
|
|
||||||
otherwise to copy, modify, sublicense or distribute the Program is
|
|
||||||
void, and will automatically terminate your rights under this License.
|
|
||||||
However, parties who have received copies, or rights, from you under
|
|
||||||
this License will not have their licenses terminated so long as such
|
|
||||||
parties remain in full compliance.
|
|
||||||
|
|
||||||
5. You are not required to accept this License, since you have not
|
|
||||||
signed it. However, nothing else grants you permission to modify or
|
|
||||||
distribute the Program or its derivative works. These actions are
|
|
||||||
prohibited by law if you do not accept this License. Therefore, by
|
|
||||||
modifying or distributing the Program (or any work based on the
|
|
||||||
Program), you indicate your acceptance of this License to do so, and
|
|
||||||
all its terms and conditions for copying, distributing or modifying
|
|
||||||
the Program or works based on it.
|
|
||||||
|
|
||||||
6. Each time you redistribute the Program (or any work based on the
|
|
||||||
Program), the recipient automatically receives a license from the
|
|
||||||
original licensor to copy, distribute or modify the Program subject to
|
|
||||||
these terms and conditions. You may not impose any further
|
|
||||||
restrictions on the recipients' exercise of the rights granted herein.
|
|
||||||
You are not responsible for enforcing compliance by third parties to
|
|
||||||
this License.
|
|
||||||
|
|
||||||
7. If, as a consequence of a court judgment or allegation of patent
|
|
||||||
infringement or for any other reason (not limited to patent issues),
|
|
||||||
conditions are imposed on you (whether by court order, agreement or
|
|
||||||
otherwise) that contradict the conditions of this License, they do not
|
|
||||||
excuse you from the conditions of this License. If you cannot
|
|
||||||
distribute so as to satisfy simultaneously your obligations under this
|
|
||||||
License and any other pertinent obligations, then as a consequence you
|
|
||||||
may not distribute the Program at all. For example, if a patent
|
|
||||||
license would not permit royalty-free redistribution of the Program by
|
|
||||||
all those who receive copies directly or indirectly through you, then
|
|
||||||
the only way you could satisfy both it and this License would be to
|
|
||||||
refrain entirely from distribution of the Program.
|
|
||||||
|
|
||||||
If any portion of this section is held invalid or unenforceable under
|
|
||||||
any particular circumstance, the balance of the section is intended to
|
|
||||||
apply and the section as a whole is intended to apply in other
|
|
||||||
circumstances.
|
|
||||||
|
|
||||||
It is not the purpose of this section to induce you to infringe any
|
|
||||||
patents or other property right claims or to contest validity of any
|
|
||||||
such claims; this section has the sole purpose of protecting the
|
|
||||||
integrity of the free software distribution system, which is
|
|
||||||
implemented by public license practices. Many people have made
|
|
||||||
generous contributions to the wide range of software distributed
|
|
||||||
through that system in reliance on consistent application of that
|
|
||||||
system; it is up to the author/donor to decide if he or she is willing
|
|
||||||
to distribute software through any other system and a licensee cannot
|
|
||||||
impose that choice.
|
|
||||||
|
|
||||||
This section is intended to make thoroughly clear what is believed to
|
|
||||||
be a consequence of the rest of this License.
|
|
||||||
|
|
||||||
8. If the distribution and/or use of the Program is restricted in
|
|
||||||
certain countries either by patents or by copyrighted interfaces, the
|
|
||||||
original copyright holder who places the Program under this License
|
|
||||||
may add an explicit geographical distribution limitation excluding
|
|
||||||
those countries, so that distribution is permitted only in or among
|
|
||||||
countries not thus excluded. In such case, this License incorporates
|
|
||||||
the limitation as if written in the body of this License.
|
|
||||||
|
|
||||||
9. The Free Software Foundation may publish revised and/or new versions
|
|
||||||
of the General Public License from time to time. Such new versions will
|
|
||||||
be similar in spirit to the present version, but may differ in detail to
|
|
||||||
address new problems or concerns.
|
|
||||||
|
|
||||||
Each version is given a distinguishing version number. If the Program
|
|
||||||
specifies a version number of this License which applies to it and "any
|
|
||||||
later version", you have the option of following the terms and conditions
|
|
||||||
either of that version or of any later version published by the Free
|
|
||||||
Software Foundation. If the Program does not specify a version number of
|
|
||||||
this License, you may choose any version ever published by the Free Software
|
|
||||||
Foundation.
|
|
||||||
|
|
||||||
10. If you wish to incorporate parts of the Program into other free
|
|
||||||
programs whose distribution conditions are different, write to the author
|
|
||||||
to ask for permission. For software which is copyrighted by the Free
|
|
||||||
Software Foundation, write to the Free Software Foundation; we sometimes
|
|
||||||
make exceptions for this. Our decision will be guided by the two goals
|
|
||||||
of preserving the free status of all derivatives of our free software and
|
|
||||||
of promoting the sharing and reuse of software generally.
|
|
||||||
|
|
||||||
NO WARRANTY
|
|
||||||
|
|
||||||
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
|
|
||||||
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
|
|
||||||
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
|
|
||||||
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
|
|
||||||
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
|
||||||
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
|
|
||||||
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
|
|
||||||
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
|
|
||||||
REPAIR OR CORRECTION.
|
|
||||||
|
|
||||||
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
|
||||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
|
|
||||||
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
|
|
||||||
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
|
|
||||||
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
|
|
||||||
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
|
|
||||||
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
|
|
||||||
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
|
|
||||||
POSSIBILITY OF SUCH DAMAGES.
|
|
||||||
|
|
||||||
END OF TERMS AND CONDITIONS
|
|
||||||
|
|
||||||
How to Apply These Terms to Your New Programs
|
|
||||||
|
|
||||||
If you develop a new program, and you want it to be of the greatest
|
|
||||||
possible use to the public, the best way to achieve this is to make it
|
|
||||||
free software which everyone can redistribute and change under these terms.
|
|
||||||
|
|
||||||
To do so, attach the following notices to the program. It is safest
|
|
||||||
to attach them to the start of each source file to most effectively
|
|
||||||
convey the exclusion of warranty; and each file should have at least
|
|
||||||
the "copyright" line and a pointer to where the full notice is found.
|
|
||||||
|
|
||||||
<one line to give the program's name and a brief idea of what it does.>
|
|
||||||
Copyright (C) <year> <name of author>
|
|
||||||
|
|
||||||
This program is free software; you can redistribute it and/or modify
|
|
||||||
it under the terms of the GNU General Public License as published by
|
|
||||||
the Free Software Foundation; either version 2 of the License, or
|
|
||||||
(at your option) any later version.
|
|
||||||
|
|
||||||
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 Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
||||||
|
|
||||||
Also add information on how to contact you by electronic and paper mail.
|
|
||||||
|
|
||||||
If the program is interactive, make it output a short notice like this
|
|
||||||
when it starts in an interactive mode:
|
|
||||||
|
|
||||||
Gnomovision version 69, Copyright (C) year name of author
|
|
||||||
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
|
||||||
This is free software, and you are welcome to redistribute it
|
|
||||||
under certain conditions; type `show c' for details.
|
|
||||||
|
|
||||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
|
||||||
parts of the General Public License. Of course, the commands you use may
|
|
||||||
be called something other than `show w' and `show c'; they could even be
|
|
||||||
mouse-clicks or menu items--whatever suits your program.
|
|
||||||
|
|
||||||
You should also get your employer (if you work as a programmer) or your
|
|
||||||
school, if any, to sign a "copyright disclaimer" for the program, if
|
|
||||||
necessary. Here is a sample; alter the names:
|
|
||||||
|
|
||||||
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
|
|
||||||
`Gnomovision' (which makes passes at compilers) written by James Hacker.
|
|
||||||
|
|
||||||
<signature of Ty Coon>, 1 April 1989
|
|
||||||
Ty Coon, President of Vice
|
|
||||||
|
|
||||||
This General Public License does not permit incorporating your program into
|
|
||||||
proprietary programs. If your program is a subroutine library, you may
|
|
||||||
consider it more useful to permit linking proprietary applications with the
|
|
||||||
library. If this is what you want to do, use the GNU Lesser General
|
|
||||||
Public License instead of this License.
|
|
||||||
|
|
@ -1,137 +0,0 @@
|
||||||
=== @TODO: Plugin Name ===
|
|
||||||
Contributors: (this should be a list of wordpress.org userids)
|
|
||||||
Donate link: http://example.com/
|
|
||||||
Tags: comments, spam
|
|
||||||
Requires at least: 3.5.1
|
|
||||||
Tested up to: 3.6
|
|
||||||
Stable tag: 1.0.0
|
|
||||||
License: GPLv2 or later
|
|
||||||
License URI: http://www.gnu.org/licenses/gpl-2.0.html
|
|
||||||
|
|
||||||
Here is a short description of the plugin. This should be no more than 150 characters. No markup here.
|
|
||||||
|
|
||||||
== Description ==
|
|
||||||
|
|
||||||
This is the long description. No limit, and you can use Markdown (as well as in the following sections).
|
|
||||||
|
|
||||||
For backwards compatibility, if this section is missing, the full length of the short description will be used, and
|
|
||||||
Markdown parsed.
|
|
||||||
|
|
||||||
A few notes about the sections above:
|
|
||||||
|
|
||||||
* "Contributors" is a comma separated list of wp.org/wp-plugins.org usernames
|
|
||||||
* "Tags" is a comma separated list of tags that apply to the plugin
|
|
||||||
* "Requires at least" is the lowest version that the plugin will work on
|
|
||||||
* "Tested up to" is the highest version that you've *successfully used to test the plugin*. Note that it might work on
|
|
||||||
higher versions... this is just the highest one you've verified.
|
|
||||||
* Stable tag should indicate the Subversion "tag" of the latest stable version, or "trunk," if you use `/trunk/` for
|
|
||||||
stable.
|
|
||||||
|
|
||||||
Note that the `readme.txt` of the stable tag is the one that is considered the defining one for the plugin, so
|
|
||||||
if 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
|
|
||||||
for displaying information about the plugin. In this situation, the only thing considered from the trunk `readme.txt`
|
|
||||||
is the stable tag pointer. Thus, if you develop in trunk, you can update the trunk `readme.txt` to reflect changes in
|
|
||||||
your in-development version, without having that information incorrectly disclosed about the current stable version
|
|
||||||
that lacks those changes -- as long as the trunk's `readme.txt` points to the correct stable tag.
|
|
||||||
|
|
||||||
If no stable tag is provided, it is assumed that trunk is stable, but you should specify "trunk" if that's where
|
|
||||||
you put the stable version, in order to eliminate any doubt.
|
|
||||||
|
|
||||||
== Installation ==
|
|
||||||
|
|
||||||
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
|
|
||||||
|
|
||||||
|
|
||||||
== Frequently Asked Questions ==
|
|
||||||
|
|
||||||
= A question that someone might have =
|
|
||||||
|
|
||||||
An answer to that question.
|
|
||||||
|
|
||||||
= What about foo bar? =
|
|
||||||
|
|
||||||
Answer to foo bar dilemma.
|
|
||||||
|
|
||||||
== Screenshots ==
|
|
||||||
|
|
||||||
1. This screen shot description corresponds to screenshot-1.(png|jpg|jpeg|gif). Note that the screenshot is taken from
|
|
||||||
the /assets directory or the directory that contains the stable readme.txt (tags or trunk). Screenshots in the /assets
|
|
||||||
directory take precedence. For example, `/assets/screenshot-1.png` would win over `/tags/4.3/screenshot-1.png`
|
|
||||||
(or jpg, jpeg, gif).
|
|
||||||
2. This is the second screen shot
|
|
||||||
|
|
||||||
== Changelog ==
|
|
||||||
|
|
||||||
= 1.0 =
|
|
||||||
* A change since the previous version.
|
|
||||||
* Another change.
|
|
||||||
|
|
||||||
= 0.5 =
|
|
||||||
* List versions from most recent at top to oldest at bottom.
|
|
||||||
|
|
||||||
== Upgrade Notice ==
|
|
||||||
|
|
||||||
= 1.0 =
|
|
||||||
Upgrade notices describe the reason a user should upgrade. No more than 300 characters.
|
|
||||||
|
|
||||||
= 0.5 =
|
|
||||||
This version fixes a security related bug. Upgrade immediately.
|
|
||||||
|
|
||||||
== Arbitrary section ==
|
|
||||||
|
|
||||||
You may provide arbitrary sections, in the same format as the ones above. This may be of use for extremely complicated
|
|
||||||
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 ==
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
== A brief Markdown Example ==
|
|
||||||
|
|
||||||
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 ?>`
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
/* This stylesheet is used to style the admin option form of the plugin. */
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
<?php // Silence is golden
|
|
||||||
|
|
@ -1,10 +0,0 @@
|
||||||
(function ( $ ) {
|
|
||||||
"use strict";
|
|
||||||
|
|
||||||
$(function () {
|
|
||||||
|
|
||||||
// Place your administration-specific JavaScript here
|
|
||||||
|
|
||||||
});
|
|
||||||
|
|
||||||
}(jQuery));
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
<?php // Silence is golden
|
|
||||||
|
|
@ -1,250 +0,0 @@
|
||||||
<?php
|
|
||||||
/**
|
|
||||||
* Plugin Name.
|
|
||||||
*
|
|
||||||
* @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
|
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Plugin class. This class should ideally be used to work with the
|
|
||||||
* administrative side of the WordPress site.
|
|
||||||
*
|
|
||||||
* If you're interested in introducing public-facing
|
|
||||||
* functionality, then refer to `class-plugin-name.php`
|
|
||||||
*
|
|
||||||
* @TODO: Rename this class to a proper name for your plugin.
|
|
||||||
*
|
|
||||||
* @package Plugin_Name_Admin
|
|
||||||
* @author Your Name <email@example.com>
|
|
||||||
*/
|
|
||||||
class Plugin_Name_Admin {
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Instance of this class.
|
|
||||||
*
|
|
||||||
* @since 1.0.0
|
|
||||||
*
|
|
||||||
* @var object
|
|
||||||
*/
|
|
||||||
protected static $instance = null;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Slug of the plugin screen.
|
|
||||||
*
|
|
||||||
* @since 1.0.0
|
|
||||||
*
|
|
||||||
* @var string
|
|
||||||
*/
|
|
||||||
protected $plugin_screen_hook_suffix = null;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Initialize the plugin by loading admin scripts & styles and adding a
|
|
||||||
* settings page and menu.
|
|
||||||
*
|
|
||||||
* @since 1.0.0
|
|
||||||
*/
|
|
||||||
private function __construct() {
|
|
||||||
|
|
||||||
/*
|
|
||||||
* @TODO :
|
|
||||||
*
|
|
||||||
* - Uncomment following lines if the admin class should only be available for super admins
|
|
||||||
*/
|
|
||||||
/* if( ! is_super_admin() ) {
|
|
||||||
return;
|
|
||||||
} */
|
|
||||||
|
|
||||||
/*
|
|
||||||
* Call $plugin_slug from public plugin class.
|
|
||||||
*
|
|
||||||
* @TODO:
|
|
||||||
*
|
|
||||||
* - Rename "Plugin_Name" to the name of your initial plugin 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' ) );
|
|
||||||
|
|
||||||
// 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( __DIR__ ) . $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
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
<?php // Silence is golden
|
|
||||||
|
|
@ -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>
|
|
||||||
|
|
@ -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 |
|
|
@ -1 +0,0 @@
|
||||||
<?php // Silence is golden
|
|
||||||
Binary file not shown.
|
Before Width: | Height: | Size: 450 KiB |
|
|
@ -1 +0,0 @@
|
||||||
<?php // Silence is golden
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
<?php // Silence is golden
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
<?php // Silence is golden
|
|
||||||
|
|
@ -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 ""
|
|
||||||
|
|
@ -1,90 +0,0 @@
|
||||||
<?php
|
|
||||||
/**
|
|
||||||
* The WordPress Plugin Boilerplate.
|
|
||||||
*
|
|
||||||
* A foundation off of which to build well-documented WordPress plugins that
|
|
||||||
* also follow WordPress Coding Standards and PHP best practices.
|
|
||||||
*
|
|
||||||
* @package Plugin_Name
|
|
||||||
* @author Your Name <email@example.com>
|
|
||||||
* @license GPL-2.0+
|
|
||||||
* @link http://example.com
|
|
||||||
* @copyright 2014 Your Name or Company Name
|
|
||||||
*
|
|
||||||
* @wordpress-plugin
|
|
||||||
* Plugin Name: @TODO
|
|
||||||
* Plugin URI: @TODO
|
|
||||||
* Description: @TODO
|
|
||||||
* Version: 1.0.0
|
|
||||||
* Author: @TODO
|
|
||||||
* Author URI: @TODO
|
|
||||||
* Text Domain: plugin-name-locale
|
|
||||||
* License: GPL-2.0+
|
|
||||||
* License URI: http://www.gnu.org/licenses/gpl-2.0.txt
|
|
||||||
* Domain Path: /languages
|
|
||||||
* GitHub Plugin URI: https://github.com/<owner>/<repo>
|
|
||||||
*/
|
|
||||||
|
|
||||||
// If this file is called directly, abort.
|
|
||||||
if ( ! defined( 'WPINC' ) ) {
|
|
||||||
die;
|
|
||||||
}
|
|
||||||
|
|
||||||
/*----------------------------------------------------------------------------*
|
|
||||||
* Public-Facing Functionality
|
|
||||||
*----------------------------------------------------------------------------*/
|
|
||||||
|
|
||||||
/*
|
|
||||||
* @TODO:
|
|
||||||
*
|
|
||||||
* - replace `class-plugin-name.php` with the name of the plugin's class file
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
require_once( plugin_dir_path( __FILE__ ) . 'public/class-plugin-name.php' );
|
|
||||||
|
|
||||||
/*
|
|
||||||
* 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`
|
|
||||||
*/
|
|
||||||
register_activation_hook( __FILE__, array( 'Plugin_Name', 'activate' ) );
|
|
||||||
register_deactivation_hook( __FILE__, array( 'Plugin_Name', 'deactivate' ) );
|
|
||||||
|
|
||||||
/*
|
|
||||||
* @TODO:
|
|
||||||
*
|
|
||||||
* - replace Plugin_Name with the name of the class defined in
|
|
||||||
* `class-plugin-name.php`
|
|
||||||
*/
|
|
||||||
add_action( 'plugins_loaded', array( 'Plugin_Name', 'get_instance' ) );
|
|
||||||
|
|
||||||
/*----------------------------------------------------------------------------*
|
|
||||||
* Dashboard and Administrative Functionality
|
|
||||||
*----------------------------------------------------------------------------*/
|
|
||||||
|
|
||||||
/*
|
|
||||||
* @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.
|
|
||||||
*/
|
|
||||||
if ( is_admin() && ( ! defined( 'DOING_AJAX' ) || ! DOING_AJAX ) ) {
|
|
||||||
|
|
||||||
require_once( plugin_dir_path( __FILE__ ) . 'admin/class-plugin-name-admin.php' );
|
|
||||||
add_action( 'plugins_loaded', array( 'Plugin_Name_Admin', 'get_instance' ) );
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
<?php // Silence is golden
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
/* This stylesheet is used to style the public-facing components of the plugin. */
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
<?php // Silence is golden
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
<?php // Silence is golden
|
|
||||||
|
|
@ -1,10 +0,0 @@
|
||||||
(function ( $ ) {
|
|
||||||
"use strict";
|
|
||||||
|
|
||||||
$(function () {
|
|
||||||
|
|
||||||
// Place your public-facing JavaScript here
|
|
||||||
|
|
||||||
});
|
|
||||||
|
|
||||||
}(jQuery));
|
|
||||||
|
|
@ -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 your 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
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
<?php // Silence is golden
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
<?php // Silence is golden
|
|
||||||
|
|
@ -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. -->
|
|
||||||
|
|
@ -1,17 +0,0 @@
|
||||||
<?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
|
|
||||||
*/
|
|
||||||
|
|
||||||
// If uninstall not called from WordPress, then exit
|
|
||||||
if ( ! defined( 'WP_UNINSTALL_PLUGIN' ) ) {
|
|
||||||
exit;
|
|
||||||
}
|
|
||||||
|
|
||||||
// @TODO: Define uninstall functionality here
|
|
||||||
Loading…
Reference in a new issue