WordPress插件设计

一、WordPress介绍

如果是Php开发的同学,或者对博客和CMS有一定了解的同学都知道这个,以下是百度的解释:

WordPress是一款个人博客系统,并逐步演化成一款内容管理系统软件,它是使用PHP语言和MySQL数据库开发的,用户可以在支持 PHP 和 MySQL数据库的服务器上使用自己的博客。WordPress有许多第三方开发的免费模板,安装方式简单易用。不过要做一个自己的模板,则需要你有一定的专业知识。比如你至少要懂的标准通用标记语言下的一个应用HTML代码、CSS、PHP等相关知识。WordPress官方支持中文版,同时有爱好者开发的第三方中文语言包,如wopus中文语言包。WordPress拥有成千上万个各式插件和不计其数的主题模板样式。 [1] https://baike.baidu.com/item/WordPress/450615?fr=aladdin

WordPress也是支持插件的,因为最近在做插件系统的设计,所以想分析下它的插件设计思想。

二、插件分析

关于一个支持插件的系统应该具备哪些功能,前文已有说明,有兴趣的同学可以查看:Discuz插件设计

先看下WordPress插件的基本结构:

WordPress插件都要放在wp-content/plugins目录下,每个插件为一个目录,每个目录下可以放readme.txt和LICENSE.txt等说明文件,然后有一个主文件,在上面官方的 akismet 插件中,主文件就是 akismet.php。

1、关于安装和反安装

WordPress中这两个概念比较淡,取而代之的是启用和禁用,因为默认插件是不启用的,反正只有一次执行机会,最终效果差不多,只要概念上保持一致。

register_activation_hook( __FILE__, array( 'Akismet', 'plugin_activation' ) );
register_deactivation_hook( __FILE__, array( 'Akismet', 'plugin_deactivation' ) );

启用是调用register_activation_hook函数,即注册钩子的方式实现;

禁用是调用register_deactivation_hook实现,原理同上。

当然也可以注册卸载的钩子:register_uninstall_hook

2、插件说明信息

这些通过在主文件的描述里表示:

*
Plugin Name: Akismet Anti-Spam
Plugin URI: https://akismet.com/
Description: Used by millions, Akismet is quite possibly the best way in the world to <strong>protect your blog from spam</strong>. It keeps your site protected even while you sleep. To get started: activate the Akismet plugin and then go to your Akismet Settings page to set up your API key.
Version: 4.1.5
Author: Automattic
Author URI: https://automattic.com/wordpress-plugins/
License: GPLv2 or later
Text Domain: akismet
*/

具体含义就不在这里说明了,总的来说实现还是比较简单的,这需要审核插件的人或者系统能自动审核出来,不然就尴尬了。

3、插件配置

可以在后台自己加菜单

add_action('admin_menu', 'display_copyright_menu');
add_options_page('Set Copyright', 'Copyright Menu', 'administrator','display_copyright', 'display_copyright_html_page');

function display_copyright_html_page(){
  //渲染页面逻辑
}

当然也可以在系统已经有设置界面里设置,可以参考函数 add_settings_field 。

4、注册api

想自己注册路由,在系统中添加新的api接口的话,WordPress也是支持的

add_rewrite_rule('post/([0-9a-zA-Z\-_,]+)/([0-9a-zA-Z\-_,]+)/page/?([0-9]{1,})/?$',
   'index.php?tag=$matches[1]&category_name=$matches[2]&paged=$matches[3]',
   'top');

5、多语言支持

需要手动调用

load_plugin_textdomain('your-unique-name', false, basename( dirname( __FILE__ ) ) . '/languages' );

6、定制系统行为

系统已经定义了许多action和filter,如果对其中的某个点比较感兴趣,可以注册自己的回调。

add_action( 'wp_insert_comment', array( 'Akismet', 'auto_check_update_meta' ), 10, 2 );
add_filter( 'preprocess_comment', array( 'Akismet', 'auto_check_comment' ), 1 );
add_filter( 'rest_pre_insert_comment', array( 'Akismet', 'rest_auto_check_comment' ), 1 );

这里说下action和filter的概念 ,这2个是WordPress中使用最多的钩子,最终实现机制差不多,都是先声明,然后在代码中使用的地方调用相关回调/钩子,最后插件可以针对自己感兴趣的action/filter注册相关的回调。

再来说下两者在语义上的区别,action是实现一些额外的逻辑,而filter可能不产生新逻辑,只是在原有内容/结果上做一些过滤。

这么说可能比较抽象,我们举一些例子,如果我们实现了一个站内信的插件,希望在发完帖子之后给用户发送一条站内信,那这个最好用action的方式实现;

如果发完帖子之后我们想做下XSS检查,那最好是以filter的方式实现。

三、整体感受

整体来说,WordPress的插件做的是比较灵活的,通过观察者模式,通过钩子回调的方式,让插件可以快速、简单的关注自己感兴趣的扩充点,做到处处可扩展。

这需要系统设计者从全局去考虑系统有多少可以扩充的点,如果没有好的规范和监管,很可能会滥用,也有可能带来安全问题。

另外也增加开发者的维护成本,因为系统多少扩充点,如果没有很好的文档,那只能自己去搜索或者看源代码了。

当然这是一个权衡的考虑,在灵活性和稳定性如何选择,需要自己根据条件去做选择。

另外WordPress后台所有插件的代码都是可以编辑的,这就要求对代码目录开放写权限,这个很容易带来安全问题。

本文分享自微信公众号 - 程序员升级之路(gh_1fab42db66cb),作者:刘江华

原文出处及转载信息见文内详细说明,如有侵权,请联系 yunjia_community@tencent.com 删除。

原始发表时间:2020-07-18

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • Discuz插件设计

    Discuz是国内比较知名的开源论坛了,后来被腾讯收购,Discuz在设计时就考虑了生态体系的建设,支持插件设计,可以让广大开发者朋友来一起建设生态,不得不说设...

    心平气和
  • RabbitMQ网络框架代码分析二:命令分发

    前面讲了基本的网络框架,说了一个连接进来会经过哪些文件,RabbitMQ网络框架代码分析,今天会讲消息的具体的处理过程,即一条消息过来,最终是如何分发到具体的处...

    心平气和
  • Codis Proxy初始化篇

    这篇文章会重点讲述Codis Proxy的初始化,即启动的过程,其实也不完全是Codis Proxy的初始化,应该说是Codis面向用户请求链路的初始化,即经过...

    心平气和
  • Vim安装插件管理器Vundle

    1) 在Github上vim-scripts用户下的仓库,只需要写出repos(仓库)名称 2) 在Github其他用户下的repos, 需要写出"用户名/re...

    宋天伦
  • 记录如何提交WordPress插件到WordPress官方插件平台流程

    前一段时间,老蒋在管理客户网站过程中由于图片太多且占用服务器的资源,所以希望将图片资源独立至阿里云OSS存储中,但是搜寻到网上已有的插件有一些问题,比如不能独立...

    老蒋
  • WP插件 Antivirus 汉化版 —— 免受后门主题的困扰

    AntiVirus,一款扫描当前使用主题可能存在恶意代码的WordPress插件,主要扫描主题模板中存在的不知名代码和加密代码。扫描后将结果给出供管理员手动判断...

    神无月
  • 《掘金》相信优质技术内容的力量

    掘金App的开屏语是相信技术的力量, 社区的内容也非常优质, 掘金氛围比较开放,也会把其它平台优质的内容推荐给用户, 而掘金的插件就是一个很好的优质内容推荐工具

    zhaoolee
  • golang插件化方案

    业务线的活动,每一次新活动都做独立项目开发,有大量重复代码,并且浪费数据服务的连接资源;排序服务也许要经常添加业务代码,目前是停服务发布……这些场景为了开发维护...

    李海彬
  • 建立生态系统|Backstage插件市场现已开放

    优秀的开发人员体验能培养出快乐的、有创造力的、高效的工程师。我们认为,工程师不必成为各种基础架构工具或学科(例如,机器学习或后端)的专家就可以高效地工作。基础设...

    CNCF
  • php把文件设置为插件的技巧方法

    插件,亦即Plug-in,是指一类特定的功能模块(通常由第三方开发者实现),它的特点是:当你需要它的时候激活它,不需要它的时候禁用/删除它;且无 论是激活还是禁...

    砸漏

扫码关注云+社区

领取腾讯云代金券