概要
admin_print_stylesアクションは、WordPress管理画面でのスタイルシートの出力をカスタマイズするために使用されます。このフックを利用することで、特定の管理画面において独自のCSSを追加したり、既存のスタイルを調整したりできます。具体的なユースケースとしては、次のようなものがあります：
- プラグインの管理ページに特定のスタイルを適用する場合
- 管理画面でのウィジェットの外観を変更する場合
- カスタムメタボックスのスタイルを整える場合
- WooCommerceの商品管理ページにスタイルを追加する場合
- プラグインの設定ページのデザインを統一する場合
- 特定の条件下でだけCSSを適用する場合
構文
add_action('admin_print_styles', 'custom_admin_styles');
function custom_admin_styles() {
// スタイルシートを追加する処理
}
パラメータ
admin_print_stylesアクションは、特定のパラメータを持ちません。フックが実行されるときに、スタイルの出力が行われます。
戻り値
このアクションは戻り値を持たず、主にスタイルシートを追加するために使用されます。
使用可能なバージョン
- WooCommerceバージョン: すべてのWooCommerceバージョンで使用可能。
- WordPressバージョン: 3.0以降のすべてのWordPressバージョンで使用可能。
この関数のアクションでの使用可能性
| アクション名 | 使用例 |
|---|---|
| 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: 管理ページ専用CSSの追加
add_action('admin_print_styles', 'my_custom_admin_css');
function my_custom_admin_css() {
wp_enqueue_style('my-admin-style', plugin_dir_url(__FILE__) . 'css/admin-style.css');
}
このコードは、カスタムプラグインにおいて管理画面に独自のCSSファイル admin-style.css を追加します。
引用元: https://developer.wordpress.org/reference/hooks/admin_print_styles/
サンプル2: カスタムポストタイプのエディタースタイル
add_action('admin_print_styles', 'custom_post_type_styles');
function custom_post_type_styles() {
if (get_post_type() == 'my_custom_post_type') {
wp_enqueue_style('my-custom-post-type-style', plugin_dir_url(__FILE__) . 'css/custom-post-type.css');
}
}
このコードは、特定のカスタムポストタイプの管理画面にのみスタイルを適用します。
引用元: https://developer.wordpress.org/reference/hooks/admin_print_styles/
サンプル3: WooCommerce のスタイルのカスタマイズ
add_action('admin_print_styles', 'woocommerce_admin_styles');
function woocommerce_admin_styles() {
if (class_exists('WooCommerce')) {
wp_enqueue_style('woocommerce-custom-admin', plugin_dir_url(__FILE__) . 'css/woocommerce-admin.css');
}
}
WooCommerceが有効な場合にのみ、管理画面にスタイルを追加します。
引用元: https://developer.wordpress.org/reference/hooks/admin_print_styles/
サンプル4: 特定のユーザー役割のみにスタイルを適用
add_action('admin_print_styles', 'role_specific_admin_styles');
function role_specific_admin_styles() {
if (current_user_can('administrator')) {
wp_enqueue_style('admin-role-style', plugin_dir_url(__FILE__) . 'css/admin-role.css');
}
}
このコードは、管理者ユーザーにのみ特定のスタイルを適用します。
引用元: https://developer.wordpress.org/reference/hooks/admin_print_styles/
サンプル5: プラグイン設定ページ用スタイル
add_action('admin_print_styles', 'plugin_settings_styles');
function plugin_settings_styles() {
$current_screen = get_current_screen();
if ($current_screen->id === 'settings_page_my_plugin') {
wp_enqueue_style('my-plugin-settings-style', plugin_dir_url(__FILE__) . 'css/plugin-settings.css');
}
}
特定のプラグイン設定ページでのみスタイルを追加します。
引用元: https://developer.wordpress.org/reference/hooks/admin_print_styles/