概要
wp_get_theme関数は、現在のテーマについての情報を取得するためのWordPressの関数です。これにより、テーマ名、バージョン、作成者、説明などの詳細な情報を簡単に取得できます。この関数は、テーマのカスタマイズや確認を行う際によく使われます。主に以下のような機能を実装する際に使用されます。
- テーマ情報の取得
- カスタムウィジェットの作成
- テーマオプションページの表示
- テーマのバージョンチェック
- テーマに関する管理画面での通知
- 子テーマの情報取得
- テーマの依存関係チェック
- テーマのスタイルやスクリプトのエンキュー
構文
$theme = wp_get_theme( $stylesheet );
パラメータ
$stylesheet（オプショナル）: 取得したいテーマのスタイルシート名（例:'twentytwentyone'）。指定しない場合、現在のテーマ情報が取得されます。
戻り値
WP_Themeオブジェクトが返され、そのオブジェクトにはテーマの情報が含まれています。
関連する関数
バージョン情報
- 追加されたバージョン: 3.4.0
- 非推奨/削除されたバージョン: なし
コアファイルのパス
wp-includes/theme.php
サンプルコード
サンプル1: 現在のテーマ名を取得
$theme = wp_get_theme();
echo 'Current theme: ' . $theme->get('Name');
このサンプルコードは、現在使用中のテーマの名前を取得して表示します。
サンプル2: 現在のテーマのバージョンを取得
$theme = wp_get_theme();
echo 'Theme version: ' . $theme->get('Version');
このサンプルでは、現在のテーマのバージョン情報を表示します。
サンプル3: 子テーマを確認
$theme = wp_get_theme();
if ($theme->parent()) {
echo 'This is a child theme of ' . $theme->parent()->get('Name');
} else {
echo 'This is not a child theme.';
}
このコードは、現在のテーマが子テーマかどうかを確認し、その親テーマの名前を表示します。
サンプル4: テーマの作成者情報を取得
$theme = wp_get_theme();
echo 'Theme author: ' . $theme->get('Author');
このサンプルは、現在のテーマの作成者名を取得して表示します。
サンプル5: テーマの説明文を取得
$theme = wp_get_theme();
echo 'Theme description: ' . $theme->get('Description');
このコードでは、現在のテーマの説明文を取得して表示します。
この関数のアクションでの使用可能性
| アクション | 使用可能性 |
|---|---|
| mu_plugin_loaded | |
| registered_post_type | |
| plugins_loaded | |
| wp_roles_init | |
| setup_theme | 〇 |
| after_setup_theme | 〇 |
| set_current_user | |
| init | |
| register_sidebar | |
| wp_loaded | |
| send_headers | |
| parse_query | |
| pre_get_posts | |
| wp | |
| template_redirect | |
| get_header | |
| wp_head |