插件基础

本文讲述内容

  • 什么是插件
  • 为什么我们制作插件
  • 最简单的插件
  • 插件基本认识

什么是插件

插件是扩展WordPress核心功能的代码包。WordPress插件由PHP代码和其他资源(例如图像,CSS和JavaScript)组成。

通过制作自己的插件,您可以扩展 WordPress,即在WordPress已经提供的功能之上构建其他功能。例如,您可以编写一个插件,该插件显示指向您网站上最近十篇文章的链接。

或者,使用WordPress的自定义帖子类型,您可以编写一个插件,使用电子邮件通知,自定义票证状态和面向客户的门户创建功能全面的支持票证系统。无限的可能性!

大多数WordPress插件由许多文件组成,但是一个插件实际上只需要一个主文件,文件头中具有特定格式的DocBlock

Hello Dolly是最早的插件之一,只有  82行  。Hello Dolly 在WordPress管理员中显示著名歌曲的歌词。PHP文件中使用了一些CSS来控制歌词的样式。

为什么我们制作插件

如果WordPress开发中有一条基本规则,那就是:不要触碰WordPress核心。这意味着您无需编辑核心WordPress文件即可向网站添加功能。这是因为,当WordPress更新到新版本时,它会覆盖所有核心文件。因此,您要添加的所有功能都应使用批准的WordPress API通过插件添加。

WordPress插件可以根据您的需要而变简单或复杂。最简单的插件是单个PHP文件。所述喂多利插件是这样的插件的一个例子。插件PHP文件仅需要一个Plugin Header,几个PHP函数以及一些将函数附加到其上的钩子

插件可让您极大地扩展WordPress的功能,而无需接触WordPress核心本身。

最简单的插件

简单来说,WordPress插件是一个带有WordPress插件标头注释的PHP文件。强烈建议您创建一个目录来保存插件,以便将所有插件文件整齐地组织在一个位置。

要开始创建新插件,请按照以下步骤操作。

  1. 导航到WordPress安装的  wp-content目录。
  2. 打开插件目录。
  3. 创建一个新目录,并以插件命名(例如plugin-name)。
  4. 打开新插件的目录。
  5. 创建一个新的PHP文件(最好在您的插件后命名该文件,例如plugin-name.php)。

使用适合您的任何编辑器(对于任何代码编辑,使用一款专业的编程工具尤为重要)。

现在,您正在编辑新插件的PHP文件,您需要添加一个插件标题注释。这是一种特殊格式的PHP块注释,其中包含有关插件的元数据,例如其名称,作者,版本,许可证等。插件头注释必须符合头要求,并且至少应包含插件  的名称。插入。

插件文件夹中只有一个文件应具有标题注释-如果插件具有多个PHP文件,则这些文件中只有一个应具有标题注释。

<?php
/**
 * Plugin Name:你的插件名称
 */

保存文件后,您应该可以在WordPress网站中看到您的插件。

登录到你的WordPress网站,并在左侧导航窗格中点击插件。此页面显示您的WordPress网站具有的所有插件的列表。您的新插件现在应该在该列表中,如下图所示!

插件认识

标头要求

插件的主PHP文件应包含标题等插件注释,这些注释告诉WordPress文件是插件,并提供有关插件的信息。

最小字段

标题注释至少必须包含插件名称

<?php
/**
 * Plugin Name:你的插件名称
 */

标头字段

可用的标题字段:

  • Plugin Name:必需)你的插件,它会显示在WordPress管理的插件列表的名称。
  • Plugin URI: 插件的主页,应该是唯一的URL,最好在您自己的网站上。这对于您的插件必须是唯一的。您不能在此处使用WordPress.org URL。
  • Description:  插件的简短描述,如WordPress Admin的“插件”部分中所示。将此说明的字符数少于140个。
  • Version: 插件的当前版本号,例如1.0或1.0.3。
  • Requires at least: 该插件可以使用的最低WordPress版本。
  • Requires PHP:  所需的最低PHP版本。
  • Author:  插件作者的名称。可能使用逗号列出多个作者。
  • Author URI: 作者的网站或其他网站上的个人资料,例如WordPress.org。
  • License: 插件许可证(例如GPLv2)的简称。有关许可的更多信息,请参见WordPress.org指南
  • License URI: 指向许可证全文的链接(例如https://www.gnu.org/licenses/gpl-2.0.html)。
  • Text Domain: 插件的gettext文本域。有关更多信息,请参见如何国际化插件页面的“ 文本域”部分。
  • Domain Path: 域路径使WordPress知道在哪里可以找到翻译。有关更多信息,请参见“ 如何国际化插件”页面的“ 域路径”部分。
  • Network: 插件是否只能在整个网络范围内激活。只能设置为true,并且在不需要时应省略。

具有标题注释的有效PHP文件可能如下所示:

<?php
/**
 * Plugin Name:       My Basics Plugin
 * Plugin URI:        https://example.com/plugins/the-basics/
 * Description:       Handle the basics with this plugin.
 * Version:           1.10.3
 * Requires at least: 5.2
 * Requires PHP:      7.2
 * Author:            John Smith
 * Author URI:        https://author.example.com/
 * License:           GPL v2 or later
 * License URI:       https://www.gnu.org/licenses/gpl-2.0.html
 * Text Domain:       my-basics-plugin
 * Domain Path:       /languages
 */

这是另一个允许文件级PHPDoc DocBlock以及WordPress插件文件头的示例:

<?php
/**
 * Plugin Name
 *
 * @package           PluginPackage
 * @author            Your Name
 * @copyright         2019 Your Name or Company Name
 * @license           GPL-2.0-or-later
 *
 * @wordpress-plugin
 * Plugin Name:       Plugin Name
 * Plugin URI:        https://example.com/plugin-name
 * Description:       Description of the plugin.
 * Version:           1.0.0
 * Requires at least: 5.2
 * Requires PHP:      7.2
 * Author:            Your Name
 * Author URI:        https://example.com
 * Text Domain:       plugin-slug
 * License:           GPL v2 or later
 * License URI:       http://www.gnu.org/licenses/gpl-2.0.txt
 */
编号笔记

警报:在为项目分配版本号时,请记住WordPress使用PHP version_compare()函数比较插件的版本号。因此,在发布插件的新版本之前,应确保此PHP函数将新版本视为比旧版本“更大”。例如,1.02实际上大于1.1。 

包括软件许可证

大多数WordPress插件都是根据GPL发布的,该许可证与WordPress本身使用的许可证相同。但是,还有其他选项可用。始终最好明确指出您的插件使用的许可证。

标题要求部分中,我们简要提到了如何在插件标题注释中指示插件的许可证。另一个常见且鼓励的做法是在主插件文件(与具有插件标题注释的文件相同)的顶部附近放置一个许可证块注释。

该许可证块注释通常看起来像这样:

/*
{Plugin Name} 是免费软件:您可以重新分发和/或修改根据GNU发布的GNU通用公共许可的条款(自由软件基金会(许可的版本2),或任何更高版本)进行。
 
分发{插件名称}希望是有用的,但没有任何保证; 甚至没有默示担保特定目的的适销性或适用性。 见有关更多详细信息,请参见GNU通用公共许可证。
 
您应该已经收到了GNU通用公共许可证的副本以及{Plugin Name}。 如果不是,请参见 {URI to Plugin License}。
*/

与插件标头注释结合使用时:

<?php
/*
Plugin Name: WordPress.org Plugin
Plugin URI:  https://developer.wordpress.org/plugins/the-basics/
Description: Basic WordPress Plugin Header Comment
Version:     20160911
Author:      WordPress.org
Author URI:  https://developer.wordpress.org/
Text Domain: wporg
Domain Path: /languages
License:     GPL2
 
{Plugin Name} 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
any later version.
 
{Plugin Name} 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 {Plugin Name}. If not, see {License URI}.
*/

其他更多专业知识,请移步wordpress 官网创建制作专题

Scroll to Top