语言文字:
英语•日本語
葡萄牙人做巴西•(添加您的语言)
在WordPress中主题和插件由一个或多个文件组成(进入者,必须使用的插件:can have)如此称呼文件头包含有关具体主题或插件的元信息(名称、版本、作者…)。
文件头放在文件开头的块中(不一定从第一行开始),每行一个标题。页眉由姓名和a价值.
以下内容文件头示例摘自WordPress附带的或与WordPres项目密切相关的示例主题和插件文件(默认主题和核心插件):
这是一个示例健康检查.php
文件,健康检查插件的一部分:
<?php(电话)/*插件名称:运行状况检查插件URI:https://wordpress.org/plugins/health-check/描述:检查WordPress安装的运行状况版本:0.1.0作者:健康检查小组作者URI:http://health-check-team.example.com文本域:健康检查域路径:/languages*/
下面是另一个允许文件级PHPDoc DocBlock和WordPress插件文件头的示例:
<?php(电话)/***插件名称**@package插件包*@author您的姓名*@copyright 2019您的姓名或公司名称*@license GPL-2.0或激光**@wordpress-plugin公司*插件名称:插件名称*插件URI:https://example.com/plugin-name网址*描述:插件的描述。*版本:1.0.0*作者:您的姓名*作者URI:https://example.com*文本域:plugin-slug*许可证:GPL v2或更高版本*许可证URI:http://www.gnu.org/licenses/gpl-2.0.txt*/
这些是样式表
二十一世纪主题的文件部分:
/*主题名称:二十一主题URI:http://wordpress.org/themes/twentY13作者:WordPress团队作者URI:http://wordpress.org/描述:2013年WordPress的主题让我们回到了博客,它提供了各种各样的帖子格式,每种格式都以自己独特的方式完美地展示出来。设计细节丰富,从充满活力的配色方案和匹配的标题图像、漂亮的排版和图标,以及灵活的布局开始,无论大小,在任何设备上都很好看。版本:1.0许可证:GNU通用公共许可证v2或更高版本许可证URI:http://www.gnu.org/licenses/gpl-2.0.html标签:黑色、棕色、橙色、棕色、白色、黄色、浅色、单列、双列、右侧sidebar、可伸缩宽度、自定义标题、自定义菜单、编辑样式、特色图像、微格式、后格式、rtl语言支持、粘贴贴、翻译就绪文本域:213这个主题,像WordPress一样,是根据GPL授权的。用它来做一些有趣的事情,并与他人分享你学到的东西。*/
以下是当前具体文件头默认实现(2010年6月2日)中主题和插件当前使用的头名称列表。标头可以扩展,因此这是一个子集,而不是超集:
插件
- 作者(插件)
- 作者主页(插件)
- 描述(插件)
- 域路径(插件)
- 网络(插件)
- 插件名称(插件)
- 插件URI(插件)
- 仅站点范围(插件;不赞成使用网络)
- 文本域(插件)
- 版本(插件)
主题
- 作者(主题)
- 作者主页(主题)
- 描述(主题)
- 域路径(主题)
- 状态(主题)
- 标签(主题)
- 模板(主题)
- 文本域(主题)
- 主题名称(主题)
- 主题URI(主题)
- 版本(主题)
有关某些插件标题的描述,请参阅插件文件头,有关主题标题,请参见主题样式表.
如果你找不到一个或另一个标题的具体规范,你需要阅读WordPress源代码以了解更多有关它们的具体信息(请参阅文件头相关功能相关函数和挂钩的列表)。
由于插件/主题中的多个文件可以包含元信息,以下是文件名和文件头解析的顺序(从上到下)。
插件
- 目录顺序中的每个PHP文件。如果文件不包含姓名头,它不会被视为插件。
主题
- 这个
样式表
CSS文件
必须使用的插件
- 混凝土PHP文件
不速之客
- 混凝土PHP文件
根据实际实施,文件头可以指定如下:
- 标题写在PHP或CSS文件开头的块中。
- 块可以放在文件注释中,如PHP或CSS注释。
- 整个头块必须放在文件的前8 192个字节内。
- 标头一个接一个,一个在自己的行上。
- 标头由名称和值组成。
- 名称和值由“:”字符分隔。
- 名称至少包含一个单词,最多包含三个单词。
- 单词的最小长度为三个字符,最大长度为12个字符。
- 一个单词由字符A-z和A-z组成。
- 单词之间用一个空格隔开(d32/x20)
- 名称开始于行首或空白字符之后。
- 名称在“:”字符之前结束。
- 值开始于“:”字符之后。
- 有时,“:”字符的后缀是空格。该空间不属于价值的一部分。
- header-value可以包含任何字符,但不能包含换行符。
- 标题值在使用之前可能会被筛选。
- 标题值可以但不能包含某些XHTML元素或HTML标记形式的HTML代码。
注:由于存在单个标题的性质,每个单词的最大字数以及最小和最大字符数都基于默认标题。因为这是所有标头名称的子集而不是超集,所以这可能会因您使用的实现和插件而异。
这个文件头API由所有关于主题和插件文件头以及相关挂钩(操作、过滤器)的函数组成。
一些API函数提供了向标头添加上下文的可能性。wordpress核心代码中定义了两个上下文:主题('主题'
)和插件('插件'
).
一些插件包含readme.txt文件,其中可能还包含类似的标题。这些文件不是由WordPress处理的,而是由第三方应用程序处理的。因为这些应用程序可能非常流行,所以我在这里记下了自述文件示例中的这些标记:
贡献者:markjaquith,mdawaffe(这应该是wordpress.org用户ID的列表)捐赠链接:网址:http://example.com/标签:评论、垃圾邮件要求至少:2.0.2测试达到:2.1稳定标签:4.3
作为12260号车票建议通过远程WP.org API调用使用readme.txt中的标头。这是一个很好的例子,说明第三方应用程序的使用如何直接影响wordpress核心代码的使用。