Drupal 9 中通过代码启用节点字段并配置显示区域的完整教程

碧海醫心

碧海醫心

2026-07-31

984人浏览

原创

Drupal 9 中通过代码启用节点字段并配置显示区域的完整教程

当 Drupal 9 后台节点显示界面(如 Full、Teaser)因字段过多或缓存异常导致无法正常启用/拖拽字段时,可通过编程方式调用 entity_display.repository 服务批量设置字段的可见性、区域与渲染配置。

当 drupal 9 后台节点显示界面(如 full、teaser)因字段过多或缓存异常导致无法正常启用/拖拽字段时,可通过编程方式调用 `entity_display.repository` 服务批量设置字段的可见性、区域与渲染配置。

在 Drupal 9 中,节点(Node)的字段显示逻辑由「视图显示(View Display)」控制,每个显示模式(如 default、full、teaser)对应一个独立的 EntityViewDisplay 实体。当管理界面卡顿、提交无效或 JS 加载失败时,直接操作底层显示配置是高效可靠的替代方案。

✅ 正确的字段启用与区域分配方式

核心逻辑依赖 entity_display.repository 服务,它提供统一入口获取和保存各类显示配置:

$display_repository = \Drupal::service('entity_display.repository');

// 1. 配置表单显示(Form Display)——用于内容编辑页
$form_display = $display_repository->getFormDisplay('node', 'article'); // 替换 'article' 为你的内容类型机器名
$form_display->setComponent('field_image', [
  'region' => 'content',
  'weight' => 5,
])
->save();

// 2. 配置默认视图显示(View Display: 'default')
$view_default = $display_repository->getViewDisplay('node', 'article');
$view_default->setComponent('field_image', [
  'label' => 'hidden',
  'type' => 'image',
  'settings' => [
    'image_style' => 'medium',
    'image_link' => '',
  ],
  'region' => 'content',
  'weight' => 10,
])
->save();

// 3. 配置特定视图模式(如 'full')
$view_full = $display_repository->getViewDisplay('node', 'article', 'full');
$view_full->setComponent('field_image', [
  'label' => 'above',
  'type' => 'image',
  'settings' => ['image_style' => 'large'],
  'region' => 'content',
  'weight' => 0,
])
->save();

⚠️ 注意:region 参数仅在启用了 Display Suite 或其他支持区域扩展的模块时才生效;标准 Drupal 核心中,region 字段会被忽略(默认所有字段均在 content 区域)。若需真正自定义区域(如 header、sidebar_first),请确认已安装并启用 Display Suite 模块,并使用其提供的 ds 显示模式。

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

虽然问题中提到“用什么 hook”,但不建议在 hook_install() 或 hook_update_N() 中硬编码字段配置——这会导致部署不可控、重复执行风险高,且难以调试。更专业、安全的做法是:

WaytoAGI-通往AGI之路
WaytoAGI-通往AGI之路

飞书提供的AGI一站式学习平台

下载
  • 创建一个临时管理页面(带权限控制);
  • 手动触发一次,验证效果后可删除;
  • 后续可升级为 Drush 命令或配置同步的一部分。

示例实现如下:

1. 定义路由(mymodule.routing.yml)

mymodule.enable_fields:
  path: '/admin/mymodule/enable-fields'
  defaults:
    _controller: '\Drupal\mymodule\Controller\FieldSetupController::enableFields'
    _title: '启用节点字段配置'
  requirements:
    _permission: 'administer site configuration'

2. 编写控制器(src/Controller/FieldSetupController.php)

<?php namespace Drupal\mymodule\Controller;
use Drupal\Core\Controller\ControllerBase;
use Drupal\Core\StringTranslation\StringTranslationTrait;

class FieldSetupController extends ControllerBase {
  use StringTranslationTrait;

  public function enableFields() {
    $displays = [
      ['bundle' => 'article', 'field' => 'field_image', 'mode' => 'full'],
      ['bundle' => 'page',    'field' => 'field_hero',  'mode' => 'teaser'],
      ['bundle' => 'product', 'field' => 'field_price', 'mode' => 'default'],
    ];

    $display_repo = \Drupal::service('entity_display.repository');
    $results = [];

    foreach ($displays as $config) {
      try {
        $view_display = $display_repo->getViewDisplay('node', $config['bundle'], $config['mode']);
        $view_display->setComponent($config['field'], [
          'label' => 'hidden',
          'type' => 'string',
          'region' => 'content',
          'weight' => 0,
        ])->save();

        $results[] = $this->t('✅ 已启用 @field 在 @bundle (@mode)', [
          '@field' => $config['field'],
          '@bundle' => $config['bundle'],
          '@mode' => $config['mode'],
        ]);
      }
      catch (\Exception $e) {
        $results[] = $this->t('❌ 失败:@field in @bundle (@mode) — @error', [
          '@field' => $config['field'],
          '@bundle' => $config['bundle'],
          '@mode' => $config['mode'],
          '@error' => $e->getMessage(),
        ]);
      }
    }

    // 清除相关缓存以确保前端立即生效
    \Drupal::service('cache_tags.invalidator')->invalidateTags(['config:core.entity_view_display.node.*']);

    return [
      '#type' => 'markup',
      '#markup' => '<div class="messages messages--status">' . implode('<br>', $results) . '</div>',
      '#cache' => ['max-age' => 0],
    ];
  }
}

? 补充说明与最佳实践

  • 缓存处理:执行后务必调用 \Drupal::service('cache_tags.invalidator')->invalidateTags([...]),否则前端可能仍显示旧配置。
  • 多环境一致性:生产环境应将此类配置纳入 config/install/ 或使用 drush cim 同步,而非依赖手动触发。
  • 避免 hook_entity_bundle_create() 等动态钩子:它们无法保证显示配置初始化时机,易引发竞态问题。
  • ? 进阶推荐:结合 Config SplitFeatures 模块,将字段显示配置导出为可版本化 YAML 文件,提升团队协作与部署可靠性。

通过上述方式,你不仅能绕过 UI 卡顿问题,还能建立可复现、可审计、可自动化的字段显示管理流程。

相关专题

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

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

2023.09.01

5409

6

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

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

2023.10.11

3587

5

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

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

2023.10.11

1785

5

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

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

2023.10.23

2250

4

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

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

2023.10.23

2761

6

html怎么上传
html怎么上传

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

2023.11.03

1999

9

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

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

2023.11.09

3028

8

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

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

2023.11.13

2289

8

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

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

2023.11.27

10926

4

热门下载

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

精品课程

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

共6课时 | 54.4万人学习

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

共89课时 | 131.8万人学习