概要
sanitize_html_class関数は、HTMLのクラス名向けにサニタイズするために使用されます。クラス名はHTML要素のスタイルやスクリプトを制御するために重要な役割を果たしており、特にユーザーからの入力を扱う場合は、適切にサニタイズすることが求められます。この関数は、HTMLクラス名として適切でない文字を取り除き、予約語の衝突を避けるためにも用いられます。
使用されるシナリオ
この関数は、以下のようなシナリオで頻繁に利用されます：
- ユーザーが入力するカスタムクラスを処理
- プラグインやテーマの設定で指定されたクラス名を安全に処理
- UI要素に動的にクラスを追加する際のサニタイズ
- 投稿やカスタムタイプに基づくクラス名の生成
- リストやグリッド表示における動的クラス名の生成
- CSSスタイルを適用するためのクラス名決定
- アクセシビリティを考慮したクラス名の管理
- テーマやプラグインの互換性を保つためのクラス名のサニタイズ
構文
sanitize_html_class( string $class, string|null $fallback = null ): string
パラメータ
$class(string): サニタイズするHTMLクラス名。$fallback(string|null): サニタイズに失敗した場合に使用するフォールバッククラス。省略可。
戻り値
- string: サニタイズされたHTMLクラス名。
関連する関数
使用可能なバージョン
sanitize_html_class関数は、WordPress 3.0.0以降で使用できます。
コアファイルのパス
sanitize_html_class関数は、次のコアファイルに含まれています：wp-includes/formatting.php。
この関数のアクションでの使用可能性
| アクション | 使用例 |
|---|---|
| mu_plugin_loaded | |
| registered_post_type | 〇 |
| plugins_loaded | 〇 |
| wp_roles_init | |
| setup_theme | |
| after_setup_theme | |
| set_current_user | |
| init | 〇 |
| register_sidebar | 〇 |
| wp_loaded | |
| send_headers | |
| parse_query | |
| pre_get_posts | |
| wp | |
| template_redirect | |
| get_header | |
| wp_head | 〇 |
sanitize_html_class関数は、特定のバージョンで非推奨または削除されたことはありません。