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



お勧め

カレンダーウィジェットをAjaxで切り替える(2011年8月22日 更新)

ウィジェットベースでテーマを構築していてカレンダーを表示してみた。標準では、前月や次月のリンク先はそれぞれの月のアーカイブページとなっているのだが、記事を探すだけであればカレンダー部分だけを更新するほうが便利なのではと考え、そのアイデアを実装してみた。

3.8の「アクティビティ」ウィジェットに投稿以外の情報も表示する(2014年1月17日 更新)

ちょうど1月前の「ダッシュボードの「概要」にカスタム投稿タイプ件数を表示する」にて、WordPress 3.8新ダッシュボードの「概要」ウィジェットにカスタム投稿タイプの投稿数を表示する方法を紹介したが、今回のその続編で「アクティビティ」ウィジェットを拡張する方法を紹介する。

5.5の機能強化:コメントフォームのちょっとした改良(2020年8月12日 更新)

来月にリリースされるWordPress 5.5に向けてBeta 1、2、3と公開が続いている。「WordPress 5.5 Beta 3(以降Beta 3)」のソースコードを見ていくと、コメントフォームを表示する comment_form関数が機能拡張されていた。

5.3への準備:投稿写真を使っているサイトは準備しておこう(2019年10月10日 更新)

この記事は先日公開した「5.3の新機能:JPEG画像の向きを調整」の続きのようなものになる。高解像度の投稿写真を扱っているサイトは、5.3のリリースに合わせて対応を検討しておくべきことをまとめてみた。

画像ブロックに効果を追加した時にハマった(2023年3月30日 更新)

画像ブロックに対して見た目が変わる効果を追加しようと思い機能拡張してみた。その際、いくつかの効果は問題なかったのだが、1つの効果だけその画像を選択したときのみ効果が消える不具合が発生。対処内容はシンプルなものだが、忘れないようにメモっとく。