在 Drupal 中创建自定义页面的完整指南

本教程旨在指导开发者如何在 Drupal 中创建一个简单的自定义页面，显示 "Hello, world"。我们将详细介绍模块的创建、路由配置、控制器编写等步骤，并提供示例代码，帮助读者快速上手 Drupal 的模块开发。通过本教程，你将掌握在 Drupal 中构建自定义页面的基本方法，为更复杂的模块开发奠定基础。

创建自定义模块

在 Drupal 中创建自定义页面，通常需要创建一个自定义模块。模块是 Drupal 功能扩展的基本单元。

1. 创建模块目录： 在 modules/custom 目录下创建一个名为 hello 的目录。这是我们自定义模块的根目录。如果 modules/custom 目录不存在，请先创建它。

2. 创建 hello.info.yml 文件： 在 hello 目录下创建一个名为 hello.info.yml 的文件，用于描述模块的基本信息。

   name: Hello World Module
   description: Creates a page showing "Hello World".
   package: Custom
   
   type: module
   core_version_requirement: ^8 || ^9 || ^10

   • name: 模块的名称。
   • description: 模块的描述。
   • package: 模块所属的包，通常设置为 "Custom"。
   • type: 模块类型，设置为 "module"。
   • core_version_requirement: Drupal 核心版本要求，确保模块与 Drupal 版本兼容。

定义路由

路由定义了 URL 路径与控制器之间的映射关系。

中小企业网站系统前台源码(SmallBusinessStarterKit)

小型企业入门套件(The Small Business Starter Kit)提供了一个商业宣传网站的完整演示，他适合中小型企业。使用他创建的网站支持自定义模板，具有先进的功能，包括：内容和数据管理的SQL和XML数据源整合。该源码包含C#和VB两个版本，只有前台部分源码，微软官方截止到51aspx发布源码时还没有提供后台代码。小型企业网站入门套件的关键页面包括：产品分类显示新闻发布显示商户认证

下载

1. 创建 hello.routing.yml 文件： 在 hello 目录下创建一个名为 hello.routing.yml 的文件，用于定义路由。

   hello.my_page:
     path: '/hello'
     defaults:
       _controller: '\Drupal\hello\Controller\ExampleController::myPage'
       _title: 'My first page in D9'
     requirements:
       _permission: 'access content'

   • hello.my_page: 路由的名称，必须唯一。
   • path: URL 路径，用户访问该路径时将触发该路由。
   • defaults: 定义了控制器和页面标题。
     • _controller: 指定控制器类和方法，格式为 \Drupal\{模块名}\Controller\{控制器类名}::{方法名}。
     • _title: 页面的标题。
   • requirements: 定义了访问权限。
     • _permission: 指定用户需要拥有的权限才能访问该页面。access content 是一个常用的权限，允许用户访问内容。

创建控制器

控制器负责处理请求并返回响应。

1. 创建 src/Controller 目录： 在 hello 目录下创建一个名为 src 的目录，然后在 src 目录下创建一个名为 Controller 的目录。

2. 创建 ExampleController.php 文件： 在 src/Controller 目录下创建一个名为 ExampleController.php 的文件，用于定义控制器类。

   <?php
   
   namespace Drupal\hello\Controller;
   
   use Drupal\Core\Controller\ControllerBase;
   
   /**
    * Provides route responses for the Example module.
    */
   class ExampleController extends ControllerBase {
   
     /**
      * Returns a simple page.
      *
      * @return array
      *   A simple renderable array.
      */
     public function myPage() {
       return [
         '#markup' => 'Hello, world',
       ];
     }
   }

   • namespace: 命名空间必须与模块目录结构一致。
   • class ExampleController: 控制器类名。
   • extends ControllerBase: 继承 ControllerBase 类，提供了一些常用的方法。
   • public function myPage(): 控制器方法，用于处理请求并返回响应。
     • return ['#markup' => 'Hello, world'];: 返回一个包含 HTML 标记的渲染数组，Drupal 将渲染该数组并显示在页面上。

启用模块并清除缓存

1. 启用模块： 登录 Drupal 管理后台，进入 admin/modules 页面，找到 "Hello World Module" 模块，勾选并启用它。

2. 清除缓存： 进入 admin/config/development/performance 页面，点击 "清除所有缓存" 按钮。

访问页面

在浏览器中输入 /hello 或 index.php/hello 即可访问自定义页面，看到 "Hello, world" 的内容。

注意事项

• 命名空间： 确保命名空间与模块目录结构一致，这是最常见的错误。
• 缓存： 在修改模块代码后，必须清除缓存才能使更改生效。
• 权限： 确保用户拥有访问该页面的权限。
• 服务器配置： 如果出现 "Page not found" 错误，可能是服务器配置问题，例如 URL 重写未启用。

总结

通过以上步骤，你已经成功创建了一个简单的 Drupal 自定义页面。这个例子虽然简单，但涵盖了 Drupal 模块开发的基本要素。你可以基于此扩展功能，创建更复杂的模块。建议学习 PHP 的面向对象编程和 Symfony 框架的基础知识，以便更好地利用 Drupal 的强大功能。