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



お勧め

meta_compare_key使ってみた(2019年3月19日 更新)

ブロックエディターの登場により、標準のカスタムフィールドを使う機会はかなり減った気がする。そんな中、5.1.0で追加されたのが、カスタムフィールド名(メタキー)に含まれる文字列を指定する'meta_compare_key'キーだ。

WP_List_Tableクラスの「一括操作」フォームを使ってみた(2018年5月27日 更新)

今回は「WP_List_Tableクラスを使ってみた」の続き。投稿一覧やプラグインページなどにある「一括操作」(Bulkアクション)フォーム対応に関するメモである。

テーマから投稿画像のサイズを指定する(2012年3月15日 更新)

投稿記事に挿入する画像サイズは、サムネイル(150×150)、中サイズ(300×300)、大サイズ(1024×1024)がデフォルトだが、テーマによっては別のサイズを指定したい場合はある。基本的には、「設定」-「メディア」の「メディア設定」ページで指定できるが、テーマ内のfunctions.phpで設定しておくとちょっと便利かもしれない。

ログインページを変える(2014年9月12日 更新)

WordPressの標準的な不正ログイン対策としては、ログインIDは'admin'を避けるパスワードはユニークで長くする、場合によってはアクセスできるIPアドレスを制限する、といった具合だろう。これらの他に何かできないものだろうかと、ちょっと考えてみた。

新規投稿時の本文プレースホルダーテキストを変える(2021年9月9日 更新)

ブロックエディターに影響を与えるフィルターは多数存在する。今回紹介するフィルターはその1つで、新規投稿時の本文ブロックのプレースホルダーテキストを変更するものだ。