如何在 Drupal 9 中通过编程方式启用节点字段并配置显示区域

聖光之護

聖光之護

2026-07-31

194人浏览

原创

如何在 Drupal 9 中通过编程方式启用节点字段并配置显示区域

当 drupal 9 后台节点显示界面(如 full、teaser)因字段过多或缓存问题无法正常操作时,可通过实体显示仓库(entitydisplayrepository)在代码中批量启用字段、设置显示区域与渲染选项,规避 ui 卡顿问题。

当 drupal 9 后台节点显示界面(如 full、teaser)因字段过多或缓存问题无法正常操作时,可通过实体显示仓库(entitydisplayrepository)在代码中批量启用字段、设置显示区域与渲染选项,规避 ui 卡顿问题。

在 Drupal 9 中,若节点类型(Bundle)的字段在「管理显示」(Manage Display)UI 中无法勾选启用、区域分配失效(如无限加载、提交后重置),通常源于前端资源超载、AJAX 请求失败或缓存/权限异常。此时,推荐采用程序化方式配置字段显示,既可靠又可复用,尤其适用于部署脚本、模块安装或紧急修复场景。

✅ 正确的程序化配置方法

核心服务为 \Drupal\Core\Entity\EntityDisplayRepositoryInterface,它统一管理表单显示(Form Display)和视图显示(View Display)。关键要点如下:

  • getFormDisplay('node', $bundle):获取节点表单默认显示配置;
  • getViewDisplay('node', $bundle, $view_mode):获取指定视图模式(如 'full', 'teaser', 'default')的显示配置;
  • setComponent($field_name, $options):配置字段组件,其中 'region' => 'content' 是必需项(Drupal 9+ 强制要求区域声明);
  • 所有修改必须调用 ->save() 持久化。

以下为完整、安全的示例代码(替换 $bundle 和 field_name 为实际值):

use Drupal\Core\Entity\EntityDisplayRepositoryInterface;
use Drupal\Core\Render\Markup;

/** @var EntityDisplayRepositoryInterface $display_repository */
$display_repository = \Drupal::service('entity_display.repository');

// 启用并配置表单中的字段(如创建/编辑页)
$form_display = $display_repository->getFormDisplay('node', 'article');
$form_display->setComponent('field_image', [
  'region' => 'content',
  'weight' => -5,
]);
$form_display->save();

// 启用并配置「默认」视图模式(通常对应 /node/{id})
$view_default = $display_repository->getViewDisplay('node', 'article');
$view_default->setComponent('field_image', [
  'label' => 'hidden',
  'type' => 'image',
  'region' => 'content',
  'settings' => [
    'image_style' => 'medium',
    'image_link' => '',
  ],
]);
$view_default->save();

// 单独配置「full」视图模式(显式指定 view mode)
$view_full = $display_repository->getViewDisplay('node', 'article', 'full');
$view_full->setComponent('field_image', [
  'label' => 'above',
  'type' => 'image',
  'region' => 'content',
  'weight' => 0,
]);
$view_full->save();

⚠️ 注意事项:

Drupal 11
Drupal 11

Drupal 11 是面向复杂内容架构和企业级网站的开源 PHP 内容管理系统,适合门户、社区和组织官网。

下载
  • 'region' => 'content' 不可省略 —— Drupal 9.3+ 对所有视图显示组件强制要求明确区域,否则 save() 会静默失败;
  • 字段名(如 'field_image')必须与机器名完全一致(区分大小写);
  • 视图模式名称需准确:'default'(非 'default' 别名)、'full'、'teaser' 等;
  • 若字段类型变更(如从文本改为文件),需同步设置 'type' 插件(如 'file_link', 'image');
  • 修改后建议执行 drush cr 清除缓存,确保新配置立即生效。

? 推荐执行方式:封装为可触发的管理路由(非钩子)

问题中提到“用哪个 hook 实现”——不推荐使用 hook_install() 或 hook_update_N() 直接写入,因其仅在模块安装/更新时运行一次,且易因并发或错误中断导致状态不一致。更稳健的做法是:

  1. 创建一个临时管理页面(如 /admin/config/module/enable-fields);
  2. 用户点击即执行配置逻辑;
  3. 成功后返回提示,并自动刷新缓存。

示例路由定义(mymodule.routing.yml):

mymodule.enable_fields:
  path: '/admin/config/mymodule/enable-fields'
  defaults:
    _controller: '\Drupal\mymodule\Controller\FieldConfigController::enableNodeFields'
    _title: '启用节点字段配置'
  requirements:
    _permission: 'administer nodes'

控制器方法(src/Controller/FieldConfigController.php):

public function enableNodeFields() {
  $this->enableFieldForBundle('article', 'field_image', 'full');
  $this->enableFieldForBundle('page', 'field_cta_button', 'teaser');

  // 清理相关缓存
  \Drupal::service('cache_tags.invalidator')->invalidateTags(['config:core.entity_view_display.node.article.full']);

  return [
    '#markup' => Markup::create('<div class="messages messages--status">✅ 字段配置已更新!请清空浏览器缓存以查看效果。</div>'),
  ];
}

private function enableFieldForBundle($bundle, $field_name, $view_mode = 'default') {
  $display = $view_mode === 'default'
    ? \Drupal::service('entity_display.repository')->getViewDisplay('node', $bundle)
    : \Drupal::service('entity_display.repository')->getViewDisplay('node', $bundle, $view_mode);

  $display->setComponent($field_name, [
    'label' => 'hidden',
    'type' => 'string_textfield',
    'region' => 'content',
  ])->save();
}

该方案兼顾安全性、可审计性与可重复执行性,避免了数据库直写(高风险)和钩子滥用(难调试)的问题,是 Drupal 9 生产环境的最佳实践。

相关文章

编程速学教程(入门课程)
编程速学教程(入门课程)

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

下载

相关标签:

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

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2023.09.01

5528

6

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

3630

5

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

1808

5

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

2023.10.23

2294

4

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

2023.10.23

2831

6

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.03

2021

9

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.09

3075

8

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.13

2340

8

sprintf函数用法详解
sprintf函数用法详解

sprintf函数的用法:1、格式化字符串;2、指定输出宽度和精度;3、返回值。更多关于sprintf函数用法详解的内容,大家可以阅读下面的文章。

2023.11.27

10931

4

热门下载

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

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.4万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 131.8万人学习