概要
WordPressのcurrent_theme_supports関数は、特定の機能が現在のテーマによってサポートされているかどうかをチェックするために使用されます。この関数は、プラグインやテーマが、特定の機能を前提にしたコーディングを行う際によく使われます。サポートされている機能には次のようなものがあります。
- Post Thumbnails
- Custom Logo
- HTML5
- Automatic Feed Links
- Custom Header
- Custom Background
- Title Tag
- Responsive Embeds
構文
current_theme_supports( $feature );
パラメータ
$feature(string): チェックする機能の名前。
戻り値
- (bool): 指定された機能がサポートされている場合は
true、そうでない場合はfalseを返します。
関連する関数
使用可能なバージョン
この関数は、WordPress 3.4以降で使用可能です。
コアファイルのパス
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 ( current_theme_supports( 'post-thumbnails' ) ) {
the_post_thumbnail();
}
このコードは、テーマが「Post Thumbnails」機能をサポートしているかどうかをチェックし、サポートしている場合に投稿のサムネイルを表示します。
サンプルコード2
if ( current_theme_supports( 'custom-logo' ) ) {
the_custom_logo();
}
ここでは、テーマが「Custom Logo」機能をサポートしているか確認し、サポートされていればカスタムロゴを表示します。
サンプルコード3
if ( current_theme_supports( 'automatic-feed-links' ) ) {
// フィードリンクを表示するコード
}
このコードは、テーマが「Automatic Feed Links」機能をサポートしているかどうかを確認し、サポートしている場合はフィードリンクを表示する処理を行います。
サンプルコード4
if ( current_theme_supports( 'html5' ) ) {
// HTML5サポートに適合したマークアップを使用
}
ここでは、テーマが「HTML5」機能をサポートしているか確認し、サポートされている場合にHTML5形式での出力を行います。
サンプルコード5
if ( current_theme_supports( 'custom-header' ) ) {
// カスタムヘッダーを表示するコード
}
このコードは、テーマが「Custom Header」機能をサポートしているかどうかをチェックし、サポートされていればカスタムヘッダーを表示します。