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

お勧め

HTML entities button：プラグイン作ってみました（2021年4月28日 更新）

以前投稿した「HTML編集モードに定型文ボタンを追加する」をアレンジして、HTML編集モードに特殊文字（HTMLエンティティ）を挿入できるボタン、顔文字を挿入できるボタン、過去の投稿ページのリンクを挿入できるボタンを追加するプラグインを作ってみました。HTML編集モードの作業効率を向上させるプラグインです。2.1.0では「Dashiconsの挿入」を追加しました。HTML編集モードをメインに使用されている方は、お試しあれ。

親子の固定ページで同じテンプレートを使う（2013年3月20日 更新）

固定ページのテンプレートファイルは「page.php」か、ページ名（スラッグ）または投稿IDを指定したテンプレートファイルになる。固定ページでページデザインが数パターンある場合、通常は「page.php」で振り分けることになるが、もう少しスマートにできないか考えてみた。

oEmbedについて考えてみた（2018年5月27日 更新）

本サイト向けにテーマをリニューアルしようと思い一から作っている最中、ふと生成されているHTMLの中にあるoEmbedの記述が目についた。「この記述いつからだっけ」くらいに思いながらリンク先を開き、ちょっとモヤモヤしてしまった。

プラグインで注意が必要な関数（2013年11月27日 更新）

先日「Login rebuilder」という自作プラグインをアップデートした際、ユーザーさんからエラーになると連絡をいただいた。標準環境では問題なく、どうやら何らかのプラグインが影響しているらしい。

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

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