如何使用Composer来管理一个基于Drupal的项目? (drupal-scaffold)

浅辰酱_2506

浅辰酱_2506

2026-01-11

252人浏览

原创

drupal-scaffold 是 Drupal 官方 Composer 插件,自动将核心骨架文件(如 .htaccess、robots.txt)从 drupal/core 复制到 web/ 目录;它内置于 composer create-project 流程,通过 post-create-project-cmd 脚本执行,依赖 scaffold.yml 配置,需手动运行脚本或更新 drupal/core 才触发。

如何使用composer来管理一个基于drupal的项目? (drupal-scaffold)

什么是 drupal-scaffold,它和 composer create-project 有什么关系?

drupal-scaffold 是 Drupal 官方提供的一个 Composer 插件,负责把核心文件(比如 .htaccess、robots.txt、index.php)从 drupal/core 包里“复制”到项目根目录。它不是独立工具,而是嵌入在 composer create-project 流程中的自动行为。

当你运行 composer create-project drupal/recommended-project mysite,背后实际触发了 drupal-scaffold 的 post-create-project-cmd 脚本——这个脚本读取 drupal/core 里的 scaffold.yml,再按规则把文件写到你项目的正确位置。

  • 不手动启用它,也默认生效;禁用需在 composer.json 中设 "enable-patching": false
  • 它只管“骨架文件”,不处理模块、主题或配置的安装
  • 若你用 composer install 而非 create-project,drupal-scaffold 不会自动运行(除非你手动加 composer run-script drupal-scaffold)

如何自定义 scaffold 文件(如改 robots.txt 或 .htaccess)?

直接修改根目录下的 robots.txt 或 .htaccess 没用——下次 composer update drupal/core 时会被覆盖。正确做法是:在项目根目录放一个 web/robots.txt(或对应路径),然后通过 scaffold.yml 告诉插件“跳过复制,用我的”。

例如,在项目根目录新建 scaffold.yml:

core:
  skip: true
files:
  'web/robots.txt': 'my-robots.txt'
  'web/.htaccess': 'my-htaccess'

再把你的定制文件 my-robots.txt 放在项目根目录下。这样 drupal-scaffold 就会跳过默认 robots.txt,改用你指定的路径。

  • 所有路径都相对于项目根目录,不是 web/ 目录
  • 若想完全禁用某文件复制,设 'web/robots.txt': false
  • 修改 scaffold.yml 后,需手动运行 composer run-script drupal-scaffold 生效

为什么 vendor/drupal/core 更新后 web/index.php 没变?

这是常见误解:drupal-scaffold 只在特定时机运行:创建项目(create-project)、更新核心(update drupal/core)、或显式调用 drupal-scaffold 脚本。单纯 composer update 全局包,不会触发它——因为 drupal/core 没被列为更新目标。

JSON Toolkit
JSON Toolkit

JSON文件多功能工具。支持格式化、验证、压缩、键排序及点记法路径查询。零依赖。

下载

验证方法:运行 composer show drupal/core 看当前版本,再执行:

composer update drupal/core --with-dependencies

这时 drupal-scaffold 才会重新生成 web/index.php 等文件。

  • 若仍没更新,检查 composer.json 中是否误删了 "drupal/core-composer-scaffold" 依赖
  • 运行 composer run-script --list 可确认 drupal-scaffold 脚本是否存在
  • 注意:某些旧版 drupal/core(如 9.3.x 之前)用的是 drupal/core-composer-scaffold v2,v3 才支持 scaffold.yml 覆盖

使用 drupal-recommended-project 时,web/ 目录结构怎么组织才安全?

官方推荐模板(drupal/recommended-project)强制使用 web/ 为文档根目录,所有 Drupal 核心文件都放在 web/ 下。关键点在于:不能把 composer.json 放进 web/,也不能把 vendor/ 暴露在 Web 可访问路径下。

标准结构必须是:

mysite/
├── composer.json
├── web/
│   ├── index.php
│   ├── core/
│   └── sites/
├── vendor/
└── ...
  • Web 服务器 DocumentRoot 必须指向 web/,不是项目根目录
  • composer install 必须在项目根目录运行,否则 drupal-scaffold 找不到 scaffold.yml
  • 模块应装在 web/modules/contrib/,主题在 web/themes/contrib/ ——这些路径由 Drupal 自动识别,不要改 composer.json 的 installer-paths

最易忽略的一点:如果你用的是 Acquia 或 Platform.sh,它们的部署流程可能绕过本地 composer install,此时要确保 CI 配置里显式调用了 drupal-scaffold,否则上线后 .htaccess 缺失会导致 404。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

php js json composer access

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
composer是什么插件
composer是什么插件

Composer是一个PHP的依赖管理工具,它可以帮助开发者在PHP项目中管理和安装依赖的库文件。Composer通过一个中央化的存储库来管理所有的依赖库文件,这个存储库包含了各种可用的依赖库的信息和版本信息。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2023.12.25

364

5

Composer 安装与快速入门指南
Composer 安装与快速入门指南

面向 PHP 开发新手,详细介绍 Composer 的下载安装方式(本地安装与全局安装)、国内镜像源(阿里云/腾讯云)加速配置、composer.json 与 composer.lock 文件的作用解析、require/install/update 等核心命令的使用方法,帮助开发者快速掌握 PHP 依赖管理的基本工作流。

2026.04.10

623

36

Composer 依赖管理与版本控制实战
Composer 依赖管理与版本控制实战

深入讲解 Composer 的依赖管理机制,涵盖语义化版本号规范、版本约束符(^、~、*、>=)的区别与最佳实践、composer.lock 在团队协作中的锁定策略、依赖冲突的排查与解决方法、require-dev 与生产依赖的分离管理、平台依赖检查(platform-check)等进阶内容,帮助开发者在项目中精准控制依赖版本、避免"依赖地狱"。

2026.04.10

387

29

Composer 自定义包开发与发布教程合集
Composer 自定义包开发与发布教程合集

以实际项目为导向,讲解如何从零创建一个符合规范的 Composer 包,涵盖 composer.json 元信息配置、PSR-4 自动加载规则设置、命名空间规划、单元测试集成、README 与 LICENSE 编写规范,以及将包提交到 Packagist 公共仓库或搭建 Satis/Private Packagist 私有仓库的完整发布流程,帮助开发者将可复用代码封装为标准化的 Composer 包。

2026.04.10

409

15

Composer 自动加载机制与性能优化
Composer 自动加载机制与性能优化

系统剖析 Composer 的自动加载体系,讲解 PSR-0 与 PSR-4 自动加载标准的区别与演进、classmap 与 files 加载方式的适用场景、autoload_real.php 源码级加载流程解析,同时介绍 composer dump-autoload -o 优化加载映射、APCu 缓存加速、authoritative-classmap 配置等生产环境性能优化手段,帮助开发者深入理解自动加载原理并提升项目启动速度。

2026.04.13

360

21

Composer 在主流 PHP 框架中的应用实践
Composer 在主流 PHP 框架中的应用实践

结合 Laravel、ThinkPHP、Symfony 等主流 PHP 框架的实际场景,讲解 Composer 在框架项目中的典型应用,包括通过 create-project 初始化框架项目、安装与管理第三方扩展包、scripts 钩子(post-install/post-update)自动执行部署任务、自定义 Installer 插件开发、多项目共享 vendor 依赖的 Monorepo 工作流管理,帮助开发者在真实框架项目中充分发

2026.04.13

583

14

Composer 镜像源配置与网络问题排查
Composer 镜像源配置与网络问题排查

针对国内开发者常遇到的 Composer 网络问题,详细讲解阿里云、腾讯云、华为云等国内镜像源的全局与项目级切换方法、多镜像源优先级配置策略、composer config 命令行快速设置技巧,同时涵盖 SSL 证书错误、连接超时、下载中断等常见网络报错的排查与修复方案,以及利用 artifact / path 仓库实现完全离线环境下的依赖安装。

2026.04.14

371

24

Composer Scripts 脚本与自动化工作流
Composer Scripts 脚本与自动化工作流

系统讲解 Composer Scripts 机制的完整用法,涵盖 pre-install、post-update、post-autoload-dump 等内置事件钩子的触发时机与应用场景、自定义脚本命令的定义与参数传递、调用外部 Shell 命令与 PHP 静态方法、多脚本串联执行与条件判断,以及结合代码检查(PHPStan/PHP-CS-Fixer)、数据库迁移、缓存清理等任务构建一键部署自动化工作流。

2026.04.14

450

18

Composer 私有仓库搭建与企业级管理
Composer 私有仓库搭建与企业级管理

面向团队与企业开发场景,讲解如何使用 Satis 搭建轻量级静态私有仓库、通过 Toran Proxy / Private Packagist 构建功能完善的企业级私有包管理平台,涵盖 Git/SVN 仓库类型接入、Token 鉴权与访问权限控制、Webhook 自动触发包更新、内网部署方案以及与 GitLab CI/CD 流水线的集成配置,帮助企业安全高效地管理内部 PHP 组件资产。

2026.04.14

500

26

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
墨刀帮助中心
墨刀帮助中心

共0课时 | 0人学习

MyEclipse学习中心
MyEclipse学习中心

共0课时 | 0人学习

Apache Subversion 官方手册
Apache Subversion 官方手册

共0课时 | 0人学习