sanitize_option

説明

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

パラメータ

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

返り値

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

注意

add_option update_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

最終更新 : 2018年05月27日 10:45



お勧め

Gutenberg、「More」の翻訳は「続きを読む」?(2018年8月15日 更新)

Gutenbergの新エディターを使用中、ボタン上にポインタを移動させると「続きを読む」と表示されるところが複数あった。なぜ、ここが「続きを読む」なのか疑問に思ったので、少し調べてみた。

同じ名前のメタ情報をまとめて削除する(2014年3月21日 更新)

WordPressには、投稿情報、コメント情報、ユーザ情報のそれぞれを拡張できるメタ情報の仕組みが用意されている。投稿情報のメタ情報は「カスタムフィールド」として投稿画面に用意されているので投稿者自身が随時操作できるほか、テーマやプラグインからの操作も容易である。今回の中身はそんなメタ情報の一括削除の話だ。

WP_List_Tableクラスを使ってみた(2018年5月27日 更新)

WordPressの管理画面ではデータを一覧表示しているページがいくつもある。今回この仕組みを自分のプラグインでも使ってみたいと思い、調査しながらプラグインに組み込んでみた。

Contact Form 7に確認フェーズを(2012年12月16日 更新)

Contact Form 7はWordPressによるサイト製作でお世話になることが多いプラグインの1つ。ただ、クライアント様によっては、入力、確認、送信の3フェーズにしたいという要望があり、そんな時は別の方法を採用していたのですが、JavaScript(jQuery)を使ってページ遷移しなくてもいいなら確認フェーズは用意できるかなと思い、作り込んでみた。

the_date関数で投稿日を確実に表示する(2011年12月20日 更新)

投稿記事の投稿日時を表示する際、 the_date関数を使用することが多いだろう。このthe_date関数はphpのdate関数と同じパラメータを指定することで、好みの日時フォーマットで投稿日時を表示できるのだが、ある条件の場合に投稿日時を表示しない。最初にこの現象に遭遇したときは、ちょっと悩まされた。