WordPressでテーマを作成する際にスタイルシート(style.css)が必要になりますが、そのstyle.cssには冒頭にコメントヘッダーというものが必要になります。
このコメントヘッダーというものはどういった使い方をするのでしょうか。
見ていきましょう。
コメントヘッダーとは
コメントヘッダーとはstyle.cssの冒頭に記述する「テーマの詳細」のことで『WordPress Codex』にはこのように書いてあります。
style.cssは、テーマの「CSS スタイル」情報に加えて、コメントの形式で必ず「テーマ詳細」を記述する必要があります。
テーマの作成-WordPress Codex
テーマの作成には必須のもので、テーマ名やテーマの作者名、テーマのVersionなどを記述します。
目的
ではなんのためにこのコメントヘッダーが必要なのでしょうか。
『WordPress Codex』にはこのように書いてあります。
style.cssのコメントヘッダ行は、WordPress に「テーマ」として識別させ、有効なテーマとして他のインストール済みテーマとともに「管理画面 > 外観 > テーマ」画面に表示させるために必要なものです。
テーマの作成-WordPress Codex
コメントヘッダーはWordPressにテーマであることを認識するために必須となります。
コメントヘッダーがないとテーマとして認識されないのでstyle.cssを作成したらまず最初にコメントヘッダーを書いてしまいましょう。
コメントヘッダーの記述方法
ではコメントヘッダーはどのように記述するのでしょうか。
例としてこのブログでは無料の「STINGER PLUS2」というテーマを使用させていただいております。
このテーマではこのように書かれています。
テーマ名や作者などが書かれていますね。
コメントヘッダーはその名の通り『/*〜*/』のコメントの中に書くルールとなっています。
コメントで書いたものがWordPressに認識されてしまうのは少し違和感があるかもしれませんね。
コメントヘッダーに記述できる項目一覧
ここでコメントヘッダーに記述できる項目をまとめてみます。
| 項目名 | 内容 |
|---|---|
| Theme Name: | テーマ名 ※必須 |
| Theme URI: | テーマのURL |
| Author: | 作者 |
| Author URI: | 作者のURL |
| Template: | 親テーマ名。子テーマの場合は必須。子テーマでない場合は不要。 |
| Description: | テーマの説明 |
| Version: | テーマのバージョン |
| License: | テーマのライセンス |
| License URI: | ライセンスのURL |
| Text Domain: | テキストドメイン(多言語対応テーマで言語ファイルを指定するのに使用) |
| Tags: | テーマの特徴を示すタグ |
| Domain Path: | 言語ファイルが保存されている場所 |
「Theme Name」は必須となっていますので下記漏れのないようにしましょう。
記述例
とりあえずテーマを作成する場合は下記の項目を書くくらいが一般的です。
/*
Theme Name:Original Theme
Theme URI:https://◯◯.com
Author:Yamada Taro
Description:◯◯に最適なWordPressテーマです。
Version:1.0
*/
このように記述してみましょう。
状況によって必要になってくる項目もあるかと思いますのでうまく活用しましょう。
コメントヘッダーの情報を取得するWordPress関数
style.cssで記述したコメントヘッダーはwp_get_theme()というWordPress関数を使用することで情報を取得し、それを表示させるなどして利用することができます。
下記の記事を参考にしてみてください。
この記事内ではVersion情報を取得しています。
まとめ
ここに書いてあることがわかると既存のテーマの特徴も読み取りやすくなります。
ぜひ参考にしてみてください。
コメント