sanitize_key

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

説明

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

パラメータ

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

返り値

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

注意

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

使用例

  • 変数$keyをサイト内識別子向けにサニタイズする。
    $key = sanitize_key( $key ) ?>

フィルター

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

アクション

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

ソースファイル

/wp-includes/formatting.php

関連

お勧めコンテンツ

ダッシュボードのフィードボックスをカスタマイズ(2011年7月8日 登録)

管理者ページのトップページ「ダッシュボード」には、「WordPress 開発者ブログ」と「WordPress フォーラム」という2つのフィードボックスが表示されている。自分のような開発者には有益な情報をもたらしているが、一般の方には必要のない情報かもしれない。今回はこのフィードボックスをカスタマイズする方法を紹介する(管理者権限)。

各種リンクを取得する関数一覧(2014年6月12日 登録)

サイト設計において、ページ間の相互リンクは重要である。WordPressでは各種ページのリンク(パーマリンク)を取得する関数を用意しており、それらを一通り把握しておくべきだろう。

常時SSL接続に変更しました(2017年3月3日 登録)

先週末、本サイトを常時SSL接続に変更しました。本サイトは「さくらのVPS」(CentOS 6系、Apache 2.2系)上にWordPressのマルチサイト機能を使って構築しており、無償で使用できる「Let's Encrypt」を使って常時SSL接続に切り替えた手順をメモとして残しそうと思います。

タイトルのみをキーワード検索する(2014年4月3日 登録)

WordPressのキーワード検索は、投稿タイトルと本文のどちらかに指定したキーワードが含まれているかを調べるわけだが、時々タイトルだけとか、逆に本文だけ検索したいケースがある。

3.8の「アクティビティ」ウィジェットに投稿以外の情報も表示する(2014年1月17日 登録)

ちょうど1月前の「ダッシュボードの「概要」にカスタム投稿タイプ件数を表示する」にて、WordPress 3.8新ダッシュボードの「概要」ウィジェットにカスタム投稿タイプの投稿数を表示する方法を紹介したが、今回のその続編で「アクティビティ」ウィジェットを拡張する方法を紹介する。

最終更新日時 : 2016-08-10 13:48