説明
sanitize_key() は、小文字の英数字・アンダースコア・ハイフンのみを残す関数です。キー名やスラッグ向けです。
基本構文
sanitize_key( string $str ): string引数
$str：処理する文字列
戻り値
サニタイズ済みの文字列。
使い方（サンプル）
$key = sanitize_key( $input );注意点
- 大文字は小文字に変換されます。
実務での使いどころ
- オプションやメタのキー、スラッグなど、識別用の文字列を、整えるとき。
よくあるミスと対処
- 日本語などの、通常のテキストに使っている。小文字の英数字・ハイフン・アンダースコア以外が、取り除かれ、内容が失われる。
- 大文字が、小文字に変わることに、気づかない。
NG例
$key = sanitize_key( '設定A' ); // 日本語が取り除かれ、「a」になるOK例
$key = sanitize_key( 'my_setting_A' ); // my_setting_a使い分け早見表
| 関数 | 結果 |
|---|---|
sanitize_key() |
小文字の英数字・ハイフン・アンダースコアの、キー |
sanitize_title() |
URL用のスラッグ |
sanitize_text_field() |
1行のテキスト |
関連項目
sanitize_title()、sanitize_text_field()
公式リファレンス：sanitize_key() | Function | WordPress Developer Resources
コメント