abhishek-pokhriyal/wp-plugin-boilerplate

用于创建WordPress插件的模板。

维护者

详细信息

github.com/ColoredCow/wp-plugin-boilerplate

源代码

问题

安装: 9

依赖: 0

建议: 0

安全: 0

星标: 2

关注者: 4

分支: 0

开放问题: 4

类型:wordpress-plugin

1.2.0 2020-09-22 13:44 UTC

Requires

  • php: ^7.2

GPL-3.0-or-later fab9950f53a4702a72ab9720ab3a0b67ee7ce380

  • abhishek-pokhriyal <pokhi.woop@coloredcow.com>

This package is auto-updated.

Last update: 2024-09-09 13:06:32 UTC

README

使用Grunt进行快速资源编译创建WordPress插件的模板。

先决条件

  1. NPM
  2. Grunt

安装与开始

通过 composer

  1. 在您的插件（空）根目录中，创建一个 composer.json 文件，并将以下内容粘贴到其中。

    {
  "require": {
    "composer/installers": "1.9.0",
    "abhishek-pokhriyal/wp-plugin-boilerplate": "^1.0"
  },
  "extra": {
    "installer-paths": {
    "./" : ["abhishek-pokhriyal/wp-plugin-boilerplate"]
    }
  }
}

  2. 运行 composer install。这将把模板代码放入插件的根目录（它也将覆盖之前步骤中创建的 composer.json 文件的内容。）

手动

  1. 在您的 wp-content/plugins/ 目录内克隆仓库。

    git clone https://github.com/abhishek-pokhriyal/wp-plugin-boilerplate.git

  2. 根据您的插件名称重命名文件和变量名。

    1. 查找并替换以下名称

    2. 将包含 wp-plugin-boilerplate 的文件重命名为 my-plugin-name

  3. 如果涉及任何资源开发/更改，请遵循 资源构建步骤。

  4. 如果您的插件不需要Bootstrap，您可以从 assets/css 目录中删除 bootstrap 和 utilities 目录，并从 style.scss 中移除所有包含bootstrap的导入。

  5. 现在，您可以为开发做准备。

资源构建步骤

  1. 进入插件根目录的 cd

  2. 安装node依赖项

    npm install

  3. 生成编译和压缩文件，运行

    grunt

  4. 在开发过程中生成编译和压缩文件（每次按下 CMD + S 时），运行

    grunt watch

插件结构

+-- assets/
|   +-- css/
|       +-- bootstrap/
|       +-- utilities/
|   +-- js/
|       +-- admin/
|       +-- frontend/
|
+-- includes/
|   +-- class-wp-plugin-boilerplate.php
|
+-- node_modules/
+-- .eslintignore
+-- .eslintrc.js
+-- .gitignore
+-- Gruntfile.js
+-- license.txt
+-- package-lock.json
+-- package.json
+-- README.md
+-- wp-plugin-boilerplate.php

许可证

WordPress Plugin BoilerPlate是在GPLv3许可证下发布的。