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

関連

お勧めコンテンツ

サイドバーの初期化はwidgets_initアクションで(2011年7月14日 登録)

ウィジェットを使ってみたくなり新テーマ「Twenty Eleven」を覗いてみると、codexに記載されていた内容と少し違っている。これって「Twenty Ten」ですでに変更されていたんだね。

プラグインの設定ページもレスポンシブ対応(2014年6月3日 登録)

レスポンシブ対応したWordPressの管理画面。プラグインやテーマのカスタマイズで管理画面を拡張しているなら、切り替わるタイミングはきっちり押さえておきたいところではないだろうか。

Login rebuilder:プラグイン作ってみました(2013年1月18日 登録)

昨年投稿した「ログインページを変える」をプラグイン化。ログインページを独自の名前のページ変更し、標準のログインページwp-login.phpを使用できないようにするプラグインです。部外者によるwp-login.phpのアクセスにお悩みの方にお勧めします。また2.0.0では「XML-RPCリクエストの管理機能」を追加。最新の2.2.0では管理者のログイン時にメールで通知する機能を追加しました。

4.2の「アクティビティ」ウィジェットに投稿以外の情報も表示する(2015年5月13日 登録)

ダッシュボードの「アクティビティ」ウィジェットは「投稿(post)」の状況を表示し、固定ページ(page)やカスタム投稿タイプの投稿記事の状況については標準では表示されない。このことに対して以前『3.8の「アクティビティ」ウィジェットに投稿以外の情報も表示する』を紹介したのだが、4.2では新しいフィルターが追加され、カスタマイズが少し容易になった。

投稿日の検索が自由自在に(2013年10月30日 登録)

WordPress 3.7.0ではWP_Date_Queryクラスが追加され、WP_Queryクラス(もちろんquery_posts関数でも)で利用できるようになった。このWP_Date_Queryにより、○年○月○日以前や以降の投稿情報を取得したり、○年○月○日から○年○月○日の範囲の投稿情報を取得したりといったことが、容易に行えるようになった。

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