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

最終更新 : 2018年05月27日 10:44



お勧め

フィードにサムネイル画像を追加する(2022年11月1日 更新)

WordPressが出力するの標準のフィードには、各投稿のサムネイル画像の情報が含まれていない。ネットで検索してみるといくつかの方法があることがわかったので、その中から2つ試してみた。

投稿一覧に「投稿フォーマット」フィルターが追加される(2019年4月12日 更新)

WordPress 5.2 Beta2(以降5.2Beta2)のソースコードを眺めていると、投稿一覧ページのフィルター機能に「投稿フォーマット」(select要素)が追加されていた。

5.5の機能強化:コメントフォームのちょっとした改良(2020年8月12日 更新)

来月にリリースされるWordPress 5.5に向けてBeta 1、2、3と公開が続いている。「WordPress 5.5 Beta 3(以降Beta 3)」のソースコードを見ていくと、コメントフォームを表示する comment_form関数が機能拡張されていた。

Login rebuilderに「XML-RPC設定」を追加しました(2018年5月27日 更新)

公式サイトで公開しているプラグイン「Login rebuilder」をバージョンアップし、XML-RPCリクエストの管理機能を追加しました。Login rebuilderの主たる機能は、ログインページをサイト別にユニークなURLに変更し、ログインページへの不正アクセスを回避することです。WordPressのXML-RPCリクエストはピンバックや外部ツールやサイトなどとの連携に利用されていますが、今回追加した機能ではXML-RPCリクエストの処理に対していくつかの制限できるようにしています。

index.htmlでアーカイブページを表示させる(2011年10月14日 更新)

静的なサイトでは、各ディレクトリにindex.htmlファイルを置き、そのディレクトリの内容を紹介することが多い。WordPressで構築したサイトも同様にできないかと考え、試行錯誤してみた(こんなことを考えてるのは自分だけだろうか!?)。