sanitize_html_class

説明

string sanitize_html_class( string $class [ , string $fallback = '' ] )
HTMLのクラス名向けにサニタイズする。

パラメータ

  • $class
    クラス名を指定。
  • $fallback
    サニタイズした結果が空になった場合に代替となるクラス名を指定(省略時は'')。

返り値

サニタイズしたクラス名を返す。

注意

パラメータ$classに日本語のURLエンコードしたものが含まれる場合、それらは除外される。例えば'未分類'カテゴリーのスラッグは'%e6%9c%aa%e5%88%86%e9%a1%9e'となるが、これを本関数でサニタイズした場合の返り値は''となる。

パラメータ$fallbackはサニタイズされないので、クラス名として有効なもの(半角英数字、_、-の組み合わせ)を指定しなければならない。


使用例

  • $categoryのslugプロパティをHTMLのクラス名向けにサニタイズする。
    <?php $class = sanitize_html_class( $category->slug ); ?>
  • $categoryのslugプロパティをHTMLのクラス名向けにサニタイズする。slugプロパティが無効な内容の場合はidとする。
    <?php $class = sanitize_html_class( $category->slug, $category->id ); ?>

フィルター

サニタイズしたクラス名を返す直前に'sanitize_html_class'フィルターを呼び出す。パラメータ$sanitizedにはサニタイズしたクラス名が、その他のパラメータには本関数が受け取った値となる。
return apply_filters( 'sanitize_html_class', $sanitized, $class, $fallback );

アクション

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

ソースファイル

/wp-includes/formatting.php

最終更新 : 2014年01月13日 17:05



お勧め

管理画面でツールバー(Admin bar)を非表示にする(2013年3月5日 更新)

WordPress使ってちょっと変わったサイトを構築する際、管理画面のツールバーを表示させたくないケースがある。一般に公開するサイト側であれば、 show_admin_bar関数で非表示にできるのだが、管理画面ではこれを使ってもツールバーは消えてくれない。

サイドバーの初期化はwidgets_initアクションで(2011年7月14日 更新)

ウィジェットを使ってみたくなり新テーマ「Twenty Eleven」を覗いてみると、codexに記載されていた内容と少し違っている。これって「Twenty Ten」ですでに変更されていたんだね。

タイトルが一致する投稿を検索する(2014年2月20日 更新)

WordPressが提供する投稿ページの文字列検索機能の実現には、 query_posts関数(WP_Queryクラス)が大きな役割を担っている。ここで紹介するのは、高機能ゆえに使いこなすのが難しいquery_posts関数(WP_Queryクラス)の使用法の一例である。

投稿ページでユニークなテンプレートを選択しよう(2018年5月27日 更新)

4.7の変更点に「投稿タイプテンプレート」がある。これは従来固定ページ('page')向けに任意のテンプレートを適用できる機能が拡張されたもので、投稿ページ('post')はもちろんカスタム投稿タイプのページにも適用可能になっている。

WordPressの鼓動(2013年10月1日 更新)

WordPressでは、Ajaxを利用する方法の1つとして add_action関数を利用することができる。この方法を調べている過程で、'heartbeat'というおもしろそうなAjaxアクションがあったので、紹介しておく。