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

関連

お勧めコンテンツ

囲み型ショートコードとwpautop(2014年10月22日 登録)

ショートコードは投稿記事の閲覧時に動的に内容を変更できる優れもの。galleryやcaptionなどいくつかのショートコードが標準で組み込まれており、一部のプラグインではその機能を利用する手段としてショートコードが利用されている。

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

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

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

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

RSSフィードの抜粋をさらに抜粋(2011年7月21日 登録)

RSSフィードはデフォルトでは「全文(HTMLタグを含む)」になっているが、管理画面の「表示設定」では「抜粋のみ(HTMLタグは除外)」を選択できる。それでも投稿記事が長いと、その抜粋テキストも長くなってしまう。ここではそんなRSSフィードの抜粋テキストを調整する方法を紹介する。

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

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

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