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



お勧め

任意の名前でエラーログファイルを指定する(2019年2月15日 更新)

来週にはWordPress 5.1がリリース。RC1のソースコードを見ていると、 wp_debug_mode関数が変更されており、興味深かった。

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

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

Slightly troublesome permalink:プラグイン作ってみました(2021年4月20日 更新)

カテゴリーを含んだパーマリンクを設定している場合、複数のカテゴリーを指定した投稿記事のパーマリンクのURLに目的のカテゴリーとは異なるカテゴリーが適用された経験はないだろうか。このプラグインは、パーマリンクに適用されるカテゴリーをコントロールし、希望通りのパーマリンクを設定します。

WP_Postオブジェクトで投稿情報を直感的に使う(2012年10月4日 更新)

WordPress 3.5で登場するであろう WP_Postクラス。WordPressの投稿情報は、投稿情報本体のほか、カテゴリーや投稿タグ、カスタムフィールドなど、いくつかに分散して記録され、それぞれの情報を取得する際は、いくつかの関数をしていた。新しいWP_Postクラスにより、その習慣とおさらばできるかもしれない。

テキストエディタの文字を変更する(2018年5月27日 更新)

テキストエディタ(投稿ページの「テキスト」タブのエディタ)に標準では備わっていない機能を追加する自作プラグイン「html entities button」がほぼ1年ぶりにアップデート。ここではバージョン2.0.0で追加したテキストエディタのフォント切り替え機能について紹介する。