add_theme_support

パラメータ

• $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-palette'	5.0.0
  'editor-font-sizes'	5.0.0
  'editor-styles'	5.0.0
  'wp-block-styles'	5.0.0
  'core-block-patterns'	5.5.0
  'editor-gradient-presets'	5.6.0
  'experimental-link-color'	5.6.0
  'custom-spacing'	5.7.0
  'widgets-block-editor'	5.8.0
  'block-template-parts'	6.1.0
  'link-color'	6.3.0
  'border'	6.3.0
  'appearance-tools'	6.3.0
  'editor-spacing-sizes'	6.6.0

• $args
  機能のパラメータを指定（省略時は、true）。

返り値

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

注意

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

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

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

array(
	'default-image'          => パス名（省略時''）,
	'random-default'         => bool（省略時false）,
	'width'                  => 数値（省略時0）,
	'height'                 => 数値（省略時0）,
	'flex-height'            => bool（省略時false）,
	'flex-width'             => bool（省略時false）,
	'default-text-color'     => 文字列（省略時''）,
	'header-text'            => bool（省略時true）,
	'uploads'                => bool（省略時true）,
	'wp-head-callback'       => コールバック（省略時''）,
	'admin-head-callback'    => コールバック（省略時''）,
	'admin-preview-callback' => コールバック（省略時''）,
	'video'                  => bool（省略時false）,
	'video-active-callback'  => コールバック（省略時'is_front_page'）,
);

array(
	'width'                => 数値（省略時null）,
	'height'               => 数値（省略時null）,
	'flex-width'           => bool（省略時false）,
	'flex-height'          => bool（省略時false）,
	'header-text'          => 文字列（省略時''）,
	'unlink-homepage-logo' => bool（省略時false）, // [5.5.0]追加
);

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

[5.6.0]パラメータ$featureが'post-formats'で値が配列以外の場合、警告メッセージ（'You need to pass an array of post formats.'の翻訳テキスト）が表示される。

[5.7.0]パラメータ$featureに追加された'custom-spacing'を指定しないと、ブロックエディターの各ブロックにて「サイズ（Dimensions）」に「パディング（Padding）」が表示されない。

使用例

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

フィルター

アクション

ソースファイル