sanitize_key

（3.0.0以降）
sanitize_key - サイト内識別子向けにサニタイズする

説明

string sanitize_key( string $key )
サイト内識別子向けにサニタイズする。

パラメータ

  • $key
    サイト内識別子用の文字列を指定。

返り値

サイト内識別子としてふさわしくない文字を除外したものを返す。

注意

WordPressでは投稿タイプ名のようなサイト内で使用する識別子において使用できる文字を限定しており、この関数ではサイト内識別子として無効な文字を除外する。標準ではパラメータ$keyの内容はまず英大文字を英小文字に一括変換し、その後で英小文字、数字、アンダーバー（_）、ハイフン（_）以外の文字が取り除かれる。

使用例

  • 変数$keyをサイト内識別子向けにサニタイズする。

フィルター

[3.0.0]サニタイズされた内容を返す直前に'sanitize_key'フィルターを呼び出す。パラメータ$keyにはサニタイズされた内容が、$raw_keyには本関数が受け取ったパラメータの内容が格納されている。
return apply_filters( 'sanitize_key', $key, $raw_key );

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/formatting.php

最終更新 : 2023年05月22日 04:44

関連

参考

Code Reference: sanitize_key

お勧め

Login rebuilder 2.3.0の新機能を紹介（2018年5月27日 更新）

プラグイン「Login rebuilder」はログイン時の履歴（ログ）や不正なログインページへのアクセス履歴を保存している。これらの履歴情報はダッシュボートで確認できるが、バージョン2.3.0においてそれぞれがダウンロードできるようになった。

古めのリビジョンを削除した時のメモ（2022年5月16日 更新）

大きく育ったデータベースを整理するため、古めのリビジョンとそれに紐づいたカスタムフィールドデータを削除。と思ったら「The total number of locks exceeds the lock table size」というエラーが発生して削除できなかった。

決まった値を返すだけの関数群（2018年5月27日 更新）

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。

「Align widgets horizontally」プラグインのフィルター使用例（2024年5月15日 更新）

ダッシュボードのウィジェットを横並びに変える「Align widgets horizontally」プラグインには緒設定を変更できるフィルターが用意されている。ここではフィルターの使い方と設定できる項目について紹介する。

WP_Postオブジェクトで投稿情報を直感的に使う（2012年10月4日 更新）

WordPress 3.5で登場するであろう WP_Postクラス。WordPressの投稿情報は、投稿情報本体のほか、カテゴリーや投稿タグ、カスタムフィールドなど、いくつかに分散して記録され、それぞれの情報を取得する際は、いくつかの関数をしていた。新しいWP_Postクラスにより、その習慣とおさらばできるかもしれない。