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



お勧め

個人データのエクスポートメール向けに追加された新フィルター(2020年4月2日 更新)

先週「WordPress 5.4 RC3」が公開され、正式リリースまであと1週間。ブロックエディターの機能強化が目立つわけですが、地味な変更点もちらほらと。今回はその中の1つ、「個人データのエクスポート」機能に関連するフィルターを紹介する。

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

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

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

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

Gutenbergでカスタムフィールドを使う(2018年8月10日 更新)

Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。

favicon.icoがWordPressロゴになる!?(2020年2月25日 更新)

先週「WordPress 5.4 Beta2」が公開され、来月末には正式リリース。タイミングよく三連休だったので、1つ前の「ニュース」で紹介されていた変更点から確認してみた。