説明
string sanitize_user( string $username [ , bool $strict = false ] )
文字列をユーザー名向けにサニタイズする。
パラメータ
- $username文字列を指定。
- $strict厳格に字種を制限する場合はtrueを指定(省略時はfalse)。
返り値
文字列をサニタイズした内容を返す。注意
パラメータ$strictがtrueの場合、標準では以下に示す字種以外は除外される。ユーザー情報の登録時は$strictがtrueで本関数を呼んでいる。
- 英大小文字
- 数字
- 記号(_.-@)
- 半角スペース
またユーザー名は先頭および末尾のスペースは取り除かれ、さらに内部の連続したスペースは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
関連
お勧め
パスとURL(2011年10月6日 更新)
テーマやプラグインで、WordPressシステム関連のディレクトリやURLを使う時があり、それらの多くは関数や定数として定義されている。今回は、それらの関数や定数について整理していく。ブロックエディターの文字サイズ設定を変えてみる(2019年12月12日 更新)
今回は「前回投稿した内容」の続きブロックエディターの文字サイズ設定を変えようと思う。参考にするテーマはもちろん「Twenty Twenty」である。
5.5で非推奨になる関数名について(2020年8月12日 更新)
来月にリリースされるWordPress 5.5に向けてBeta 1、2と公開が続いている。「WordPress 5.5 Beta 2(以降Beta 2)」のソースコードを見ていくと、いくつかの関数が非推奨になるようだ。
KUSANAGIでマルチサイト(サブドメイン)を試した(2019年8月6日 更新)
本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。
LevelとCapability(2018年5月27日 更新)
プラグインやテーマの管理ページを作成する際など、ユーザのレベルと権限を確認することがある。ここでは、権限グループ別のレベルと権限の有無を整理してみた。