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



お勧め

カスタムフィールド関連関数のおさらい(2012年6月22日 更新)

カスタムフィールドは、投稿記事の拡張情報としてよく利用されている。投稿ページで登録した情報をアーカイブや投稿ページで表示しているが、投稿ページを表示する際にカスタムフィールドの値を更新して、サイドバーのようなページ内要素に利用したりしている。

MOファイルを作ってみた(2018年7月25日 更新)

テーマやプラグインで使用するMOファイルはWindows環境では「Poedit」アプリを使うことが多かったが、最近では「GlotPress」のようなプラグインも増えてきており、選択肢は広がっている。定期的に開発環境を見直す過程で「Poedit」から「GlotPress」に切り替えようと思ったのだが、微妙にしっくりこなかった。

日本語名のユーザーを登録する(2018年5月27日 更新)

標準のログインID(ユーザー名)は、英数字と一部の記号の組み合わせで構成されている。一般的なシステムのログインIDはおおむねこんな感じだが、ふと「インターネット環境ならログインIDに日本語が使用できてもいいんじゃないか」と思い、実現できるか調べてみた。

ショートコードを使ってテーマ内の画像URLを簡単に指定する(2018年5月27日 更新)

投稿記事の中で画像パーツを使いたいときがある。画像パーツの配置場所は、/imgディレクトリのようなテーマ外の場合と、/wp-content/themes/mytheme/imagesディレクトリのようなテーマ内の場合があり、今回は後者のケース。ショートコードを使って投稿記事の画像ファイルのURLを記述する方法を紹介したい。

HTML entities button:プラグイン作ってみました(2017年12月17日 更新)

以前投稿した「HTML編集モードに定型文ボタンを追加する」をアレンジして、HTML編集モードに特殊文字(HTMLエンティティ)を挿入できるボタン、顔文字を挿入できるボタン、過去の投稿ページのリンクを挿入できるボタンを追加するプラグインを作ってみました。HTML編集モードの作業効率を向上させるプラグインです。2.1.0では「Dashiconsの挿入」を追加しました。HTML編集モードをメインに使用されている方は、お試しあれ。