Changeset 51955 for trunk/src/wp-admin/includes/plugin.php

Timestamp:

10/29/2021 11:11:32 PM (5 years ago)

Author:

johnbillion

Message:

Docs: Miscellaneous docblock improvements.

See #53399

File:

• trunk/src/wp-admin/includes/plugin.php (modified) (16 diffs)

trunk/src/wp-admin/includes/plugin.php

@@ -1279 +1279 @@
 
 /**
- * Add a top-level menu page.
+ * Adds a top-level menu page.
  *
  * This function takes a capability which will be used to determine whether
@@ -1351 +1351 @@
 
 /**
- * Add a submenu page.
+ * Adds a submenu page.
  *
  * This function takes a capability which will be used to determine whether
@@ -1475 +1475 @@
 
 /**
- * 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
@@ -1499 +1499 @@
 
 /**
- * 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
@@ -1523 +1523 @@
 
 /**
- * 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
@@ -1547 +1547 @@
 
 /**
- * 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
@@ -1571 +1571 @@
 
 /**
- * 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
@@ -1600 +1600 @@
 
 /**
- * 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
@@ -1624 +1624 @@
 
 /**
- * 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
@@ -1648 +1648 @@
 
 /**
- * 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
@@ -1672 +1672 @@
 
 /**
- * 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
@@ -1696 +1696 @@
 
 /**
- * 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
@@ -1720 +1720 @@
 
 /**
- * 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
@@ -1744 +1744 @@
 
 /**
- * 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
@@ -1767 +1772 @@
 
 /**
- * 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
@@ -1795 +1806 @@
 
 /**
- * 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.