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



お勧め

ダッシュボードの「クイックドラフト」を「CodeMirror」に変更してみた(2019年11月5日 更新)

管理ページの「テーマエディター」では4.9以降「CodeMirror」が利用されている。今回はこの「CodeMirror」をプラグインで活用できないか調べた話である。

headタグのmeta(generator)タグを取り除く(2018年5月27日 更新)

標準的なWordPressのテーマで出力されるHTMLには、headタグ内に次のようなmetaタグが出力されている。
<meta name="generator" content="WordPress 3.0.5" />

Blacklist keys manager:プラグイン作ってみました(2015年5月22日 更新)

少し前から明らかにスパムと思われるコメントが投稿され、そのモデレーションメールを受け取る回数が増えてきた。あまりにもあからさまなコメントばかりなので、何らかの対策ができないか考えてみました。

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

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

投稿内容に応じてwpautopを制御する(2013年8月13日 更新)

投稿内容を表示する the_content関数では、 wpautop関数がフィルターの1つとして呼び出され、改行をbrタグに変換したり、pタグで調整したりする。この機能自体は便利なのだが、きちんとデザインされたHTMLソースを流し込んだ場合はこの機能は好ましくない。そんなわけで、記事内容に応じてwpautop関数を制御できないか考えてみた。