如何制作出色的 WP 插件一(注释篇)

一款 WordPress 插件(外挂),如果写得好,就不会与其他插件或主题发生冲突。如果写的烂,就会造成极大的破坏性。如何制作一款出色的、与时俱进的 WP 插件,本系列教程将为您一一道来。

读前须知

本系列教程仅对 PHP 有所了解之人所写,如您不会 PHP,建议先去学习 PHP 的相关基础,然后再阅读即可。

写前须知

  • WP 插件个根目录在 wp-content/plugins 中(mu-plugin 番外篇另介绍)。
  • 您的 WP 插件目录在 wp-content/plugins/my-plugin 中(my-plugin 是您的插件目录名称)。
  • 您的插件目录不需与插件文件同名。如 my-plugin/you-plugin.php 这样也是可以的。
  • WP 会扫描您的插件目录下的 PHP 文件,因此在您的插件目录下应只放一个 PHP 文件,以免出现非预期情况。
  • WP 第一次启用插件会使用一个 iframe 框架来验证插件是否会出错,若出错,将不会被启用。但一旦成功启用后,插件出错,会导致全站出现非预期情况发生。

开始架构插件目录

编写注释之前,您应该建立您的插件目录,为了方便调试,您可在一个测试的 WP 插件跟目录里面,建立一个名为“my-plugin”的目录,并在里面建立一个名为“my-plugin.php”的文件作为插件执行文件。(此处有进阶,留意本文进阶篇)

开始编写注释

编写注释,建议使用本文提供的注释模板,如下:

<?php

// Plugin Name: 「您的插件名称,例如 “INN 的插件”」
// Plugin URI: 「您的插件主页,例如“https://inn-studio.com/ao”」
// Description: 「您的插件描述,例如“INN 的插件描述”」
// Author: 「您的插件作者名称,例如“Km.Van”」
// Author URI: 「您的插件作者主页,注意不能与插件主页相同(否则可能无法通过 WP 插件市场审核),例如“https://inn-studio.com”」
// Version: 「您的插件版本,例如“1.0.0”」
// PHP Required:「 您的插件所需最低的 PHP 版本,例如 “7.3.0”」

以上是 INN STUDIO 所推荐的插件注释模板,在这里可能会有读者会问许多问题,例如:为什么没有“Domain”语言一项?插件名称如何根据不同的 WP 语言设置显示相应的语言?不要着急,这类问题将会在以后的《性能篇》得到解答,此处先留一处伏笔

完成编写

此时,您的插件文件内容应只有上述注释模板的内容,由于没有任何 PHP 执行代码,插件启用后(启用前先保存文件内容),将没有产生任何效果,仅作为花瓶观赏。但相信您已离大师更进一步了。

更多的后续内容,请留意后续相关系列更新。

进阶篇:架构出色的插件目录

上述提到,您的插件目录可设置为“my-plugin/my-plugin.php”这样的形式,这种设定是正确的,但不够出色!一款出色的插件目录,应该能从目录名中表达出插件的主要信息。

假设此处作者想要制作一款能根据浏览器来显示不同的标语的插件,可以将插件目录命名为“InnBrowserSlogan/InnBrowserSlogan.php”(驼峰命名),英文直译意思为“INN STUDIO 浏览器标语”,其中 INN 则为本站,Browser 则为浏览器,Slogan 则为标语。

当然您也可以命名为“inn-browser-slogan/inn-browser-slogan.php”,至于为什么要使用驼峰命名,此处会关系到 PHP 的相关标准,将会在以后的相关篇章作为解答。

热门评论
© INN STUDIO