add_theme_support

（2.9.0以降）
add_theme_support - テーマの機能を設定する

説明

void add_theme_support( string $feature [ , mixed $args = true [ , mixed $... ] ] )
テーマの機能を設定する。

パラメータ

  • $feature
    機能名。主な機能名と対応バージョンは次の通り。
    機能名対応バージョン
    'post-thumbnails'2.9.0
    'automatic-feed-links'2.9.0
    'post-formats'2.9.0
    'custom-header'3.4.0
    'custom-background'3.4.0
    'html5'3.6.0
    'title-tag'4.1.0
    'custom-logo'4.5.0
    'customize-selective-refresh-widgets'4.5.0
    'starter-content'4.7.0
    'responsive-embeds'5.0.0
    'align-wide'5.0.0
    'dark-editor-style'5.0.0
    'disable-custom-colors'5.0.0
    'disable-custom-font-sizes'5.0.0
    'editor-color-pallete'5.0.0
    'editor-font-sizes'5.0.0
    'editor-styles'5.0.0
    'wp-block-styles'5.0.0
  • $args
    機能のパラメータを指定（省略時は、true）。

返り値

テーマ機能を登録できなかった場合はfalseを返す。

注意

自テーマのfunctions.phpにてadd_action関数を利用し、各種設定を行う関数内（Twenty Tenテーマではtwentyten_setup関数）で使用する。

add_action( 'after_setup_theme', 'twentyten_setup' );

なお3.0で追加されたナビゲーションメニューを追加する場合は、この関数ではなく、register_nav_menus関数を使用する。

パラメータ$featureによって$argsに指定する値が変わる。主なテーマ機能とその内容は次の通り。

$feature$argsの内容
'post-thumbnails'true（省略可）
'automatic-feed-links'true（省略可）
'post-formats'サポートする投稿フォーマット（'aside'、'image'、'video'、'quote'、'link'、'gallery'、'status'、'audio'、'chat'）を格納した配列
'custom-header'キー（'default-text-color'（文字列）、'height'（数値）、'width'（数値）、'flex-height'（bool）など）の値を格納した連想配列
'custom-header-uploads'true（省略可）
'custom-logo'キー（'height'（数値）、'width'（数値）、'flex-height'（bool））の値を格納した連想配列
'html5'HTML5向けのマークアップ（'search-form'、'comment-form'、'comment-list'、'gallery'、'caption'）を格納した配列
'title-tag'true（省略可）
'custom-background'キー（'default-color'（文字列）、'default-attachment'（文字列））の値を格納した連想配列
'customize-selective-refresh-widgets'true（省略可）
'starter-content'キー（'widgets'（連想配列）、'posts'（連想配列）、'attachments'（連想配列）など）の値を格納した連想配列
'featured-content'キー（'featured_content_filter'（文字列）、'max_posts'（数値））の値を格納した連想配列
'responsive-embeds'true（省略可）
'align-wide'true（省略可）
'dark-editor-style'true（省略可、'editor-styles'も必要）
'disable-custom-colors'true（省略可）
'disable-custom-font-sizes'true（省略可）
'editor-color-pallete'連想配列を含む配列（連想配列のキーは'name'、'slug'、'color'）
'editor-font-sizes'連想配列を含む配列（連想配列のキーは'name'、'shortName'、'size'、'slug'）
'editor-styles'true（省略可）
'wp-block-styles'true（省略可）

本関数のパラメータは可変数で、第2パラメータの内容が配列のインデックス0の値として、第3パラメータの内容がインデックス1の値として、第4パラメータの内容がインデックス2の値としてシステム内に保存される。

使用例

  • 投稿編集ページに「アイキャッチ画像」を追加する。
    <?php add_theme_support( 'post-thumbnails' ); ?>
  • 投稿ページに「フォーマット」を追加する。
    <?php add_theme_support( 'post-formats', array( 'aside', 'link', 'gallery', 'status', 'quote', 'image' ) ); ?>

フィルター

実行するフィルターはありません。

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/theme.php

最終更新 : 2018年12月07日 09:55

関連

参考

Code Reference: add_theme_support

お勧め

WP_Postオブジェクトで投稿情報を直感的に使う（2012年10月4日 更新）

WordPress 3.5で登場するであろう WP_Postクラス。WordPressの投稿情報は、投稿情報本体のほか、カテゴリーや投稿タグ、カスタムフィールドなど、いくつかに分散して記録され、それぞれの情報を取得する際は、いくつかの関数をしていた。新しいWP_Postクラスにより、その習慣とおさらばできるかもしれない。

さくらのVPSでKUSANAGI#2（2018年5月27日 更新）

今回は「前回」の続き。さくらのVPS（メモリー2GB SSDプラン）でパフォーマンスをApacheのabコマンドで確認してみた。はてさて、うたい文句通りのパフォーマンスは発揮するのだろうか。

タイトルのみをキーワード検索する（2014年4月3日 更新）

WordPressのキーワード検索は、投稿タイトルと本文のどちらかに指定したキーワードが含まれているかを調べるわけだが、時々タイトルだけとか、逆に本文だけ検索したいケースがある。

Login rebuilder 2.6.0の新機能紹介（2019年4月22日 更新）

今回追加したものは、REST API / Usersの使用をログイン時のみ使用できるように制限する機能である。この機能を有効にすることで、管理者情報が漏洩するリスクを低減させる効果が期待できる。

Blacklist keys manager：プラグイン作ってみました（2015年5月22日 更新）

少し前から明らかにスパムと思われるコメントが投稿され、そのモデレーションメールを受け取る回数が増えてきた。あまりにもあからさまなコメントばかりなので、何らかの対策ができないか考えてみました。