enmi-conf.org: comparison wp/wp-admin/admin.php

equal deleted inserted replaced

-:346c88efed21
+:5e2f62d02dcd
 /**
 * In WordPress Administration Screens
 *
 * @since 2.3.2
 */
-if ( ! defined('WP_ADMIN') )
+if ( ! defined( 'WP_ADMIN' ) ) {
-	define('WP_ADMIN', true);
+	define( 'WP_ADMIN', true );
+}
 if ( ! defined('WP_NETWORK_ADMIN') )
 	define('WP_NETWORK_ADMIN', false);
 if ( ! defined('WP_USER_ADMIN') )
 	/**
 	 * 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
+	 * In multisite, the DB upgrade routine is automatically fired, but only
-	 * returns true.
+	 * 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.
 	 *
 	 * @since 3.0.0
 	 *
 	 * @param bool true Whether to perform the Multisite upgrade routine. Default true.
 	 */
 	} elseif ( apply_filters( 'do_mu_upgrade', true ) ) {
 		$c = get_blog_count();
-		// If 50 or fewer sites, run every time. Else, run "about ten percent" of the time. Shh, don't check that math.
+		/*
+		 * If there are 50 or fewer sites, run every time. Otherwise, throttle to reduce load:
+		 * attempt to do no more than threshold value, with some +/- allowed.
+		 */
 		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' ) );
-			/**
+			/** This action is documented in wp-admin/network/upgrade.php */
-			 * 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.
-			 */
 			do_action( 'after_mu_upgrade', $response );
 			unset($response);
 		}
 		unset($c);
 	}
 $date_format = get_option('date_format');
 $time_format = get_option('time_format');
 wp_enqueue_script( 'common' );
+// $pagenow is set in vars.php
+// $wp_importers is sometimes set in wp-admin/includes/import.php
+//
+// The remaining variables are imported as globals elsewhere,
+//     declared as globals here
+global $pagenow, $wp_importers, $hook_suffix, $plugin_page, $typenow, $taxnow;
+$page_hook = null;
 $editing = false;
 if ( isset($_GET['page']) ) {
 	$plugin_page = wp_unslash( $_GET['page'] );
 		$the_parent = $pagenow . '?post_type=' . $typenow;
 	else
 		$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' ]) )
 				$query_string = $_SERVER[ 'QUERY_STRING' ];
 			else
 	}
 	unset($the_parent);
 }
 $hook_suffix = '';
-if ( isset($page_hook) )
+if ( isset( $page_hook ) ) {
 	$hook_suffix = $page_hook;
-else if ( isset($plugin_page) )
+} elseif ( isset( $plugin_page ) ) {
 	$hook_suffix = $plugin_page;
-else if ( isset($pagenow) )
+} elseif ( isset( $pagenow ) ) {
 	$hook_suffix = $pagenow;
+}
 set_current_screen();
 // Handle plugin admin pages.
 if ( isset($plugin_page) ) {
 		 * Fires before a particular screen is loaded.
 		 *
 		 * 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()
 		 *
 		 * @since 2.1.0
 			require_once(ABSPATH . 'wp-admin/admin-header.php');
 		/**
 		 * Used to call the registered callback for a plugin screen.
 		 *
-		 * @access private
+		 * @ignore
-		 *
 		 * @since 1.5.0
 		 */
 		do_action( $page_hook );
 	} else {
 		if ( validate_file($plugin_page) )
 		 * Fires before a particular screen is loaded.
 		 *
 		 * 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()
 		 *
 		 * @since 1.5.0
 		 */
 	}
 	include(ABSPATH . 'wp-admin/admin-footer.php');
 	exit();
-} else if (isset($_GET['import'])) {
+} elseif ( isset( $_GET['import'] ) ) {
 	$importer = $_GET['import'];
 	if ( ! current_user_can('import') )
 		wp_die(__('You are not allowed to import.'));
 	}
 	/**
 	 * 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
 	 */
 	do_action( 'load-importer-' . $importer );
 	 *
 	 * @since 3.1.0
 	 *
 	 * @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]);
 	include(ABSPATH . 'wp-admin/admin-footer.php');
 	/**
 	 * Fires before a particular screen is loaded.
 	 *
 	 * 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' );
 		elseif ( $pagenow == 'post.php' )
 			do_action( 'load-page.php' );
 if ( ! empty( $_REQUEST['action'] ) ) {
 	/**
 	 * Fires when an 'action' request variable is sent.
 	 *
-	 * The dynamic portion of the hook name, $_REQUEST['action'],
+	 * The dynamic portion of the hook name, `$_REQUEST['action']`,
-	 * refers to the action derived from the GET or POST request.
+	 * refers to the action derived from the `GET` or `POST` request.
 	 *
 	 * @since 2.6.0
 	 */
 	do_action( 'admin_action_' . $_REQUEST['action'] );
 }

changeset 5	5e2f62d02dcd
parent 0	d970ebf37754
child 7	cf61fcea0001