Ticket #37770: wp-admin-includes-plugin-php.patch

wp-admin/includes/plugin.php

@@ -1494 +1494 @@
 //
 // Pluggable Menu Support -- Private
 //
+
 /**
+ * Get the admin page parent.
  *
  * @global string $parent_file
- * @global array $menu
- * @global array $submenu
+ * @global array  $menu
+ * @global array  $submenu
  * @global string $pagenow
  * @global string $typenow
  * @global string $plugin_page
- * @global array $_wp_real_parent_file
- * @global array $_wp_menu_nopriv
- * @global array $_wp_submenu_nopriv
+ * @global array  $_wp_real_parent_file
+ * @global array  $_wp_menu_nopriv
+ * @global array  $_wp_submenu_nopriv
+ *
+ * @param  string $parent
+ *
+ * @return string
  */
 function get_admin_page_parent( $parent = '' ) {
         global $parent_file, $menu, $submenu, $pagenow, $typenow,
@@ -1563 +1569 @@
 }
 
 /**
+ * Get the admin page title.
  *
  * @global string $title
- * @global array $menu
- * @global array $submenu
+ * @global array  $menu
+ * @global array  $submenu
  * @global string $pagenow
  * @global string $plugin_page
  * @global string $typenow
+ *
+ * @return string
  */
 function get_admin_page_title() {
         global $title, $menu, $submenu, $pagenow, $plugin_page, $typenow;
@@ -1643 +1652 @@
 }
 
 /**
+ * Get the plugin page hook.
+ *
  * @since 2.3.0
  *
  * @param string $plugin_page
  * @param string $parent_page
+ *
  * @return string|null
  */
 function get_plugin_page_hook( $plugin_page, $parent_page ) {
@@ -1658 +1670 @@
 }
 
 /**
+ * Get the plugin page hook name.
  *
  * @global array $admin_page_hooks
+ *
  * @param string $plugin_page
  * @param string $parent_page
+ *
+ * @return string
  */
 function get_plugin_page_hookname( $plugin_page, $parent_page ) {
         global $admin_page_hooks;
@@ -1685 +1701 @@
 }
 
 /**
+ * Whether the user can access admin page or not.
  *
  * @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
+ * @global array  $_registered_pages
+ *
+ * @return bool
  */
 function user_can_access_admin_page() {
         global $pagenow, $menu, $submenu, $_wp_menu_nopriv, $_wp_submenu_nopriv,
@@ -1771 +1790 @@
  *
  * @global array $new_whitelist_options
  *
- * @param string $option_group A settings group name. Should correspond to a whitelisted option key name.
- *      Default whitelisted option key names include "general," "discussion," and "reading," among others.
- * @param string $option_name The name of an option to sanitize and save.
+ * @param string   $option_group      A settings group name. Should correspond to a whitelisted option key name.
+ *                                        Default whitelisted option key names include "general," "discussion," and "reading," among others.
+ * @param string   $option_name       The name of an option to sanitize and save.
  * @param callable $sanitize_callback A callback function that sanitizes the option's value.
  */
 function register_setting( $option_group, $option_name, $sanitize_callback = '' ) {
@@ -1801 +1820 @@
  *
  * @global array $new_whitelist_options
  *
- * @param string   $option_group
- * @param string   $option_name
- * @param callable $sanitize_callback
+ * @param string   $option_group      A settings group name. Should correspond to a whitelisted option key name.
+ *                                        Default whitelisted option key names include "general," "discussion," and "reading," among others.
+ * @param string   $option_name       The name of an option to sanitize and save.
+ * @param callable $sanitize_callback A callback function that sanitizes the option's value.
  */
 function unregister_setting( $option_group, $option_name, $sanitize_callback = '' ) {
         global $new_whitelist_options;
@@ -1927 +1947 @@
  *
  * @since 3.7.0
  *
- * @param bool $clear_update_cache Whether to clear the Plugin updates cache
+ * @param bool $clear_update_cache Whether to clear the Plugin updates cache.
  */
 function wp_clean_plugins_cache( $clear_update_cache = true ) {
         if ( $clear_update_cache )
@@ -1936 +1956 @@
 }
 
 /**
- * @param string $plugin
+ * Plugin sandbox scrape
+ *
+ * @param string $plugin Plugin path to main plugin file with plugin data.
  */
 function plugin_sandbox_scrape( $plugin ) {
         wp_register_plugin_realpath( WP_PLUGIN_DIR . '/' . $plugin );