Changeset 47006

Timestamp:

12/23/2019 02:34:10 PM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve documentation for admin menu functions:

• get_admin_page_parent()
• get_admin_page_title()
• get_plugin_page_hook()
• get_plugin_page_hookname()
• user_can_access_admin_page()

Add missing descriptions and @since tags.

Props subrataemfluence, kennithnichol, stevenlinx, SergeyBiryukov.
Fixes #44253, #49067.

File:

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

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

@@ -1797 +1797 @@
 //
 /**
+ * Gets the parent file of the current admin page.
+ *
+ * @since 1.5.0
+ *
  * @global string $parent_file
  * @global array $menu
@@ -1807 +1811 @@
  * @global array $_wp_submenu_nopriv
  *
- * @return string
+ * @return string The parent file of the current admin page.
  */
 function get_admin_page_parent( $parent = '' ) {
@@ -1872 +1876 @@
 
 /**
+ * Gets the title of the current admin page.
+ *
+ * @since 1.5.0
+ *
  * @global string $title
  * @global array $menu
@@ -1879 +1887 @@
  * @global string $typenow
  *
- * @return string
+ * @return string The title of the current admin page.
  */
 function get_admin_page_title() {
@@ -1955 +1963 @@
 
 /**
- * @since 2.3.0
+ * Gets the hook attached to the administrative page of a plugin.
+ *
+ * @since 1.5.0
  *
  * @param string $plugin_page The slug name of the plugin page.
@@ -1972 +1982 @@
 
 /**
+ * Gets the hook name for the administrative page of a plugin.
+ *
+ * @since 1.5.0
+ *
  * @global array $admin_page_hooks
  *
@@ -2001 +2015 @@
 
 /**
+ * Determines whether the current user can access the current admin page.
+ *
+ * @since 1.5.0
+ *
  * @global string $pagenow
- * @global array $menu
- * @global array $submenu
- * @global array $_wp_menu_nopriv
- * @global array $_wp_submenu_nopriv
+ * @global array  $menu
+ * @global array  $submenu
+ * @global array  $_wp_menu_nopriv
+ * @global array  $_wp_submenu_nopriv
  * @global string $plugin_page
- * @global array $_registered_pages
- *
- * @return bool Whether the current user can access the current admin page.
+ * @global array  $_registered_pages
+ *
+ * @return bool True if the current user can access the admin page, false otherwise.
  */
 function user_can_access_admin_page() {