set_theme_mod

（2.1.0以降）
set_theme_mod - 現在のテーマ固有のプロパティ値を設定する

説明

void bool set_theme_mod( string $name, string $value )
現在のテーマ固有のプロパティ値を設定する。

パラメータ

  • $name
    プロパティ名を指定。
  • $value
    プロパティ値を指定。

返り値

バージョン5.6.0以降では、プロパティ値を更新できた場合にtrueを、更新できなかった場合はfalseを返す。バージョン5.6.0より前のバージョンでは返り値はありません。

注意

現在のテーマ固有のプロパティは、 update_optionで 'theme_mods_$theme_slug' という名前（$theme_slugは現在のテーマのスラッグ）で格納される。

使用例

  • 現在のテーマ固有の'background_color'プロパティの値として'#000000'を設定する。
    <?php set_theme_mod( 'background_color', '#000000' ); ?>

フィルター

[3.9.0]プロパティ値を更新する前に"pre_set_theme_mod_{$name}"フィルターを呼び出す。パラメータ$valueには本関数が受け取った内容が、$old_valueには更新前の内容が格納されている。 
$mods[ $name ] = apply_filters( "pre_set_theme_mod_{$name}", $value, $old_value );

アクション

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

ソースファイル

/wp-includes/theme.php

最終更新 : 2020年12月15日 13:05

関連

参考

Code Reference: set_theme_mod

お勧め

wp_titleからwp_get_document_titleへ（2018年5月27日 更新）

先週、WordPress 4.4 beta1（以降4.4 beta1）が公開されました。この4.4 beta1では新テーマ「Twenty Sixteen」が追加されたほか、wp-includesディレクトリ以下のファイルが大幅に変更された感じです。

ツイート引用が簡単になる仕組み（2012年6月8日 更新）

WordPress 3.4では、投稿記事の中にツイートのURLを記述するだけで、投稿ページにそれっぽい表示をしてくれるようになる。ちょっと気になったので、その仕組みを追っかけてみた。

5.5の機能強化：テーマ変更時に要求バージョンを確認（2020年8月12日 更新）

WordPress 5.5 RC 2が公開され、来週には正式版がリリース。変更箇所が多い「WordPress 5.5 RC 2（以降RC 2）」のソースコードを眺めていると、テーマの切り替え前にWordPressとPHPのバージョンを確認するようになっていた。

サイトヘルス機能を使ってみた（2019年4月12日 更新）

先月末にWordPress 5.2 Beta1が、今日はWordPress 5.2 Beta2（以降5.2Beta2）が公開された。5.2ではブロックエディターの機能が強化され、サイトの安全性とパフォーマンス向上に役立つとされるサイトヘルス機能が追加される。

ブロックエディターで編集したページが出力した余分な改行を削除（2019年2月22日 更新）

ブロックエディターで編集したページのHTMLソースは、投稿本文部分の改行が目立った。Webページとしての表示は問題ないのだが、データとしては不要なので削除することにした。