用Wordpress时间久了,也用过别人开发的各种插件和主题,有时候不由得好奇这些插件是如何开发出来的,自己也希望尝试开发一个简单的插件,一来学习点知识,二来实现自己一些特殊的需求。经过查阅各种资料,学习并总结了一些Wordpress 插件开发的方法。当然制作自己的插件也是要有基础的,你需要熟悉 WordPress 的基本功能,以及 PHP 编程。本文告诉你怎样把开发插件的理想付诸实施。
插件名
首先为自己的插件起一个独一无二的名字。在Wordpress Plugins 官网或者其他地方——Google或者百度先验证一下这个名字是不是独一无二的。另外根据名字含义得让别人明白你的插件是干什么的。
插件文件
创建一个PHP文件,起一个与插件名类似的文件名,避免与其他文件重名。至少需要一个php文件,同时还需要图片、CSS、JavaScript、语言(当然这些也可以没有)。
Readme文件
如果想将插件发布到http://wordpress.org/extend/plugins/, 必须在插件包中建立一个标准格式readme.txt文件. 格式参见http://wordpress.org/extend/plugins/about/readme.txt.
主页
为插件建立一个主页,用于介绍插件的功能、安装方法、使用说明、适用的WordPress版本、插件更新信息等。
文件Headers
插件的主文件顶部必须包括一个标准插件信息头。WordPress通过标准信息头识别插件的存在,并把她加入到控制面板的插件管理页面,这样插件才能激活,载入插件,并运行里面的函数;如果没有信息头,插件将无法激活和使用。标准信息插件头的格式为:
-
<?php
-
/*
-
Plugin Name: 插件名
-
Plugin URI: 插件的介绍或更新地址
-
Description: 插件描述
-
Version: 插件版本,例如 1.0
-
Author: 插件作者名称
-
Author URI: 插件作者的链接
-
License: A "Slug" license name e.g. GPL2
-
*/
-
?>
标准信息头至少要包括插件名称,这样WordPress才能识别你的插件。其他信息将显示在控制面板插件管理页面中。标准插件信息对各行顺序没有要求。
这样的升级机制能够正确地读出你的插件版本,建议你选择一个格式的版本号,不同版本之间,并坚持下去。例如,x.x中或x.x.x或xx.xx.xxx
注意:文件必须是 UTF-8 格式!
版权信息
通常我们还要在标准信息头中加入插件的许可证信息。大多数插件使用GPL或GPLCompatibleLicenses许可。如果使用GPL许可,要求插件中包含以下信息:
-
<?php
-
/* Copyright 年份 作者名 (email : 你的邮箱)
-
-
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 St, Fifth Floor, Boston, MA 02110-1301 USA
-
*/
-
?>
到此WordPress插件开发的前奏步骤已经准备就绪,之后就可以开始开发插件了,后文再讲。