wp_register_colors_support()


WordPressの関数wp_register_colors_support()は、テーマやプラグインでカスタムカラーパレットを登録するために使用されます。

構文

wp_register_colors_support( string $feature, array $args = array() );

引数の説明:

  • $feature(string)—サポートする機能名(例:’editor-color-palette’)
  • $args(array)—カラーパレットの設定を含む配列

例1:基本カラーパレットの登録

エディターにカスタムカラーパレットを追加します。

wp_register_colors_support('editor-color-palette',array('name'=>'黒','slug'=>'black','color'=>'#000000'));

例2:複数色の登録

複数のカラーを一度に登録します。

wp_register_colors_support('editor-color-palette',array(array('name'=>'赤','slug'=>'red','color'=>'#ff0000'),array('name'=>'青','slug'=>'blue','color'=>'#0000ff')));

例3:テーマサポートとの組み合わせ

テーマでカラーパレットサポートを有効にします。

add_theme_support('editor-color-palette');wp_register_colors_support('editor-color-palette',array('name'=>'緑','slug'=>'green','color'=>'#00ff00'));

例4:スラッグの使用

登録したスラッグを使ってスタイルを適用します。

wp_register_colors_support('editor-color-palette',array('name'=>'白','slug'=>'white','color'=>'#ffffff'));add_filter('block_editor_settings_all',function($settings){$settings['styles'][]=array('css'=>'.has-white-color{color:#ffffff !important;}');return $settings;});

例5:条件付き登録

特定の条件下でのみカラーパレットを登録します。

if(is_admin()){wp_register_colors_support('editor-color-palette',array('name'=>'グレー','slug'=>'gray','color'=>'#808080'));}

例6:動的カラー生成

PHPで動的にカラーを生成して登録します。

$custom_color=rand_color();wp_register_colors_support('editor-color-palette',array('name'=>'カスタム','slug'=>'custom','color'=>$custom_color));

例7:プラグイン内での使用

プラグインからカラーパレットを追加します。

add_action('after_setup_theme',function(){wp_register_colors_support('editor-color-palette',array('name'=>'ゴールド','slug'=>'gold','color'=>'#ffd700'));});

注意点:

  • この関数はafter_setup_themeフック以降で使用する必要があります
  • カラーコードは有効なHEX形式である必要があります
  • スラッグ名は一意である必要があります

関連機能: