millermedia/modern-wordpress

提供了一种现代面向对象的WordPress插件开发框架。

1.4.0 2018-01-29 16:20 UTC

README

此版本的框架已被位于此处的V2版本所取代

此"插件"提供了一个面向对象设计模式、启动类和API抽象的基础,使得WordPress插件的开发非常快速。它还提供了一些工具来自动生成新的插件资源并自动管理新的插件构建/发布。

文档

主要功能

  • 使用@注解简单地记录你的函数,让框架自动将其钩入核心。
  • 通过扩展启动你的插件、设置页面、小工具、文章类型等的基类来快速开发。
  • 使用命令行创建新的插件样式表、脚本、模板和PHP类。
  • 安全地添加对PHP库或其他WordPress插件的依赖,它们将被自动管理。
  • 轻松地将所有HTML保存在独立的可重用模板中,以保持主题覆盖能力。
  • 利用内置的任务运行器,轻松地将常规任务发送到由cron管理的队列中运行。
  • 为你的插件创建表,并让框架自动跟踪和更新它们在新的发布中的更改。
  • 使用单个命令构建新的发布包,你的所有插件文件都将自动进行版本控制。

如何开始

  1. 安装打包的插件及其依赖项

一旦你安装了WP CLI

$ wp plugin install https://github.com/Miller-Media/modern-wordpress/raw/master/builds/modern-framework-stable.zip --activate

注意:如果要将插件安装到多站点WordPress,请使用--activate-network而不是--activate来从命令行激活插件。

  1. 启用开发者模式

要启用开发者模式:在wp-content/plugins/modern-framework/目录中创建或编辑dev_config.php文件,并添加以下内容:

<?php
define( 'MODERN_WORDPRESS_DEV', TRUE );

创建新插件

通过使用WP CLI克隆和自定义样板插件来启动你自己的新插件的创建

$ wp mwp update-boilerplate
$ wp mwp create-plugin "Awesome New Plugin" --vendor="My Company" --author="My Name"

注意:使用WP CLI创建插件时,样板会自动根据你的插件详细信息进行自定义!

让它发挥作用

要开始编写新插件的功能,只需向./your-plugin-dir/classes/Plugin.php文件中添加方法,该方法可以使用@注解钩入WordPress。在某个时候,你可能会想将代码分离到单独的文件中,以保持逻辑上的组织。

你可以轻松地从WP CLI创建新的JavaScript模块、CSS样式表、HTML模板和PHP类。

$ wp mwp add-js myplugin-slug script-name
$ wp mwp add-css myplugin-slug stylesheet-name
$ wp mwp add-template myplugin-slug views/template-name
$ wp mwp add-class myplugin-slug New\Class

访问样板存储库,了解通过现代WordPress可以使用的开发工具。

分发

当你准备好构建您插件的新版本时,这也很简单。

$ wp mwp build-plugin myplugin-slug --version-update=minor

将包含您新版本的打包.zip文件将创建在您的插件/builds子目录中。这个zip文件可以用来在任何其他Wordpress网站上安装插件。

就这样。祝您玩得开心!

进一步阅读