get_theme_mods()


WordPressのget_theme_mods()関数は、現在のテーマのカスタマイズ設定（テーマモディフィケーション）を取得するために使用されます。この関数は、テーマカスタマイザーで設定されたすべての値を配列として返します。

構文

get_theme_mods();
  • array — テーマのカスタマイズ設定を含む配列。設定がない場合は空の配列を返します。

例1: テーマのカスタマイズ設定を取得する

この例では、テーマのカスタマイズ設定を取得し、その内容を表示します。

<?php $theme_mods = get_theme_mods(); print_r($theme_mods); ?>

例2: 特定のテーマ設定を取得する

この例では、特定のテーマ設定（例えば、背景色）を取得します。

<?php $background_color = get_theme_mod('background_color'); echo $background_color; ?>

例3: デフォルト値を使用して設定を取得する

この例では、設定が存在しない場合にデフォルト値を返します。

<?php $header_textcolor = get_theme_mod('header_textcolor', '#000000'); echo $header_textcolor; ?>

例4: テーマ設定が存在するか確認する

この例では、特定のテーマ設定が存在するかどうかを確認します。

<?php if (get_theme_mod('custom_logo')) { echo 'ロゴが設定されています。'; } else { echo 'ロゴが設定されていません。'; } ?>

例5: テーマ設定をループして表示する

この例では、すべてのテーマ設定をループして表示します。

<?php $theme_mods = get_theme_mods(); foreach ($theme_mods as $key => $value) { echo $key . ': ' . $value . '<br>'; } ?>

例6: テーマ設定をJSON形式で出力する

この例では、テーマ設定をJSON形式で出力します。

<?php $theme_mods = get_theme_mods(); echo json_encode($theme_mods); ?>

例7: テーマ設定をデバッグする

この例では、テーマ設定をデバッグ用に出力します。

<?php $theme_mods = get_theme_mods(); var_dump($theme_mods); ?>

例8: テーマ設定を条件分岐で使用する

この例では、テーマ設定に基づいて条件分岐を行います。

<?php if (get_theme_mod('display_header_text') == true) { echo 'ヘッダーテキストを表示します。'; } else { echo 'ヘッダーテキストを表示しません。'; } ?>

注意点:

  • テーマ設定が存在しない場合、get_theme_mod()はデフォルト値を返しますが、get_theme_mods()は空の配列を返します。
  • テーマカスタマイザーで設定された値のみが返されます。デフォルトのテーマ設定は含まれません。

関連機能：