概要
sanitize_hex_color_no_hash関数は、’#’のついていない16進数のカラー値をサニタイズするために使用されます。この関数を利用することで、ユーザーから提供されたカラーコードが正しい形式であるかどうかを確認し、無効な値を排除することができます。以下は、この関数がよく使われるシーンの例です。
- 管理画面でのテーマカスタマイザーの設定
- プラグインのユーザー設定フォーム
- カラー選択のためのカスタムフィールド
- サイトのスタイル設定
- ユーザー入力に基づくダイナミックなスタイル生成
- ウィジェット設定でのカラーオプション
- 投稿やページでのビジュアルエディタの拡張
- 設定オプションでのカラーピッカーの実装
構文
string sanitize_hex_color_no_hash( string $color )
パラメータ
$color(string): サニタイズしたいカラー値（’#’なしの16進数カラーコード）。
戻り値
- (string): サニタイズされた16進数カラーコード。無効な場合は
nullを返します。
関連する関数
使用可能なバージョン
この関数は、WordPress 3.1以降から使用可能です。特定のバージョンで非推奨や削除された情報はありません。
コアファイルのパス
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 |
サンプルコード
サンプルコード 1
$color_input = 'FF5733';
$sanitized_color = sanitize_hex_color_no_hash($color_input);
echo $sanitized_color; // 出力: FF5733
このサンプルコードは、’#’なしのカラーコード’FF5733’をサニタイズし、有効なカラー値として出力します。
サンプルコード 2
$color_input = 'GG1234';
$sanitized_color = sanitize_hex_color_no_hash($color_input);
echo $sanitized_color; // 出力: null
このサンプルでは、無効なカラーコード’GG1234’がサニタイズされ、nullが出力されます。
サンプルコード 3
$color_input = '123456';
if ($sanitized_color = sanitize_hex_color_no_hash($color_input)) {
echo "Valid color: " . $sanitized_color;
} else {
echo "Invalid color input.";
}
このサンプルでは、ユーザーのカラー入力が有効か無効かをチェックし、それに応じたメッセージを表示します。
サンプルコード 4
function set_custom_color($input) {
return sanitize_hex_color_no_hash($input);
}
$custom_color = set_custom_color('AABBCC');
echo $custom_color; // 出力: AABBCC
このサンプルコードでは、カスタム関数内でサニタイズを行い、その結果を返します。
サンプルコード 5
$theme_color = isset($_POST['theme_color']) ? sanitize_hex_color_no_hash($_POST['theme_color']) : 'FFFFFF';
echo "Theme color set to: " . $theme_color;
このサンプルでは、POSTリクエストから取得したカラー値をサニタイズし、デフォルト値を設定しています。