sanitize_text_field

（2.9.0以降）
sanitize_text_field - 文字列をサニタイズする

説明

string sanitize_text_field( string $str )
INPUT要素に入力された文字列またはデータベースに格納された文字列をサニタイズする。

パラメータ

  • $str
    任意の文字列を指定。

返り値

サニタイズした文字列を返す。

注意

文字エンコードUTF-8で無効な文字やHTML要素の記述を取り除く。また改行文字やタブ文字はスペースに置き換える。

改行文字を含む文字列については sanitize_textarea_fieldが使用できる。

使用例

  • 変数$strの内容をサニタイズする。
    <?php $str = sanitize_text_field( $str ); ?>

フィルター

[2.9.0]標準のサニタイズ処理を行った後'sanitize_text_field'フィルターを呼び出す。パラメータ$filteredにはサニタイズされた内容が、$strには本関数が受け取った内容が格納されている。 
return apply_filters( 'sanitize_text_field', $filtered, $str );

アクション

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

ソースファイル

/wp-includes/formatting.php

最終更新 : 2018年12月07日 09:40

関連

参考

Code Reference: sanitize_text_field

お勧め

決まった値を返すだけの関数群（2018年5月27日 更新）

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。

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

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

WP_Postオブジェクトで投稿情報を直感的に使う（2012年10月4日 更新）

WordPress 3.5で登場するであろう WP_Postクラス。WordPressの投稿情報は、投稿情報本体のほか、カテゴリーや投稿タグ、カスタムフィールドなど、いくつかに分散して記録され、それぞれの情報を取得する際は、いくつかの関数をしていた。新しいWP_Postクラスにより、その習慣とおさらばできるかもしれない。

さくらのVPSでKUSANAGI（2018年5月27日 更新）

請け負っていた業務が一段落したので、「さくらのVPS」で「KUSANAGI」を試してみました。推奨環境はメモリ4GBとなっているが、今回は実験的な利用なので、SSD 2GBプランでトライしました。

絵文字画像がPNGからSVGへ（2018年5月27日 更新）

WordPressでは絵文字に対応していないブラウザ環境で絵文字を表示する仕組みをバージョン4.2から提供。絵文字に対応しているブラウザとそん色がない表示を実現する。