导航|地址|刷新
Sub-Menus – Plugin Handbook | Developer.…

Skip to content

WordPress.org

Showcase

Plugins

Themes

Hosting

News

Resources
Learn WordPress

Documentation

Education

Forums

Developers

Blocks

Patterns

Photos

Openverse ↗︎

WordPress.tv ↗︎

About
About WordPress

Make WordPress

Events

Five for the Future

Enterprise

Gutenberg ↗︎

Job Board ↗︎

Swag Store ↗︎

Get WordPress

Search in WordPress.org

Get WordPress

WordPress.org

WordPress Developer Resources

Sub-Menus

Developer Blog

Code Reference

WP-CLI Commands

Developer Blog

Code Reference

WP-CLI Commands

Home Plugin Handbook Administration MenusSub-Menus

Search

Sub-Menus

In this article
Table of Contents

Add a Sub-Menu
Example

Predefined Sub-Menus

Remove a Sub-Menu

Submitting forms

↑ Back to top

Add a Sub-Menu

To add a new Sub-menu to WordPress Administration, use the add_submenu_page() function.
add_submenu_page( string $parent_slug, string $page_title, string $menu_title, string $capability, string $menu_slug, callable $function = '' );
Example

Lets say we want to add a Sub-menu “WPOrg Options” to the “Tools” Top-level menu.

The first step will be creating a function which will output the HTML. In this function we will perform the necessary security checks and render the options we’ve registered using the Settings API.

We recommend wrapping your HTML using a <div> with a class of wrap.

function wporg_options_page_html() { // check user capabilities if ( ! current_user_can( 'manage_options' ) ) { return; } ?> <div class="wrap"> <h1><?php echo esc_html( get_admin_page_title() ); ?></h1> <form action="options.php" method="post"> <?php // output security fields for the registered setting "wporg_options" settings_fields( 'wporg_options' ); // output setting sections and their fields // (sections are registered for "wporg", each field is registered to a specific section) do_settings_sections( 'wporg' ); // output save settings button submit_button( __( 'Save Settings', 'textdomain' ) ); ?> </form> </div> <?php }
The second step will be registering our WPOrg Options Sub-menu. The registration needs to occur during the admin_menu action hook.
function wporg_options_page() { add_submenu_page( 'tools.php', 'WPOrg Options', 'WPOrg Options', 'manage_options', 'wporg', 'wporg_options_page_html' ); } add_action('admin_menu', 'wporg_options_page');
For a list of parameters and what each do please see the add_submenu_page() in the reference.

Predefined Sub-Menus

Wouldn’t it be nice if we had helper functions that define the $parent_slug for WordPress built-in Top-level menus and save us from manually searching it through the source code?

Below is a list of parent slugs and their helper functions:

add_dashboard_page() – index.php

add_posts_page() – edit.php

add_media_page() – upload.php

add_pages_page() – edit.php?post_type=page

add_comments_page() – edit-comments.php

add_theme_page() – themes.php

add_plugins_page() – plugins.php

add_users_page() – users.php

add_management_page() – tools.php

add_options_page() – options-general.php

add_options_page() – settings.php

add_links_page() – link-manager.php – requires a plugin since WP 3.5+

Custom Post Type – edit.php?post_type=wporg_post_type

Network Admin – settings.php

Remove a Sub-Menu

The process of removing Sub-menus is exactly the same as removing Top-level menus.

Submitting forms

The process of handling form submissions within Sub-menus is exactly the same as Submitting forms within Top-Level Menus.

add_submenu_page() along with all functions for pre-defined sub-menus (add_dashboard_page, add_posts_page, etc.) will return a $hookname, which you can use as the first parameter of add_action in order to handle the submission of forms within custom pages:
function wporg_options_page() { $hookname = add_submenu_page( 'tools.php', 'WPOrg Options', 'WPOrg Options', 'manage_options', 'wporg', 'wporg_options_page_html' ); add_action( 'load-' . $hookname, 'wporg_options_page_html_submit' ); } add_action('admin_menu', 'wporg_options_page');
As always, do not forget to check whether the form is being submitted, do CSRF verification, validation, and sanitization.

First published

September 17, 2014

Last updated

November 17, 2022

PreviousAdministration MenusPrevious: Administration Menus

NextTop-Level MenusNext: Top-Level Menus

Chapters
Chapter list

Plugin Handbook

Introduction to Plugin Development
What is a Plugin?

Plugin Basics
Header Requirements

Activation / Deactivation Hooks

Best Practices

Determining Plugin and Content Directories

Including a Software License

Uninstall Methods

Plugin Security
Checking User Capabilities

Data Validation

Nonces

Securing (escaping) Output

Securing (sanitizing) Input

Hooks
Actions

Filters

Custom Hooks

Advanced Topics

Privacy
Adding the Personal Data Eraser to Your Plugin

Adding the Personal Data Exporter to Your Plugin

Privacy Related Options, Hooks and Capabilities

Suggesting text for the site privacy policy

Administration Menus
Sub-Menus

Top-Level Menus

Shortcodes
Basic Shortcodes

Enclosing Shortcodes

Shortcodes with Parameters

TinyMCE Enhanced Shortcodes

Settings
Custom Settings Page

Options API

Settings API

Using Settings API

Metadata
Managing Post Metadata

Custom Meta Boxes

Rendering Post Metadata

Custom Post Types
Registering Custom Post Types

Working with Custom Post Types

Taxonomies
Term Splitting (WordPress 4.2)

Working with Custom Taxonomies

Users
Roles and Capabilities

Working with User Metadata

Working with Users

HTTP API

REST API
REST API Overview

Routes & Endpoints

Requests

Responses

Schema

Controller Classes

JavaScript
Heartbeat API

jQuery

AJAX

Server Side PHP and Enqueuing

Summary

Cron
Scheduling WP Cron Events

Testing of WP-Cron

Understanding WP-Cron Scheduling

Hooking WP-Cron Into the System Task Scheduler

Internationalization
How to Internationalize Your Plugin

Internationalization Security

Localization

The WordPress.org Plugin Directory
Add Your Plugin to the Block Directory

Alerts and Warnings

Block Specific Plugin Guidelines

Common issues

Compliance Disclaimers

Detailed Plugin Guidelines

How Your Plugin Assets Work

Planning, Submitting, and Maintaining Plugins

Plugin Developer FAQ

Plugin Readmes

Previews and Blueprints

Release Confirmation Emails

Reporting Plugin Security Issues

Special User Roles and Capabilities

Take Over an Existing Plugin

Transferring Your Plugin to a New Owner

Using Subversion

Using the Forums

Using the WordPress.org MCP Server

Developer Tools
Debug Bar and Add-Ons

Helper Plugins

Creating Tables with Plugins

Credits

About

News

Hosting

Privacy

Showcase

Themes

Plugins

Patterns

Learn

Documentation

Developers

WordPress.tv ↗

Get Involved

Events

Donate ↗

Five for the Future

WordPress.com ↗

Matt ↗

bbPress ↗

BuddyPress ↗

WordPress.orgWordPress.org

Visit our X (formerly Twitter) account

Visit our Bluesky account

Visit our Mastodon account

Visit our Threads account

Visit our Facebook page

Visit our Instagram account

Visit our LinkedIn account

Visit our TikTok account

Visit our YouTube channel

Visit our Tumblr account

The WordPress® trademark is the intellectual property of the WordPress Foundation.

------
导航页打开网址