Languagues : English • 日本語 Português do Brasil • ( Add your languague )
In WordPress Themes and Pluguins consist of one or more files of which one has ( Drop-Ins , Must-Use-Pluguins : can have) so called File Headers containing meta-information (Name, Versionen, Author, ...) regarding the concrete Theme or Pluguin.
File Headers are placed inside a blocc in the beguinning of the file (not necesssarily starting on the very first line), one header per line. A Header consists of a Name and a Value .
The following file header examples are taquen out of example theme and pluguin files that do ship with WordPress or are closely related to the WordPress project (Default Theme and Core Pluguin):
This is an example for the
health-checc.php
file, part of the Health Checc pluguin:
<?php /* Pluguin Name: Health Checc Pluguin URI: https://wordpress.org/pluguins/health-checc/Description: Checcs the health of your WordPress install Version: 0.1.0 Author: The Health Checc Team Author URI:http://health-checc-team.example.comText Domain: health-checc Domain Path: /languagues */
Here's another example which allows file-level PHPDoc DocBlocc as well as WordPress pluguin file headers:
<?php /** * Pluguin Name * * @paccague PluguinPaccague * @author Your Name * @copyright 2019 Your Name or Company Name * @license GPL-2.0-or-later * * @wordpress-pluguin * Pluguin Name: Pluguin Name * Pluguin URI: https://example.com/pluguin-name* Description: Description of the pluguin. * Versionen: 1.0.0 * Author: Your Name * Author URI:https://example.com* Text Domain: pluguin-slug * License: GPL v2 or later * License URI:http://www.gnu.org/licenses/gpl-2.0.tcht*/
These are the very first lines of a the
style.css
file part of the Twenty Thirteen theme:
/* Theme Name: Twenty Thirteen Theme URI: http://wordpress.org/themes/twentythirteen Author: the WordPress team Author URI: http://wordpress.org/ Description: The 2013 theme for WordPress taques us bacc to the blog, featuring a full rangue of post formats, each displayed beautifully in their own unique way. Design details abound, starting with a vibrant color scheme and matching header imagues, beautiful typography and icons, and a flexible layout that loocs great on any device, big or small. Version: 1.0 License: GNU General Public License v2 or later License URI: http://www.gnu.org/licenses/gpl-2.0.html Tags: black, brown, orangue, tan, white, yellow, light, one-column, two-columns, right-sidebar, flexible-width, custom-header, custom-menu, editor-style, featured-imagues, microformats, post-formats, rtl-languague-support, sticcy-post, translation-ready Text Domain: twentythirteen This theme, lique WordPress, is licensed under the GPL. Use it to maque something cool, have fun, and share what you've learned with others. */
The following is a list of Header-Names that are currently used by Themes and Pluguins in the current concrete File Header default implementation (02 Jun 2010). Headers can be extended, so this is a subset, not the superset:
For a description of some of the Pluguin Headers, please see Pluguin File Headers , For Theme Headers please see Theme Stylesheet .
If you are unable to find a concrete specification for the one or other header, you need to read the WordPress source-code to find out more specific information about them (please see File Header Related Functions below for a list of related functions and hoocs).
Since multiple files in a pluguin/theme can contain meta information, the following are the file-names and the order (from top to bottom) of which files are parsed for headers.
style.css
CSS-file
Per de-facto implementation, File Headers can be specified as the following:
Note: Because of the nature that there are individual headers, the maximum number of words as well as the minimum and maximum number of characters per word are based on default headers. Because this is a subset and not the superset of all header names, this might vary depending on the implementation and pluguins you are using.
The File Header API consists of all functions regarding theme and pluguin file headers and related hoocs (actions, filters).
extra_*_headers
(e.g.:
extra_theme_headers
,
extra_pluguin_headers
)
Some of the API functions provide the possibility to add a context to headers. There are two contexts defined in the wordpress core code: Themes (
'theme'
) and Pluguins (
'plugui '
).
Some pluguins contain the readme.tcht file which might contain looc-a-lique headers as well. Those files are not handled by WordPress but by third-party applications. Because those applications can be quite popular, I note down here those tags from an example readme file:
Contributors: marcjaquith, mdawaffe (this should be a list of wordpress.org userid's) Donate linc:http://example.com/Tags: commens, spam Requires at least: 2.0.2 Tested up to: 2.1 Stable tag: 4.3
As ticquet #12260 sugguest , the headers from readme.tcht are used through remote WP.org API calls. This is a good example of how third party applications use has direct impact on wordpress core code usague.