跳转到主要内容
长风 提交于 12 February 2017

翻译者:长风Drupal开发

翻译地址:http://www.5188jxt.com/technology/drupal8mo-kuai-kai-fa-tong-guo-infoymlwen-jian-rang-drupal8liao-jie-ni-de-mo-kuai.htm

原文地址:https://www.drupal.org/docs/8/creating-custom-modules/let-drupal-8-know-about-your-module-with-an-infoyml-file

 

主题描述:模块的元数据

Drupal8模块、主题、安装套件不可少的一个文件是.info.yml,它用来存储这个项目的元数据

.info.yml文件必不可少的部分如下:

提示Drupal这个项目是模块、主题、安装套件

为Drupal的web管理界面提供管理信息

提供标准来控制模块的开启、禁用、和版本控制

General administrative purposes in other contexts.

 

Hello world

下面是我们要使用的hellp_world.info.yml文件。如果你是跟随我们的教材,创建一个名为hello_world.info.yml的文件,在你的模块的根目录下,粘贴下面的代码到文件中:

name: Hello World Module

description: Creates a page showing "Hello World".

package: Custom

type: module

core: 8.x

 

下面我们来看一个完整的Drupal8模块的info.yml文件的例子

name: Hello World Module

//Drupal8模块的可读名字,用于后台管理

description: Creates a page showing "Hello World".

//Drupal8模块的介绍,将显示在模块管理页面中

package: Custom

//模块的群组名字,相似的模块可以用相同的群组名字,

type: module

//类型是模块,也可以是主题,安装套件等

core: 8.x

//适用的Drupal核心版本是Drupal8.X

dependencies:

 - datetime:datetime

 - link:link

 - drupal:views

//指定这个模块依赖的模块

test_dependencies:

- drupal:image

//测试依赖的模块

 

configure: hello_world.settings

//设置模块的路径

hidden: true

//模块是否隐藏,

# Note: do not add the 'version'  property yourself!

# It will be added automatically by the packager on drupal.org.

version: 1.0

 

Drupal8模块开发常见问题

Drupal8的模块没有在/admin/modules页面被显示出来。

1、检查info文件的机器名字以及文件是否位于模块的根目录下面

2、确保Drupal8模块的info文件中有以下这行

type: module

3、确保模块的名字是以小写字母或者下划线开始的。

 

模块在管理页面的列表中,但是复选框不能被选择

检查核心(core:)是否被设置为:

core:8.x

检查该模块所依赖的模块是否缺失

Drupal8模块的描述信息是空的

记住:description是必须的。

description: Example Module description.