admin_color_scheme_picker()

admin_color_scheme_picker() は、WordPress 管理画面でユーザーがカラースキーム（配色テーマ）を選択できるようにするための関数です。

WordPress にはデフォルトでいくつかのカラースキームが用意されており、ユーザーはプロフィール画面で好きな色を選択できます。この関数は、管理画面のデザインをカスタマイズしたい場合や、独自のカラースキームを追加した際に、選択オプションを提供するために使用されます。

機能の説明

admin_color_scheme_picker() とは？

• WordPress の管理画面でカラースキーム（配色テーマ）を選択する UI を表示する関数
• ユーザーのプロフィール設定ページでカラースキームを選択可能にする
• add_action('admin_init', ...) などと組み合わせて独自のカラースキームを追加する際にも利用可能

使用する場面

• WordPress の管理画面のデザインを変更したい場合
• 独自のカラースキームを追加し、選択できるようにしたい場合
• カスタムプラグインやテーマで、管理画面の見た目を変更したい場合

シンプルなコード例

function my_admin_color_scheme() {
    admin_color_scheme_picker();
}
add_action('admin_head', 'my_admin_color_scheme');

• admin_color_scheme_picker(); は、管理画面のカラースキーム選択 UI を描画
• admin_head フックを使うことで、管理画面に適用

使い方の説明

基本的な使い方

管理画面のカラースキーム選択を有効化するには、以下のコードを追加します。

function add_admin_color_scheme_picker() {
    ?>
    <div class="color-scheme-picker">
        <?php admin_color_scheme_picker(); ?>
    </div>
    <?php
}
add_action('admin_head', 'add_admin_color_scheme_picker');

このコードを追加すると、管理画面のヘッダー部分にカラースキーム選択 UI が表示されます。

カスタムカラースキームを追加して選択できるようにする

独自のカラースキームを追加し、admin_color_scheme_picker() を使って選択 UI を表示する場合は、以下のように記述します。

function my_custom_admin_color_scheme() {
    wp_admin_css_color(
        'my_custom_scheme',
        __('My Custom Scheme'),
        get_template_directory_uri() . '/admin-color-scheme.css',
        array('#1d2327', '#23282d', '#0073aa', '#00a0d2')
    );
}
add_action('admin_init', 'my_custom_admin_color_scheme');

• wp_admin_css_color() を使用して独自のカラースキームを追加
• admin_color_scheme_picker() を呼び出すことで、選択 UI を有効化
• get_template_directory_uri() . '/admin-color-scheme.css' の部分で独自のCSSを指定

一緒に使うことが多い関連タグ

wp_admin_css_color()

カスタムのカラースキームを追加するために使用します。

wp_admin_css_color(
    'custom_theme',
    __('Custom Theme'),
    get_template_directory_uri() . '/custom-theme.css',
    array('#222222', '#333333', '#0073aa', '#0099d8')
);

• custom_theme：カラースキームの識別子
• __('Custom Theme')：表示名
• get_template_directory_uri() . '/custom-theme.css'：CSSファイルのURL
• array('#222222', '#333333', '#0073aa', '#0099d8')：カラーパレット

追加情報で取得したい場合

ユーザーの選択したカラースキームを取得

get_user_option('admin_color') を使うと、現在のユーザーのカラースキームを取得できます。

$current_color_scheme = get_user_option('admin_color');
echo '現在のカラースキーム: ' . $current_color_scheme;

想定されるトラブル

カスタムカラースキームが反映されない

解決方法

• CSSのパスが正しいか確認する
• wp_admin_css_color() を admin_init フック内で適用しているか確認
• キャッシュが影響していないか確認（キャッシュをクリアする）

admin_color_scheme_picker() が表示されない

解決方法

• admin_color_scheme_picker() を admin_head フック内で適用しているか確認
• ユーザーが適切な権限を持っているか確認（管理者以外のユーザーには表示されない可能性がある）

Q＆A

まとめ

admin_color_scheme_picker() は、WordPress の管理画面でユーザーがカラースキームを選択できる UI を提供する関数です。

wp_admin_css_color() と組み合わせることで、独自のカラースキームを作成し、ユーザーに選択肢を提供できます。カラースキームの取得や変更も可能で、管理画面のデザインを柔軟にカスタマイズする際に役立ちます。