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



お勧め

Login rebuilderに「XML-RPC設定」を追加しました(2018年5月27日 更新)

公式サイトで公開しているプラグイン「Login rebuilder」をバージョンアップし、XML-RPCリクエストの管理機能を追加しました。Login rebuilderの主たる機能は、ログインページをサイト別にユニークなURLに変更し、ログインページへの不正アクセスを回避することです。WordPressのXML-RPCリクエストはピンバックや外部ツールやサイトなどとの連携に利用されていますが、今回追加した機能ではXML-RPCリクエストの処理に対していくつかの制限できるようにしています。

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

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

4.4では投稿ページも専用テンプレートが適用できる(2018年5月27日 更新)

従来、特定の固定ページには専用テンプレートを適用できるのですが、投稿ページに適用させるためにはアクションやフィルターを利用する必要がありました。4.4では特定の投稿ページに標準で専用テンプレートを適用できるようになりそうです。

5.7の新機能:HTTPからHTTPSへの移行(2021年3月13日 更新)

先週は「WordPress 5.7 Beta 2(以降Beta 2)」が公開され、正式版リリースへ一歩進みました。WordPress 5.7の注目ポイントの1つに「HTTPからHTTPSへの移行」を手助けする機能があり、それに関連する機能を含んだhttps-detection.phpファイルとhttps-migration.phpが追加されていた。

wp_titleからwp_get_document_titleへ(2018年5月27日 更新)

先週、WordPress 4.4 beta1(以降4.4 beta1)が公開されました。この4.4 beta1では新テーマ「Twenty Sixteen」が追加されたほか、wp-includesディレクトリ以下のファイルが大幅に変更された感じです。