sanitize_option

(2.0.5以降)
sanitize_option - オプション値をサニタイズする

説明

string sanitize_option( string $option, string $value )
オプション値をサニタイズする。

パラメータ

  • $option
    オプション名を指定。
  • $value
    オプション値を指定。

返り値

パラメータ$optionに応じてサイタイズしたオプション値を返す。

注意

add_optionupdate_option関数などでオプション値を追加・更新する前に呼び出されるためテーマやプラグインで本関数を呼び出すことはまずないと思われる。サニタイズ結果を変更したい場合は、本関数の"sanitize_option_{$option}"フィルターが利用できる。

使用例

  • オプション値をサニタイズする。
    <?php $value = sanitize_option( $name, $value ); ?>

フィルター

[2.3.0]サニタイズした値を返す直前に"sanitize_option_{$option}"フィルターをを呼び出す。パラメータ$valueはサニタイズした値が、$optionは本関数が受け取った内容が格納される。[4.3.0]$original_valueには、本関数が受け取り時(サニタイズ前)の$valueの内容が格納される。
return apply_filters( "sanitize_option_{$option}", $value, $option, $original_value );

アクション

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

ソースファイル

/wp-includes/formatting.php

関連

お勧めコンテンツ

ダッシュボードのフィードボックスをカスタマイズ(2011年7月8日 登録)

管理者ページのトップページ「ダッシュボード」には、「WordPress 開発者ブログ」と「WordPress フォーラム」という2つのフィードボックスが表示されている。自分のような開発者には有益な情報をもたらしているが、一般の方には必要のない情報かもしれない。今回はこのフィードボックスをカスタマイズする方法を紹介する(管理者権限)。

ログアウト後はいつもサイトトップ(2015年5月7日 登録)

ログアウト後に表示(リダイレクト)されるページは、標準ではログインページ(wp-login.php)である。4.2.0ではログアウト処理後のページリダイレクト前に呼び出されるフィルターが追加された。

canvasタグを投稿したい(2013年12月27日 登録)

以前「投稿内容のid属性などを保存するための対策」で取り上げたように、WordPressでは投稿に記述できるHTMLタグが制限されている。同コラムでこの制限を調整する対策を紹介しているが、3.5以降ではフィルター関数を登録して対応できるようだ。

Posts filter multiselect:プラグイン作ってみました(2015年3月9日 登録)

先週の金曜日、知り合いの方から「投稿一覧ページで絞り込みを行う際、複数選択できないか」といった問い合わせがあり、その時には「標準では無理ですね」と返答しました。このこと自体は事実なのですが、要するに「複数選択可能なドロップダウンメニュー」が実現できれば対応するのはそれほど難しくないような気がしました。この週末、そんなノリでちょっとコーディングしてできたのがこのプラグインです。

ホームディレクトリから過去のファイルを削除する(2013年1月27日 登録)

WordPressで構築したサイトのホームディレクトリには、現在使われていないファイルが残っている時がある。3.5.1もリリースされたことだし、これを機にホームディレクトリを整理整頓した。

最終更新日時 : 2015-08-22 11:29