最後に、プラグイン独自の編集フォーム画面を作ってみましょう。追加したカスタム投稿タイプのアイコン名を管理画面から変更できるようにしてみましょう。
add_options_page()：設定メニューにサブ項目を追加
まずは、プラグイン独自の編集フォームを表示する画面を準備します。前回使用したadd_submenu_page()関数でもよいのですが、設定メニューのサブ項目に追加するにはadd_options_page()を利用することもできます。
add_options_page( string $page_title, string $menu_title, string $capability, string $menu_slug, callable $callback = ”, int $position = null ): string|false
add_options_page() – Function | Developer.WordPress.org
| 値 | 型 | 必須 | デフォルト値 | 内容 |
|---|---|---|---|---|
| 第1引数 | string型の$page_title | 必須 | <title>タグに表示されるテキスト | |
| 第2引数 | string型の$menu_title | 必須 | メニューに表示されるテキスト | |
| 第3引数 | string型の$capability | 必須 | メニュー表示に必要な権限 | |
| 第4引数 | string型の$menu_slug | 必須 | メニューのスラグ | |
| 第5引数 | callable型の$callback | 任意 | ” | ページの内容を表示するコールバック関数 |
| 第6引数 | int型の$position | 任意 | null | メニューの表示順位 |
| 返り値 | string型またはfalse | 成功時：hook_suffix 失敗時： false |
add_submenu_page()と同様に、admin_menuにフックします。
PHP
function drnp_add_options_page() {
add_options_page(
'Dashboard Right Now Plus',
'Dashboard Right Now Plus',
'manage_options',
'dashboard-right-now-plus',
'drnp_add_options_page_html'
);
}
add_action( 'admin_menu', 'drnp_add_options_page' );
function drnp_add_options_page_html() {
echo '<div class="wrap">';
echo '<h1>Dashboard Right Now Plus Setting</h1>';
echo '<form method="post" action="options.php">';
echo '</form>';
echo '</div>';
}ページの内容
第5引数で指定した関数で、実際にページに表示する内容を指定します。WordPress標準の設定ページにならい、以下のようなHTMLタグを出力します。<input>などは後で追加します。
HTML
<div class="wrap">
<h1>タイトル</h1>
<form method="post" action="options.php">
<!-- INPUTなど -->
<!-- SUBMITボタン -->
</form>
</div>
コードまとめ
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 ) {
$dashicon_key = 'drnp_cpt_' . $custom_post_type['type'] . '_dashicon';
add_option( $dashicon_key, $custom_post_type['menu_icon'] );
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,
);
$custom_post_types = get_post_types( $args, 'object', 'and' );
foreach ( $custom_post_types as $custom_post_type ) {
$num_posts = wp_count_posts( $custom_post_type->name );
if ( $num_posts && $num_posts->publish ) {
$text = sprintf( '%s件の%s', number_format_i18n( $num_posts->publish ), $custom_post_type->labels->name );
$dashicon = get_option( 'drnp_cpt_' . $custom_post_type->name . '_dashicon' );
if ( current_user_can( $custom_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( $custom_post_type->name ),
esc_html( $text ),
esc_html( $dashicon )
);
} 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( $custom_post_type->name ),
esc_html( $text ),
esc_html( $dashicon )
);
}
}
}
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' );
/**
* 管理画面のメニューに options.php を読み込む
*
* @return void
*/
function drnp_add_options_php() {
add_submenu_page(
'options-general.php',
'Options',
'Options',
'manage_options',
'options.php'
);
}
add_action( 'admin_menu', 'drnp_add_options_php' );
/**
* 管理画面のメニューにプラグイン独自の設定画面を作成する
*
* @return void
*/
function drnp_add_options_page() {
add_options_page(
'Dashboard Right Now Plus',
'Dashboard Right Now Plus',
'manage_options',
'dashboard-right-now-plus',
'drnp_add_options_page_html'
);
}
add_action( 'admin_menu', 'drnp_add_options_page' );
/**
* プラグイン独自の設定画面の表示内容
*
* @return void
*/
function drnp_add_options_page_html() {
echo '<div class="wrap">';
echo '<h1>Dashboard Right Now Plus Setting</h1>';
echo '<form method="post" action="options.php">';
echo '</form>';
echo '</div>';
}Expand
関連サイト
add_options_page() – Function | Developer.WordPress.org
add_options_page()関数の使い方
