Header Requirements

Standard
[display-posts post_type="content" id="3672" include_content=true include_title=false wrapper="div" wrapper_class=""]

Header Requirements

As described in Getting Started, the header section of the plugin is one of the primary components that allows WordPress to recognize a file as a plugin.

At a minimum, a header can contain just a Plugin Name, but several pieces can – and usually should – be included:

  • Plugin Name: The name of your plugin, as displayed in the Plugins list in the WordPress Admin.
  • Plugin URI: The home page of the plugin, which might be on WordPress.org or on your own website.
  • Description: A short description of the plugin, as displayed in the Plugins section in the WordPress Admin. Keep this description to fewer than 140 characters.
  • Version: The current version number of the plugin, such as 1.0 or 1.0.3.
  • Author: The name of the plugin author. More than one author may be listed.
  • Author URI: The author’s website or profile on another website, such as WordPress.org.
  • License: The short name (slug) of the plugin’s license, e.g. GPL2. More information about licensing can be found in the WordPress.org guidelines.
  • License URI: A link to the license, e.g. https://www.gnu.org/licenses/gpl-2.0.html.
  • Text Domain: The gettext text domain of the plugin. More information can be found in the How to Internationalize your Plugin Text Domain section.
  • Domain Path: The domain path is used so that WordPress knows where to find the translations. More information can be found in the How to Internationalize your Plugin Domain Path section.

A valid header might look like this:

1
2
3
4
5
6
7
8
9
10
11
12
13
/*
Plugin Name: My Toolset
Description: This describes my plugin in a short sentence
Version: 1.5
Author: John Smith
License: GPL2
Domain Path: /languages
Text Domain: my-toolset
*/

The minimum requirement for a plugin header looks like this:

1
2
3
4
/*
Plugin Name: My Toolset
*/
 
Skip to toolbar