Changeset 45085

Timestamp:

04/01/2019 02:08:01 PM (6 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve documentation for get_plugin_page_hook() and get_plugin_page_hookname().

Props subrataemfluence, desrosj.
Fixes #44224.

File:

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

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

@@ -1355 +1355 @@
 
     /*
-     * Backward-compatibility for plugins using add_management page.
-     * See wp-admin/admin.php for redirect from edit.php to tools.php
+     * Backward-compatibility for plugins using add_management_page().
+     * See wp-admin/admin.php for redirect from edit.php to tools.php.
      */
     if ( 'tools.php' == $parent_slug ) {
@@ -1714 +1714 @@
  * @global array $_wp_menu_nopriv
  * @global array $_wp_submenu_nopriv
+ *
+ * @return string
  */
 function get_admin_page_parent( $parent = '' ) {
@@ -1784 +1786 @@
  * @global string $plugin_page
  * @global string $typenow
+ *
+ * @return string
  */
 function get_admin_page_title() {
@@ -1860 +1864 @@
  * @since 2.3.0
  *
- * @param string $plugin_page
- * @param string $parent_page
- * @return string|null
+ * @param string $plugin_page The slug name of the plugin page.
+ * @param string $parent_page The slug name for the parent menu (or the file name of a standard
+ *                            WordPress admin page).
+ * @return string|null Hook attached to the plugin page, null otherwise.
  */
 function get_plugin_page_hook( $plugin_page, $parent_page ) {
@@ -1875 +1880 @@
 /**
  * @global array $admin_page_hooks
- * @param string $plugin_page
- * @param string $parent_page
+ *
+ * @param string $plugin_page The slug name of the plugin page.
+ * @param string $parent_page The slug name for the parent menu (or the file name of a standard
+ *                            WordPress admin page).
+ * @return string Hook name for the plugin page.
  */
 function get_plugin_page_hookname( $plugin_page, $parent_page ) {
@@ -1907 +1915 @@
  * @global string $plugin_page
  * @global array $_registered_pages
+ *
+ * @return bool Whether the current user can access the current admin page.
  */
 function user_can_access_admin_page() {