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



お勧め

Gutenbergでカスタムフィールドを使う(2018年8月10日 更新)

Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。

さくらのVPSでKUSANAGI(2018年5月27日 更新)

請け負っていた業務が一段落したので、「さくらのVPS」で「KUSANAGI」を試してみました。推奨環境はメモリ4GBとなっているが、今回は実験的な利用なので、SSD 2GBプランでトライしました。

ホームディレクトリから過去のファイルを削除する(2013年1月27日 更新)

WordPressで構築したサイトのホームディレクトリには、現在使われていないファイルが残っている時がある。3.5.1もリリースされたことだし、これを機にホームディレクトリを整理整頓した。

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

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

各投稿記事で設定されているカスタムフィールドの値を取得するには(2011年9月16日 更新)

投稿記事ごとに設定されているカスタムフィールドの値は get_post_meta関数で取得できるが、すべての投稿記事で設定されているカスタムフィールドの値を一覧を取得する関数が見当たらない。カテゴリーや投稿タグのようにそれぞれの値と実際に使用されている投稿記事件数を取得したいのだが、探し方が悪いのか見つからないのだ。