rest_parse_hex_color()


WordPressのrest_parse_hex_color()関数は、HEX形式のカラーコードを検証し、正規化するために使用されます。REST APIでカラーデータを処理する際に便利です。

構文

rest_parse_hex_color( string $color );
  • $color(string)—検証するHEXカラーコード（3桁または6桁、#あり/なし）

例1: 3桁のHEXカラーを正規化

3桁のHEXカラーを6桁に変換します。

$normalized = rest_parse_hex_color( '#abc' );

例2: #なしの6桁カラーを処理

#が付いていない場合も正しく処理されます。

$normalized = rest_parse_hex_color( 'ff00ff' );

例3: 無効なカラーコードの処理

無効な値はnullを返します。

$result = rest_parse_hex_color( 'invalid' );

例4: 大文字のHEXコードを小文字に変換

大文字も小文字に正規化されます。

$normalized = rest_parse_hex_color( '#FF00FF' );

例5: ショートコード内での使用

ショートコードでカラーバリデーションを行います。

add_shortcode('color', function($atts){ return rest_parse_hex_color($atts['color']); });

例6: REST APIレスポンスでの利用

APIエンドポイントでカラーデータを処理します。

register_rest_field('post','color',['update_callback'=>function($value){return rest_parse_hex_color($value);}]);

例7: カスタムオプションの保存前処理

テーマオプション保存時にカラーを検証します。

add_filter('pre_update_option_theme_color',function($new){return rest_parse_hex_color($new)?:$old;});

注意事項

  • アルファチャンネルを含むHEXコード（#RRGGBBAA）はサポートされていません
  • 空文字列を渡した場合もnullが返されます
  • この関数はWordPress 4.7以降で利用可能です

関連機能：