wp-composer/wordpress-project

适用于 Composer 的 WordPress 5 项目的模板

资助包维护!
BramDriesen

安装: 16

依赖项: 0

建议者: 0

安全: 0

星标: 1

关注者: 1

分支: 0

开放问题: 0

类型:项目

5.x-dev 2021-07-20 08:01 UTC

This package is auto-updated.

Last update: 2024-09-20 14:41:53 UTC


README

此项目模板提供了一套用于使用 Composer 管理网站依赖项的启动工具包。

使用方法

首先,您需要 安装 Composer

注意:以下说明针对的是 全局 Composer 安装。您可能需要将 composer 替换为 php composer.phar(或类似)以适应您的设置。

之后,您可以创建项目

composer create-project wp-composer/wordpress-project:5.x-dev some-dir --no-interaction

使用 composer require ... 下载新依赖项到您的安装中。

cd some-dir
composer require wpackagist-plugin/really-simple-ssl

模板做什么?

当安装给定的 composer.json 时,会处理一些任务

  • WordPress 将安装在 web 目录中。
  • 实现了自动加载器,以使用位于 vendor/autoload.php 的生成的 Composer 自动加载器。
  • 插件(类型为 wordpress-plugin 的包)将放置在 web/wp-content/plugins/
  • 插件(类型为 wordpress-plugin 的包)将放置在 web/wp-content/mu-plugins/
  • 主题(类型为 wordpress-muplugin 的包)将放置在 web/wp-content/themes/
  • 根据您的 .env 文件创建环境变量。请参阅 .env.example

更新 WordPress 核心

此项目将尝试保持所有 WordPress 核心文件的最新状态。

按照以下步骤更新您的核心文件。

  1. 运行 composer update "johnpbloch/wordpress-core" --with-dependencies 以更新 WordPress 核心和其依赖项。
  2. 运行 git diff 以确定是否有任何自定义更改被撤销。
    1. 一次性提交所有内容,以便在检出分支或运行 git bisect 时,web 将与 core 保持同步。
    2. 如果在第 2 步中存在非平凡冲突,您可能希望在这些步骤上执行分支操作,并使用 git merge 将更新的核心文件与您的自定义文件合并。这有助于使用 三路合并工具,例如 kdiff3。如果您的更改很简单,则不需要此设置;将所有修改保留在文件的开始或结束部分是保持合并容易的好策略。

常见问题解答

我应该提交我下载的插件或主题吗?

Composer 推荐 不要。他们提供了 反对的理由,但同时也提供了一些解决方案,以防项目决定这样做

我如何将补丁应用到下载的插件中?

如果您需要应用补丁(根据要修改的项目,Pull Request 往往是更好的解决方案),可以使用 composer-patches 插件。

要将补丁添加到 really-simple-ssl WordPress 插件中,请在 composer.json 的 extra 部分中插入 patches 部分

"extra": {
    "patches": {
        "wpackagist-plugin/really-simple-ssl": {
            "Patch description": "URL or local path to patch"
        }
    }
}

这也可以用于 WordPress 核心补丁。

"extra": {
    "patches": {
        "johnpbloch/wordpress-core" : {
             "Issue #1486: Alter how Twenty Twenty-One sets up Dark Mode support.": "https://patch-diff.githubusercontent.com/raw/WordPress/wordpress-develop/pull/1486.patch"
        }
    }
}

我如何指定 PHP 版本?

本项目支持 PHP 7.4 及以上版本(请参阅WordPress 系统要求),然而,执行composer update命令可能会升级某些依赖包,从而需要 PHP 7.4+。

为了防止这种情况,您可以在composer.json文件的config部分添加以下代码,以指定您想要使用的 PHP 版本:

"config": {
    "sort-packages": true,
    "platform": {
        "php": "7.4.21"
    }
},