Drupal 8 テーマ作成 .info.ymlファイルについて

--広告--

ポイント

Drupal 8のテーマを作成するためには、Drupalのメタデータを記入する theme名.info.ymlファイルが必要になります。

今回は theme名.info.ymlファイルの記載方法や定義について説明します。

閲覧数 226 回

theme名.info.ymlファイルについて

テーマ作成時には、まず theme名.info.yml というファイルの作成が必要になります。

テーマ名が「sample」の場合は、ファイル名は「sample.info.yml」というようになります。

なお、テーマ名は既に使われているテーマ名やモジュール名と異なる名前にする必要があります。

また、記述の際のルールとして下記2点あります。

・タブの使用は禁止されており、スペースのみの使用となります

・プロパティとリストは一文字以上スペースを空けてインデントする必要があります

theme名.info.ymlファイルを作成しよう

それでは実際にtheme名.info.ymlファイルを作成してみましょう。

記載内容としては下記のようになります。

name: Sample
type: theme
base theme: classy
description: A sample theme.
core: 8.x
libraries:
  - sample/base
regions:
  header: Header
  content: Content  # the content region is required
  sidebar_first: 'Sidebar first'
  footer: Footer

theme名.info.ymlファイルの定義についての説明

ここからファイルの詳細な内容について説明していきます

name: Sample

必須で記入する必要がある項目です。

テーマの名前を記載します。

今回はテーマ名が「Sample」となります。

type: theme

必須で記入する必要がある項目です。

今回はテーマ作成のファイルのため、「theme」と記載します。

base theme: classy

必須ではないですが、記載することを推奨されている項目です。

こちらを定義することにより、別のテーマからリソースを継承することができます。

今回は「classy」というテーマを記載しています。

description: A sample theme.

必須で記入する必要がある項目です。

テーマの管理画面にテーマの説明文として表示されます。

core: 8.x

必須で記入する必要がある項目です。

Drupalのコアバージョンを記載します。

libraries:
- sample/base

追加したいライブラリのパスを記入します。

今回の場合、baseが .libraries.ymlに記載されるライブラリになります。

version: 8.x-1.0

このテーマのバージョン情報を記載します。

テーマを修正した場合にバージョンをアップしていきます。

regions:

テーマテンプレート作成時に必要なリージョン情報を記載します。

「content: Content」のみ必須となりますが、それ以外は自由に記載ができます。

 

theme名.info.ymlファイルのまとめ

今回はテーマ名.info.ymlの概要と設定方法を説明しました。

上記の他にも定義項目はあるので、詳しくはDrupal.orgをご確認ください。

 

カテゴリ

関連タグ

--広告--

同じカテゴリのコンテンツ

・非常に簡易的なDrupalのテーマ作成方法を説明します。

Drupalのテンプレート構造についての説明をします。

主…

ここでは「記事」「基本ページ」等のコンテンツタイプごとに

node.html.tiwgは、page.html.twigの …

ここではテーマにスタイルシートを追加する方法を説明します。