関数

remove_submenu_page()を解説：WordPress管理サブメニューの削除方法について解説

2025-02-19更新日: 2025-02-19

remove_submenu_page()は、WordPress管理画面から不要なサブメニューを削除するための関数です。

親メニューと対象のサブメニューのスラッグを指定するだけで、管理画面の項目を簡単にカスタマイズできます。

実行タイミングはadmin_menuフックに連携するのが推奨され、ユーザー権限にも注意しながらテストを行う必要があります。

目次から探す

remove_submenu_page()の基本
- 関数の役割と概要
- 動作の流れ
実装手順とパラメータ指定
- admin_menuフックとの連携
- スラッグ指定のポイント
返り値の仕様とエラー処理
- 成功時の返り値構造
- 失敗時の返り値とチェック
デバッグと動作確認方法
- グローバル変数「$submenu」を用いた検証
- error_log出力の利用方法
ユーザー権限とアクセス制御
- 権限チェックの実装ポイント
- URL直打ちによるアクセス防止策
まとめ

remove_submenu_page()の基本

関数の役割と概要

remove_submenu_page()は、WordPress管理画面に表示されるサブメニューの中から不要な項目を取り除くための関数です。

特定の親メニューと連動して登録されているサブメニューのスラッグを指定することで、管理画面から当該メニューを非表示にすることができます。

管理画面の項目を整理し、ユーザーが意図しない機能へアクセスするリスクを低減する目的で利用されることが多いです。

返り値として、削除に成功した場合は削除されたメニュー項目の情報が配列で返され、削除対象が存在しなかった場合は false が返されます。

動作の流れ

remove_submenu_page()の処理は、WordPressが管理画面のメニューを構築する際に実行されます。

入力された親メニューとサブメニューのスラッグをもとに、グローバル変数に保持されているメニュー情報から該当項目を探索し、見つかった場合にその要素を削除する仕組みです。

グローバル変数「$submenu」の活用

WordPressの管理画面では、サブメニューの情報がグローバル変数$submenuに格納されています。

この変数は配列形式で、各親メニューに対するサブメニュー項目がリストで保持されています。

remove_submenu_page()は、まず$submenu内の指定された親メニューの配列を探し、その中から指定されたサブメニューのスラッグに一致する項目を見つけ出します。

削除が成功すると、その項目が配列から取り除かれるため、ユーザーには表示されなくなります。

実行タイミングの管理

remove_submenu_page()を正しく動作させるためには、実行タイミングの調整が重要です。

WordPressの管理画面は初期化フェーズを経てメニューが生成されるため、admin_menuフックなどを用いて管理画面が構築されるタイミングで実行する必要があります。

適切なフックが使われない場合、削除対象の項目がすでに出力された後になってしまい、期待した動作が得られない可能性があります。

実装手順とパラメータ指定

admin_menuフックとの連携

WordPressの管理画面の初期化フェーズに合わせて、remove_submenu_page()を実行するために、admin_menuフックと連携して実装するのが一般的です。

このフックを利用することで、メニュー項目が生成された後に不要なサブメニューを削除するタイミングをコントロールできます。

実行タイミングの設定

管理画面のメニューが生成される前に実行されると、削除対象のサブメニューが存在しないため、正しく動作しません。

そこでadmin_menuフックを利用し、メニューが生成された後にremove_submenu_page()を呼び出すように設定します。

例えば、以下のサンプルコードでは、admin_menuフックに優先度を指定して実行タイミングを調整しています。

// 管理画面でのメニュー生成後に削除処理を行うため、優先度を高めに設定する例
function custom_remove_submenu() {
    // 'themes.php'が親メニュー、'widgets.php'が削除対象のサブメニュー
    $removed_menu = remove_submenu_page('themes.php', 'widgets.php');
    if ($removed_menu !== false) {
        error_log('削除されたサブメニュー: ' . print_r($removed_menu, true));
    }
}
add_action('admin_menu', 'custom_remove_submenu', 999);

Array
(
    [0] => Widgets
    [1] => edit_theme_options
    [2] => widgets.php
)

優先度の指定

admin_menuフックにおける優先度の指定は、他のプラグインやテーマによる後続処理に対して確実に削除処理を行うために重要です。

優先度を高く指定することで、管理画面のすべてのサブメニューが生成された後にremove_submenu_page()を実行でき、対象のサブメニューが確実に削除されるように調整します。

スラッグ指定のポイント

remove_submenu_page()を利用する際に、正確なスラッグの指定は非常に大切です。

誤ったスラッグを指定すると、削除対象とならず、意図した動作にならない可能性があります。

ここでは、親メニューとサブメニューの各識別子について説明します。

親メニューの識別子

親メニューの識別子は、WordPressの管理画面の各メニューに一意に割り当てられているスラッグです。

たとえば、外観メニューの場合はthemes.phpが指定されます。

この識別子を正確に指定することで、対象となるサブメニューが存在するグループを特定できます。

サブメニューの識別子

サブメニューの識別子は、親メニューに紐づく各サブメニューを一意に特定するための文字列です。

対象のサブメニューが正しく特定されることで、remove_submenu_page()は該当項目を正しく削除します。

例えば、外観メニューに表示されるウィジェット管理の場合、widgets.phpが該当するスラッグとなります。

返り値の仕様とエラー処理

成功時の返り値構造

remove_submenu_page()が正常に動作した場合、削除されたサブメニューの情報が配列形式で返されます。

返り値の配列は以下のように構成されています。

0番目の要素: サブメニューのタイトル(文字列)
1番目の要素: アクセスに必要な権限、または能力(文字列)
2番目の要素: サブメニューのURLに対応するスラッグ(文字列)

下記のサンプルコードは、削除成功時に返り値の内容をログ出力する例です。

function log_removed_submenu() {
    $removed_menu = remove_submenu_page('themes.php', 'widgets.php');
    if ($removed_menu !== false) {
        // 各要素の情報をログに出力する例
        error_log('メニュータイトル: ' . $removed_menu[0]);
        error_log('必要な権限: ' . $removed_menu[1]);
        error_log('メニュースラッグ: ' . $removed_menu[2]);
    }
}
add_action('admin_menu', 'log_removed_submenu', 999);

メニュータイトル: Widgets
必要な権限: edit_theme_options
メニュースラッグ: widgets.php

失敗時の返り値とチェック

remove_submenu_page()が削除対象のサブメニューを見つけられなかった場合、返り値は false となります。

返り値のチェックを行うことで、削除処理が意図通りに動作しているかを確認でき、エラーが発生した場合には引数の指定などを再検討する必要があります。

指定ミスや対象外ケースの確認

返り値が false の場合、以下の点を確認するとよいでしょう。

親メニュースラッグが正しいか確認する。
サブメニュースラッグが正しいか、$submenu内の情報を確認して判断する。
他のプラグインやテーマが同じサブメニューに影響を与えていないか検討する。

これらのチェックにより、誤ったパラメータ指定や対象外ケースに起因する問題を迅速に特定できます。

デバッグと動作確認方法

グローバル変数「$submenu」を用いた検証

remove_submenu_page()の動作確認において、グローバル変数$submenuの内容を参照する方法が有効です。

管理画面の生成前後で$submenuの内容をログに出力することで、対象のサブメニューが実際に削除されているかを確認できます。

下記のサンプルコードでは、削除前と削除後の$submenuの状況を比較しています。

// 削除前のサブメニュー情報をログ出力
function debug_submenu_before() {
    error_log('削除前のサブメニュー情報:' . print_r($GLOBALS['submenu'], true));
}
add_action('admin_menu', 'debug_submenu_before', 50);
// 削除処理と削除後の情報出力
function debug_remove_submenu() {
    remove_submenu_page('themes.php', 'widgets.php');
    error_log('削除後のサブメニュー情報:' . print_r($GLOBALS['submenu'], true));
}
add_action('admin_menu', 'debug_remove_submenu', 999);

// 削除前: 対象のサブメニュー 'widgets.php' が含まれている内容(省略)
// 削除後: 'widgets.php' の項目が存在しない内容(省略)

error_log出力の利用方法

WordPressの標準関数であるerror_log()を活用することで、remove_submenu_page()の動作をデバッグする際にエラーや処理結果を確認できます。

error_log()は、コード実行中に発生するメッセージをログファイルへ出力するため、ブラウザ上に不要な情報を表示せずに内部の動作状況を把握できます。

具体的な使用例として、削除処理の直前と直後にログメッセージを挿入し、想定通りに対象メニューが削除されているかを検証する方法が挙げられます。

ユーザー権限とアクセス制御

権限チェックの実装ポイント

remove_submenu_page()自体はメニュー削除に特化した関数ですが、ユーザーがアクセスできるメニュー項目を管理する際は、追加の権限チェックが重要となります。

具体的には、対象のサブメニューを削除する前に、現在のユーザーが必要な権限を有しているかを確認する実装を合わせると良いでしょう。

たとえば、以下のサンプルコードでは、権限チェックを実施した上で不要なサブメニューを削除しています。

function secure_remove_submenu() {
    if (current_user_can('manage_options')) { // ユーザー権限チェックの例
        remove_submenu_page('themes.php', 'widgets.php');
    }
}
add_action('admin_menu', 'secure_remove_submenu', 999);

// 管理者権限を持つユーザーの場合、削除処理が実行される

URL直打ちによるアクセス防止策

サブメニューを非表示にするだけでは、ユーザーが直接ブラウザのアドレスバーにURLを入力することでアクセスできてしまう可能性があります。

そのため、URL直打ちでのアクセスを防止するための追加対策が求められます。

具体的には、管理画面内で該当ファイルや機能に対して適切な権限チェックを実装する方法が効果的です。

これにより、非表示になったサブメニューのURLを直接叩いた場合でも、不正アクセスを防ぐことが可能となります。

まとめ

本記事では、remove_submenu_page()の役割や動作概要、正しいパラメータの指定方法とadmin_menuフックとの連携方法を説明しました。

さらに、返り値の仕様やエラー処理、グローバル変数$submenuとerror_logを用いたデバッグ方法、ユーザー権限を考慮した安全なメニュー非表示処理とURL直打ち対策について学ぶことができます。