WPプラグイン開発入門 (7)アイコン改善

前回までで、概要メタボックスのカスタム投稿タイプ名の前に、WordPress標準のdashiconに含まれるアイコンを表示できるようになりました。しかし、幾らか気になるところがあります。同じアイコンを異なる2箇所で設定しているため、アイコンを変更するときに2箇所変更しなければならないことです。一方はdashicon-*で、もう一方はcontent: \****で指定するため、対応関係が分かりにくいですね。

  • 関数drnp_add_my_custom_post_type() > register_post_type() > menu_icon
  • 関数drnp_add_my_admin_style() > CSS

今回はアイコンの指定にdashicon-*だけを使い、1箇所でできるようにしてみます。

オリジナルのクラス名を付与する

まずは、関数drnp_add_my_custom_post_type_to_right_now()を書き換えます。

PHP
function drnp_add_my_custom_post_type_to_right_now( $elements ) {
	$args       = array(
		'public'   => true,
		'_builtin' => false,
	);
	$post_types = get_post_types( $args, 'object', 'and' );
	foreach ( $post_types as $post_type ) {
		$num_posts = wp_count_posts( $post_type->name );
		if ( $num_posts && $num_posts->publish ) {
			$text = sprintf( '%s件の%s', number_format_i18n( $num_posts->publish ), $post_type->labels->name );
			if ( current_user_can( $post_type->cap->edit_posts ) ) {
				$elements[] = sprintf(
					'<a class="drnp-cpt %1$s-count" href="edit.php?post_type=%1$s"><span class="drnp-cpt-icon dashicons %3$s"></span>%2$s</a>',
					esc_html( $post_type->name ),
					esc_html( $text ),
					esc_html( $post_type->menu_icon )
				);
			} else {
				$elements[] = sprintf(
					'<span class="drnp-cpt %1$s-count"><span class="drnp-cpt-icon dashicons %3$s"></span>%2$s</span></li>',
					esc_html( $post_type->name ),
					esc_html( $text ),
					esc_html( $post_type->menu_icon )
				);
			}
		}
	}
	return $elements;
}
add_filter( 'dashboard_glance_items', 'drnp_add_my_custom_post_type_to_right_now' );
dashboard-right-now-plus.php

カスタム投稿タイプ名を囲むaまたはspanタグにクラスdrnp-cptを付与し、後に加えるCSSでアイコンを表示させないようにします。カスタム投稿タイプのdashiconは、<span class="drnp-cpt-icon dashicons dashicon-アイコン名"></span>として表示します。

PHP
function drnp_add_my_admin_style() {
	echo <<< 'EOT'
	<style>
		#dashboard_right_now .drnp-cpt:before {
			content: none !important;
		}
		#dashboard_right_now .drnp-cpt-icon {
			padding: 0 5px 0 0;
		}
	</style>
	EOT;
}
dashboard-right-now-plus.php

コードまとめ

PHP
<?php
/**
 * Dashboard Right Now Plus
 *
 * @package           DashboardRightNowPlus
 *
 * @wordpress-plugin
 * Plugin Name:       Dashboard Right Now Plus
 * Plugin URI:        https://gist.github.com/web83info/5747ac715e4544b408e91e2ec034ab05/
 * Description:       Add custom post type to "Right Now" meta box on WordPress dashboard
 * Version:           1.0.0
 * Requires at least: 6.4
 * Requires PHP:      7.2
 * Author:            web83info
 * Author URI:        https://labs.web83.info/
 * License:           GPL v2 or later
 * License URI:       https://www.gnu.org/licenses/gpl-2.0.html
 */

/**
 * カスタム投稿タイプdrnp-mycpt-a, drnp-mycpt-b を追加
 *
 * @return void
 */
function drnp_add_my_custom_post_type() {
	$custom_post_types = array(
		'drnp-mycpt-a' => array(
			'type'      => 'drnp-mycpt-a',
			'name'      => 'マイCPT-A',
			'menu_icon' => 'dashicons-bell',
		),
		'drnp-mycpt-b' => array(
			'type'      => 'drnp-mycpt-b',
			'name'      => 'マイCPT-B',
			'menu_icon' => 'dashicons-heart',
		),
	);
	foreach ( $custom_post_types as $custom_post_type ) {
		register_post_type(
			$custom_post_type['type'],
			array(
				'labels'    => array(
					'name'          => $custom_post_type['name'],
					'singular_name' => $custom_post_type['name'],
				),
				'public'    => true,
				'menu_icon' => $custom_post_type['menu_icon'],
			)
		);

		if ( 0 === wp_count_posts( $custom_post_type['type'] )->publish ) {
			for ( $i = 1; $i <= 3; $i++ ) {
				wp_insert_post(
					array(
						'post_type'   => $custom_post_type['type'],
						'post_title'  => $custom_post_type['name'] . ' 記事 #' . $i,
						'post_status' => 'publish',
					)
				);
			}
		}
	}
}
add_action( 'init', 'drnp_add_my_custom_post_type' );

/**
 * アンインストール時にカスタム投稿タイプdrnp-mycpt-a, drnp-mycpt-b の記事を削除
 *
 * @return void
 */
function drnp_uninstall_my_custom_post_type() {
	$args  = array(
		'post_type'   => array(
			'drnp-mycpt-a',
			'drnp-mycpt-b',
		),
		'numberposts' => -1,
	);
	$posts = get_posts( $args );

	foreach ( $posts as $post ) {
		wp_delete_post( $post->ID );
	}
}
register_uninstall_hook( __FILE__, 'drnp_uninstall_my_custom_post_type' );

/**
 * 概要メタボックスにカスタム投稿タイプの件数を表示
 *
 * @param array $elements 追加表示させる内容.
 * @return array 追加表示させる内容.
 */
function drnp_add_my_custom_post_type_to_right_now( $elements ) {
	$args       = array(
		'public'   => true,
		'_builtin' => false,
	);
	$post_types = get_post_types( $args, 'object', 'and' );
	foreach ( $post_types as $post_type ) {
		$num_posts = wp_count_posts( $post_type->name );
		if ( $num_posts && $num_posts->publish ) {
			$text = sprintf( '%s件の%s', number_format_i18n( $num_posts->publish ), $post_type->labels->name );
			if ( current_user_can( $post_type->cap->edit_posts ) ) {
				$elements[] = sprintf(
					'<a class="drnp-cpt %1$s-count" href="edit.php?post_type=%1$s"><span class="drnp-cpt-icon dashicons %3$s"></span>%2$s</a>',
					esc_html( $post_type->name ),
					esc_html( $text ),
					esc_html( $post_type->menu_icon )
				);
			} else {
				$elements[] = sprintf(
					'<span class="drnp-cpt %1$s-count"><span class="drnp-cpt-icon dashicons %3$s"></span>%2$s</span></li>',
					esc_html( $post_type->name ),
					esc_html( $text ),
					esc_html( $post_type->menu_icon )
				);
			}
		}
	}
	return $elements;
}
add_filter( 'dashboard_glance_items', 'drnp_add_my_custom_post_type_to_right_now' );

/**
 * 管理画面でのみ読み込むCSS
 *
 * @return void
 */
function drnp_add_my_admin_style() {
	echo <<< 'EOT'
	<style>
		#dashboard_right_now .drnp-cpt:before {
			content: none !important;
		}
		#dashboard_right_now .drnp-cpt-icon {
			padding: 0 5px 0 0;
		}
	</style>
	EOT;
}
add_action( 'admin_enqueue_scripts', 'drnp_add_my_admin_style' );
dashboard-right-now-plus.php
Expand

コメントを残す

メールアドレスが公開されることはありません。 が付いている欄は必須項目です