README

这是一个使用WP Emerge框架的现代WordPress启动插件。

这是WP Emerge启动插件项目 - 若要了解WP Emerge框架，请访问https://github.com/htmlburger/wpemerge。

摘要

文档
开发团队
比较表
功能
非目标
需求
目录结构
贡献

文档

http://docs.wpemerge.com/#/starter/plugin/overview

http://docs.wpemerge.com/#/starter/plugin/quickstart

开发团队

由Atanas Angelov 和htmlBurger的可爱团队提供。

比较表

¹ 已准备JavaScript文件，但它们未经过任何处理或转换。

² JavaScript文件仅进行压缩，未进行转换。

将任何事实性错误发送至hi@atanas.dev以便更正。

功能

包含WP Emerge的所有功能
- 具有自定义URL和查询过滤器的命名路由
- 控制器
- 中间件
- PSR-7响应
- 视图组合器
- 服务容器
- 服务提供者
- PHP视图布局（即自动包装）
- 支持PHP、Blade 5.4 和/或 Twig 2 用于视图
SASS + PostCSS 用于样式表。为前端和管理创建了单独的包，并且可以轻松添加自定义包。
ES6用于JavaScript。为前端和管理创建了单独的包，并且可以轻松添加自定义包。
使用纯Webpack转换和捆绑资源，创建精灵，优化图像等。
用于同步浏览器开发的热模块替换
为您的 MyApp\ 命名空间中的所有类启用自动加载。
为所有资源（包括在样式表中引用的资源）启用自动、无懈可击的缓存破坏。
使用单个yarn命令进行WPCS、JavaScript和SASS的linting和修复。
单命令可选CSS包安装
- Normalize.css
- Boostrap 4
- Bulma
- Foundation
- Tachyons
- Tailwind CSS
- Spectre.css
- FontAwesome
为您的自有类提供WP单元测试脚手架。

非目标

接管WordPress主查询。

WP Emerge不会接管主查询 - 它会积极与之协作。
接管WordPress路由。

WP Emerge不会接管WordPress的路由 - 它会积极与之协作。唯一例外是由用户显式添加的硬编码URL。
使用面向对象接口重新发明 WordPress API。

WP Emerge 并不提供注册文章类型、分类或类似功能的替代 API，以获得微小的附加收益。相反，它为开发者提供了使用核心 API 的逻辑和便捷位置。
默认使用第三方引擎。

WP Emerge 与 WordPress 以相同的方式使用 PHP，但增加了更多功能。使用第三方引擎完全是可选的，需要安装扩展。
包含 Laravel 或其他框架的大部分功能。

WP Emerge 轻量且针对 WordPress 进行优化。虽然受到 Laravel 的启发，但它不附带任何 illuminate/* 包。只有 2 个第三方生产依赖
- pimple/pimple - 单文件 PHP 服务容器。
- guzzlehttp/psr7 - PSR-7 请求和服务器请求实现。

需求

PHP >= 5.5
WordPress >= 4.7
Composer
Node.js >= 12
Yarn 或 NPM

目录结构

wp-content/plugins/your-plugin
├── app/
│   ├── helpers/              # Helper files, add your own here as well.
│   ├── routes/               # Register your WP Emerge routes.
│   │   ├── admin.php
│   │   ├── ajax.php
│   │   └── web.php
│   ├── src/                  # PSR-4 autoloaded classes.
│   │   ├── Controllers/      # Controller classes for WP Emerge routes.
│   │   ├── Routing/          # Register your custom routing conditions etc.
│   │   ├── View/             # Register your view composers, globals etc.
│   │   ├── WordPress/        # Register post types, taxonomies, menus etc.
│   │   └── ...
│   ├── config.php            # WP Emerge configuration.
│   ├── helpers.php           # Require your helper files here.
│   ├── hooks.php             # Register your actions and filters here.
│   └── version.php           # WP Emerge version handling.
├── dist/                     # Bundles, optimized images etc.
├── languages/                # Language files.
├── resources/
│   ├── build/                # Build process configuration.
│   ├── fonts/
│   ├── images/
│   ├── scripts/
│   │   ├── admin/            # Administration scripts.
│   │   └── frontend/         # Front-end scripts.
│   ├── styles/
│   │   ├── admin/            # Administration styles.
│   │   ├── frontend/         # Front-end styles.
│   │   └── shared/           # Shared styles.
│   └── vendor/               # Any third-party, non-npm assets.
├── vendor/                   # Composer packages.
├── views/
│   ├── layouts/
│   └── partials/
├── screenshot-1.png          # Plugin screenshot.
├── wpemerge                  # WP Emerge CLI shortcut.
├── wpemerge.php              # Bootstrap plugin.
└── ...

重要目录

`app/helpers/`

在此处添加 PHP 辅助文件。辅助文件应仅包含 函数定义。有关动作、过滤器、类等放置位置的信息，请参见下文。

`app/src/`

在此处添加 PHP 类文件。所有位于 MyApp\ 命名空间的类都根据 PSR-4 进行自动加载。

`resources/images/`

在此处添加用于样式的图片。在运行构建过程时，优化后的副本将放置在 dist/images/ 中。

`resources/styles/frontend/`

将 .css 和 .scss 文件添加到前端包中。别忘了在 index.scss 中 @import 它们。

`resources/styles/admin/`

与 resources/styles/frontend/ 目录工作方式相同的 admin 样式目录。

`resources/scripts/frontend/`

在此处添加 JavaScript 文件以将其添加到前端包中。入口点是 index.js。

`resources/scripts/admin/`

与 resources/scripts/frontend/ 目录工作方式相同的 admin 脚本目录。

`views/`

views/layouts/ - 其他视图扩展的布局。
views/partials/ - 旨在在其他视图中重复使用的较小片段。
views/ - 可能扩展布局并可能包含部分的全页视图。

请避免在这些视图中添加任何 PHP 逻辑，除非它与布局有关。业务逻辑应放入

辅助文件 (app/helpers/*.php)
服务类
WP Emerge 控制器

贡献

WP Emerge Starter 插件是完全开源的，我们鼓励每个人通过以下方式参与

审查 .github/CONTRIBUTING.md。
⭐ 在 GitHub 上该项目 (https://github.com/htmlburger/wpemerge-plugin)
提交错误报告 (https://github.com/htmlburger/wpemerge-plugin/issues)
（将安全问题通过 hi@atanas.dev 发送电子邮件代替）
提交功能建议 (https://github.com/htmlburger/wpemerge-plugin/issues)
提交和/或回答问题 (https://github.com/htmlburger/wpemerge-plugin/issues)
提交拉取请求 (https://github.com/htmlburger/wpemerge-plugin/pulls)
与您的社区分享您对 WP Emerge 的兴奋之情

htmlburger / wpemerge-plugin

维护者

详细信息