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



お勧め

HTML編集モードに定型文ボタンを追加する(2011年6月1日 更新)

投稿編集ページにはビジュアル編集モードとHTML編集モードがあり、それらを拡張するプラグインも多数存在している。そういったプラグインを利用するのもいいのだが、仕組みを理解するのも悪くないはず。というわけで、ここではHTML編集モードのボタンの仕組みと定型文を挿入するボタンを追加する方法を紹介する。

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

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

3.2標準テーマ「Twenty Eleven」は投稿フォーマットに着目(2011年7月6日 更新)

新テーマ「Twenty Eleven」のトップページでは、投稿フォーマットに応じて表示を切り替える仕組みが提案されている。ここでは、その投稿フォームの活用方法を簡単に紹介する。

標準で使用できる数少ないショートコード[caption]とは(2018年5月27日 更新)

画像をアップロードして「投稿に追加」ボタンをクリックすると、投稿記事内にリンク付きのimgタグか、ショートコードのが挿入される。ここではそれらの書式を整理する。

ショートコードを含んだページを表示する前に何か処理する(2014年5月28日 更新)

固定ページまたは投稿ページに独自のフォームを埋め込む。入力→登録の2段階のフォームなら著名なプラグイン「Contact Form 7」を利用すればいいのだが、クライアントの依頼は入力→確認→登録の3段階で組み込む要素が特化していたので、独自の実装方法を考えることになった。