vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2026-04-08 06:34:34 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Docs: Miscellaneous docblock improvements.

Browse Source 
See #53399


git-svn-id: https://develop.svn.wordpress.org/trunk@51955 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
John Blackbourn
2021-10-29 23:11:32 +00:00
parent 86c54d872e
commit ec5ed03bf6
6 changed files with 44 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

43
src/wp-admin/includes/plugin.php
View File

@@ -1278,7 +1278,7 @@ function uninstall_plugin( $plugin ) {
//
/**
* Add a top-level menu page.
* Adds a top-level menu page.
*
* This function takes a capability which will be used to determine whether
* or not a page is included in the menu.
@@ -1350,7 +1350,7 @@ function add_menu_page( $page_title, $menu_title, $capability, $menu_slug, $func
}
/**
* Add a submenu page.
* Adds a submenu page.
*
* This function takes a capability which will be used to determine whether
* or not a page is included in the menu.
@@ -1474,7 +1474,7 @@ function add_submenu_page( $parent_slug, $page_title, $menu_title, $capability,
}
/**
* Add submenu page to the Tools main menu.
* Adds a submenu page to the Tools main menu.
*
* This function takes a capability which will be used to determine whether
* or not a page is included in the menu.
@@ -1498,7 +1498,7 @@ function add_management_page( $page_title, $menu_title, $capability, $menu_slug,
}
/**
* Add submenu page to the Settings main menu.
* Adds a submenu page to the Settings main menu.
*
* This function takes a capability which will be used to determine whether
* or not a page is included in the menu.
@@ -1522,7 +1522,7 @@ function add_options_page( $page_title, $menu_title, $capability, $menu_slug, $f
}
/**
* Add submenu page to the Appearance main menu.
* Adds a submenu page to the Appearance main menu.
*
* This function takes a capability which will be used to determine whether
* or not a page is included in the menu.
@@ -1546,7 +1546,7 @@ function add_theme_page( $page_title, $menu_title, $capability, $menu_slug, $fun
}
/**
* Add submenu page to the Plugins main menu.
* Adds a submenu page to the Plugins main menu.
*
* This function takes a capability which will be used to determine whether
* or not a page is included in the menu.
@@ -1570,7 +1570,7 @@ function add_plugins_page( $page_title, $menu_title, $capability, $menu_slug, $f
}
/**
* Add submenu page to the Users/Profile main menu.
* Adds a submenu page to the Users/Profile main menu.
*
* This function takes a capability which will be used to determine whether
* or not a page is included in the menu.
@@ -1599,7 +1599,7 @@ function add_users_page( $page_title, $menu_title, $capability, $menu_slug, $fun
}
/**
* Add submenu page to the Dashboard main menu.
* Adds a submenu page to the Dashboard main menu.
*
* This function takes a capability which will be used to determine whether
* or not a page is included in the menu.
@@ -1623,7 +1623,7 @@ function add_dashboard_page( $page_title, $menu_title, $capability, $menu_slug,
}
/**
* Add submenu page to the Posts main menu.
* Adds a submenu page to the Posts main menu.
*
* This function takes a capability which will be used to determine whether
* or not a page is included in the menu.
@@ -1647,7 +1647,7 @@ function add_posts_page( $page_title, $menu_title, $capability, $menu_slug, $fun
}
/**
* Add submenu page to the Media main menu.
* Adds a submenu page to the Media main menu.
*
* This function takes a capability which will be used to determine whether
* or not a page is included in the menu.
@@ -1671,7 +1671,7 @@ function add_media_page( $page_title, $menu_title, $capability, $menu_slug, $fun
}
/**
* Add submenu page to the Links main menu.
* Adds a submenu page to the Links main menu.
*
* This function takes a capability which will be used to determine whether
* or not a page is included in the menu.
@@ -1695,7 +1695,7 @@ function add_links_page( $page_title, $menu_title, $capability, $menu_slug, $fun
}
/**
* Add submenu page to the Pages main menu.
* Adds a submenu page to the Pages main menu.
*
* This function takes a capability which will be used to determine whether
* or not a page is included in the menu.
@@ -1719,7 +1719,7 @@ function add_pages_page( $page_title, $menu_title, $capability, $menu_slug, $fun
}
/**
* Add submenu page to the Comments main menu.
* Adds a submenu page to the Comments main menu.
*
* This function takes a capability which will be used to determine whether
* or not a page is included in the menu.
@@ -1743,7 +1743,12 @@ function add_comments_page( $page_title, $menu_title, $capability, $menu_slug, $
}
/**
* Remove a top-level admin menu.
* Removes a top-level admin menu.
*
* Example usage:
*
* - `remove_menu_page( 'tools.php' )`
* - `remove_menu_page( 'plugin_menu_slug' )`
*
* @since 3.1.0
*
@@ -1766,7 +1771,13 @@ function remove_menu_page( $menu_slug ) {
}
/**
* Remove an admin submenu.
* Removes an admin submenu.
*
* Example usage:
*
* - `remove_submenu_page( 'themes.php', 'nav-menus.php' )`
* - `remove_submenu_page( 'tools.php', 'plugin_submenu_slug' )`
* - `remove_submenu_page( 'plugin_menu_slug', 'plugin_submenu_slug' )`
*
* @since 3.1.0
*
@@ -1794,7 +1805,7 @@ function remove_submenu_page( $menu_slug, $submenu_slug ) {
}
/**
* Get the URL to access a particular menu page based on the slug it was registered with.
* Gets the URL to access a particular menu page based on the slug it was registered with.
*
* If the slug hasn't been registered properly, no URL will be returned.
*