WordPress 4.1.2

[autoinstalls/wordpress.git] / wp-admin / admin.php

diff --git a/wp-admin/admin.php b/wp-admin/admin.php
index 85979327011b8f06f83b882d7a7bb7d6d78c84b7..793dc511f6824e95531a881286271664ee6a1465 100644 (file)
--- a/wp-admin/admin.php
+++ b/wp-admin/admin.php
@@ -11,8 +11,9 @@
  *
  * @since 2.3.2
  */
-if ( ! defined('WP_ADMIN') )
-       define('WP_ADMIN', true);
+if ( ! defined( 'WP_ADMIN' ) ) {
+       define( 'WP_ADMIN', true );
+}
 
 if ( ! defined('WP_NETWORK_ADMIN') )
        define('WP_NETWORK_ADMIN', false);
@@ -50,8 +51,8 @@ if ( get_option('db_upgraded') ) {
         * Filter whether to attempt to perform the multisite DB upgrade routine.
         *
         * In single site, the user would be redirected to wp-admin/upgrade.php.
-        * In multisite, it is automatically fired, but only when this filter
-        * returns true.
+        * In multisite, the DB upgrade routine is automatically fired, but only
+        * when this filter returns true.
         *
         * If the network is 50 sites or less, it will run every time. Otherwise,
         * it will throttle itself to reduce load.
@@ -66,13 +67,7 @@ if ( get_option('db_upgraded') ) {
                if ( $c <= 50 || ( $c > 50 && mt_rand( 0, (int)( $c / 50 ) ) == 1 ) ) {
                        require_once( ABSPATH . WPINC . '/http.php' );
                        $response = wp_remote_get( admin_url( 'upgrade.php?step=1' ), array( 'timeout' => 120, 'httpversion' => '1.1' ) );
-                       /**
-                        * Fires after the multisite DB upgrade is complete.
-                        *
-                        * @since 3.0.0
-                        *
-                        * @param array|WP_Error $response The upgrade response array or WP_Error on failure.
-                        */
+                       /** This action is documented in wp-admin/network/upgrade.php */
                        do_action( 'after_mu_upgrade', $response );
                        unset($response);
                }
@@ -156,7 +151,8 @@ if ( isset($plugin_page) ) {
                $the_parent = $pagenow;
        if ( ! $page_hook = get_plugin_page_hook($plugin_page, $the_parent) ) {
                $page_hook = get_plugin_page_hook($plugin_page, $plugin_page);
-               // backwards compatibility for plugins using add_management_page
+
+               // Backwards compatibility for plugins using add_management_page().
                if ( empty( $page_hook ) && 'edit.php' == $pagenow && '' != get_plugin_page_hook($plugin_page, 'tools.php') ) {
                        // There could be plugin specific params on the URL, so we need the whole query string
                        if ( !empty($_SERVER[ 'QUERY_STRING' ]) )
@@ -189,14 +185,14 @@ if ( isset($plugin_page) ) {
                 * The load-* hook fires in a number of contexts. This hook is for plugin screens
                 * where a callback is provided when the screen is registered.
                 *
-                * The dynamic portion of the hook name, $page_hook, refers to a mixture of plugin
+                * The dynamic portion of the hook name, `$page_hook`, refers to a mixture of plugin
                 * page information including:
                 * 1. The page type. If the plugin page is registered as a submenu page, such as for
                 *    Settings, the page type would be 'settings'. Otherwise the type is 'toplevel'.
                 * 2. A separator of '_page_'.
                 * 3. The plugin basename minus the file extension.
                 *
-                * Together, the three parts form the $page_hook. Citing the example above,
+                * Together, the three parts form the `$page_hook`. Citing the example above,
                 * the hook name used would be 'load-settings_page_pluginbasename'.
                 *
                 * @see get_plugin_page_hook()
@@ -210,8 +206,7 @@ if ( isset($plugin_page) ) {
                /**
                 * Used to call the registered callback for a plugin screen.
                 *
-                * @access private
-                *
+                * @internal
                 * @since 1.5.0
                 */
                do_action( $page_hook );
@@ -228,7 +223,7 @@ if ( isset($plugin_page) ) {
                 * The load-* hook fires in a number of contexts. This hook is for plugin screens
                 * where the file to load is directly included, rather than the use of a function.
                 *
-                * The dynamic portion of the hook name, $plugin_page, refers to the plugin basename.
+                * The dynamic portion of the hook name, `$plugin_page`, refers to the plugin basename.
                 *
                 * @see plugin_basename()
                 *
@@ -268,7 +263,7 @@ if ( isset($plugin_page) ) {
        /**
         * Fires before an importer screen is loaded.
         *
-        * The dynamic portion of the hook name, $importer, refers to the importer slug.
+        * The dynamic portion of the hook name, `$importer`, refers to the importer slug.
         *
         * @since 3.5.0
         */
@@ -295,8 +290,9 @@ if ( isset($plugin_page) ) {
         *
         * @param bool false Whether to force data to be filtered through kses. Default false.
         */
-       if ( apply_filters( 'force_filtered_html_on_import', false ) )
+       if ( apply_filters( 'force_filtered_html_on_import', false ) ) {
                kses_init_filters();  // Always filter imported data with kses on multisite.
+       }
 
        call_user_func($wp_importers[$importer][2]);
 
@@ -312,15 +308,19 @@ if ( isset($plugin_page) ) {
         *
         * The load-* hook fires in a number of contexts. This hook is for core screens.
         *
-        * The dynamic portion of the hook name, $pagenow, is a global variable
+        * The dynamic portion of the hook name, `$pagenow`, is a global variable
         * referring to the filename of the current page, such as 'admin.php',
-        * 'post-new.php' etc. A complete hook for the latter would be 'load-post-new.php'.
+        * 'post-new.php' etc. A complete hook for the latter would be
+        * 'load-post-new.php'.
         *
         * @since 2.1.0
         */
        do_action( 'load-' . $pagenow );
-       // Backwards compatibility with old load-page-new.php, load-page.php,
-       // and load-categories.php actions.
+
+       /*
+        * The following hooks are fired to ensure backward compatibility.
+        * In all other cases, 'load-' . $pagenow should be used instead.
+        */
        if ( $typenow == 'page' ) {
                if ( $pagenow == 'post-new.php' )
                        do_action( 'load-page-new.php' );
@@ -338,8 +338,8 @@ if ( ! empty( $_REQUEST['action'] ) ) {
        /**
         * Fires when an 'action' request variable is sent.
         *
-        * The dynamic portion of the hook name, $_REQUEST['action'],
-        * refers to the action derived from the GET or POST request.
+        * The dynamic portion of the hook name, `$_REQUEST['action']`,
+        * refers to the action derived from the `GET` or `POST` request.
         *
         * @since 2.6.0
         */