Subscribe Via RSS170 Plugin Release and Promotion
Plugin Header Section
The plugin header section information will be displayed in the plugin’s directory as a quick reference for users and contains basic information the user can grasp at a glance.
The plugin header section contains basic information the user can grasp at a glance.
=== Plugin Name === Contributors: (a list of wordpress.org userid's) Donate link: http://example.com/ Tags: comments, spam Requires at least: 3.0.1 Tested up to: 3.4 Stable tag: 4.3 License: GPLv2 or later License URI: http://www.gnu.org/licenses/gpl-2.0.html A short description of the plugin.
As an example, here’s the bbPress plugin header.
=== bbPress === Contributors: matt, johnjamesjacoby, jmdodd Tags: forums, discussion, support, theme, akismet, multisite Requires at least: 3.5 Tested up to: 3.6 Stable tag: 2.3.2 License: GPLv2 or later License URI: http://www.gnu.org/licenses/gpl-2.0.html bbPress is forum software, made the WordPress way
1. Plugin Name
Obviously, the first line is the plugin’s full name. This must be wrapped in the six equal signs. This should be the same name as the title in your main plugin’s file header info.
1. Contributors
“Contributors” is a comma separated list of wp.org/wp-plugins.org usernames. Anyone who has contributed to the plugin should be listed here. You should use the WordPress.org contributor’s user name, the one linked to their WordPress.org profile. Don’t miss this opportunity to showcase your other work.
2. Donate Link
If you’re going to as for donations, just put a link here to your donate page or your PayPal donation URL.
3. Tags
“Tags” is a comma separated list of tags that apply to the plugin. Here you place the tags which will enable your plugin to be found through the repository’s search function. Using tags effectively makes it easy for people to find your plugin.
4. Requires at Least
“Requires at least” is the lowest WordPress version that the plugin will work on. This is the minimum requirement for your plugin.
5. Tested Up to
“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. Always test using the latest WordPress version.
6. Stable Tag
Stable tag should indicate the Subversion “tag” of the latest stable version, or “trunk,” if you use `/trunk/` for stable.
This is the current stable version of your plugin. This tag is important, it controls which version appears in the repository and is controlled from the readme.txt file of the trunk folder of your Subversion installation.
7. License
Your plugin must be compatible with the GNU General Public License v2, or later version. Just use the same license as WordPress, “GPLv2 or later.”
8. Short Description
One succinct sentence (max 150 characters) which sums up what your plugin does and why the user needs it. Will be displayed when searching the repository website and your WP Admin dashboard “Plugins” menu.
- If you do not add a short description the 150 characters are excerpted from the long description. Don’t rely on the text being pulled from the long description.
