sanitize_user

説明

string sanitize_user( string $username [ , bool $strict = false ] )
文字列をユーザー名向けにサニタイズする。

パラメータ

  • $username
    文字列を指定。
  • $strict
    厳格に字種を制限する場合はtrueを指定(省略時はfalse)。

返り値

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

注意

パラメータ$strictがtrueの場合、標準では以下に示す字種以外は除外される。ユーザー情報の登録時は$strictがtrueで本関数を呼んでいる。

  1. 英大小文字
  2. 数字
  3. 記号(_.-@)
  4. 半角スペース

またユーザー名は先頭および末尾のスペースは取り除かれ、さらに内部の連続したスペースは1字にまとめられる。


使用例

  • 文字列をユーザー名向けにサニタイズする。
    <?php $username = sanitize_user( $username ); ?>
  • 文字列を厳格に字種を制限してサニタイズする。
    <?php $username = sanitize_user( $username, true ); ?>

フィルター

[2.0.1]サニタイズした内容を返す前に'sanitize_user'フィルターを呼び出す。パラメータ$usernameにはサニタイズした内容が、$raw_usernameにはサニタイズ前の内容が、$strictには本関数が受け取った値が格納される。
return apply_filters( 'sanitize_user', $username, $raw_username, $strict );

アクション

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

ソースファイル

/wp-includes/formatting.php

最終更新 : 2020年04月07日 12:41



お勧め

5.3の新機能:クエリーログに任意の項目を追加できる新フィルター(2019年10月23日 更新)

5.3 RC2」が公開され、正式リリースまであと20日。公式ディレクトリにプラグインを公開していることもあり、5.3に関する開発者向けの情報「Miscellaneous Developer Focused Changes in 5.3」を読んでいる。

ログインページのタイトルを変更してみる(2018年5月27日 更新)

バージョン4.9では新しいフィルターやフィルターのパラメータの追加が多数行われている。ここではその一例としてログインページ関連で追加された2つのフィルターを紹介する。

プラグインで注意が必要な関数(2013年11月27日 更新)

先日「Login rebuilder」という自作プラグインをアップデートした際、ユーザーさんからエラーになると連絡をいただいた。標準環境では問題なく、どうやら何らかのプラグインが影響しているらしい。

ブロックエディターの色設定を変えてみる(2019年12月11日 更新)

バージョン5.3で機能強化されたブロックエディター。対応を考えて新テーマ「Twenty Twenty」のソースコードを眺めていく。

KUSANAGIでマルチサイト(サブドメイン)を試した(2019年8月6日 更新)

本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。