WP_Theme クラスの使い方|説明・引数・注意点

説明

WP_Theme は、テーマの情報(名前、バージョン、作者など)を表すクラスです。wp_get_theme() が返します。

基本構文

WP_Theme

引数

  • get( $header ):ヘッダー項目(Name、Version など)を取得
  • get_stylesheet_directory():ディレクトリのパス
  • parent():親テーマのオブジェクト
  • exists():テーマが存在するか

戻り値

WP_Theme オブジェクト。

使い方(サンプル)

$theme = wp_get_theme();
$ver = $theme->get( 'Version' );

注意点

  • 子テーマのときは parent() で親テーマ情報を取得できます。

実務での使いどころ

  • テーマの情報(名前、バージョン、親テーマ)を、取得するとき(wp_get_theme() の戻り値)。

よくあるミスと対処

  • $theme->Name のように、プロパティを直接読んでいる。動作はするが、$theme->get( 'Name' ) を使うのが推奨。
  • 存在しないテーマでも、オブジェクトが返る。exists() で確認する。
  • 子テーマを使っているとき、バージョンなどが、子テーマのものだと、気づかない。親テーマは、parent() で取得する。

NG例

$theme = wp_get_theme();
echo $theme->Name; // プロパティを、直接読んでいる

OK例

$theme = wp_get_theme();
echo esc_html( $theme->get( 'Name' ) );
$parent = $theme->parent(); // 子テーマのとき、親テーマのオブジェクト

使い分け早見表

やりたいこと 使うもの
テーマの情報を、取得する wp_get_theme()
有効なテーマのスラッグ get_stylesheet()
親テーマのスラッグ get_template()

関連項目

wp_get_theme()、get_template()、get_stylesheet()

公式リファレンス:WP_Theme | WordPress Developer Resources

コメント

タイトルとURLをコピーしました