概要
get_theme_support 関数は、ワードプレステーマがサポートしている機能を取得するために使用されます。この関数は、テーマの設定や機能の確認に役立ちます。主に次のような機能を実装する際によく使われます：
- 画像のサイズ調整
- カスタムロゴのサポート
- 不要な自動スタイルの解除
- カスタムメニューの設定
- ブログフォーマットのサポート
- ウィジェットエリアの追加
- HTML5 マークアップのサポート
- カスタム背景の設定
構文
get_theme_support( $feature );
パラメータ
$feature(string): 取得したいテーマ機能のスラグ。
戻り値
- 特定の機能がサポートされている場合は、その詳細（配列）を返します。サポートされていない場合は
falseを返します。
関連する関数
使用可能なバージョン
get_theme_support は、WordPress 3.0.0以降で利用可能です。
コアファイルのパス
wp-includes/theme.php
この関数のアクションでの使用可能性
| アクション名 | 使用例 |
|---|---|
| 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 |
サンプルコード
サンプルコード1: カスタムロゴのサポートを確認
if ( get_theme_support( 'custom-logo' ) ) {
echo 'カスタムロゴがサポートされています。';
}
このコードは、テーマがカスタムロゴをサポートしているかを確認し、サポートされている場合にメッセージを表示します。
サンプルコード2: フィーチャーを配列として取得
$custom_background = get_theme_support( 'custom-background' );
if ( $custom_background ) {
var_dump( $custom_background );
}
このコードは、カスタム背景のサポート情報を取得し、配列として表示します。
サンプルコード3: ギャラリー機能のサポートをチェック
if ( get_theme_support( 'post-formats' ) ) {
echo 'ポストフォーマットがサポートされています。';
}
このコードは、投稿フォーマットに対するサポートを確認し、サポートされている場合にメッセージを表示します。
サンプルコード4: HTML5 サポートのチェック
if ( get_theme_support( 'html5' ) ) {
echo 'HTML5がサポートされています。';
}
このコードは、HTML5 マークアップのサポートがあるかを確認し、サポートされている場合にメッセージを表示します。
サンプルコード5: カスタムメニュー機能の確認
if ( get_theme_support( 'menus' ) ) {
echo 'カスタムメニューがサポートされています。';
}
このコードは、カスタムメニューのサポートを確認し、サポートされている場合にメッセージを表示します。