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

equal deleted inserted replaced

-:34716fd837a4
+:be944660c56a
 * the file. This is not checked however and the file is only opened for
 * reading.
 *
 * @since 1.5.0
 * @since 5.3.0 Added support for `Requires at least` and `Requires PHP` headers.
+* @since 5.8.0 Added support for `Update URI` header.
 *
 * @param string $plugin_file Absolute path to the main plugin file.
 * @param bool   $markup      Optional. If the returned data should have HTML markup applied.
 *                            Default true.
 * @param bool   $translate   Optional. If the returned data should be translated. Default true.
 *     @type string $TextDomain  Plugin textdomain.
 *     @type string $DomainPath  Plugins relative directory path to .mo files.
 *     @type bool   $Network     Whether the plugin can only be activated network-wide.
 *     @type string $RequiresWP  Minimum required version of WordPress.
 *     @type string $RequiresPHP Minimum required version of PHP.
+*     @type string $UpdateURI   ID of the plugin for update purposes, should be a URI.
 * }
 */
 function get_plugin_data( $plugin_file, $markup = true, $translate = true ) {
 	$default_headers = array(
 		'TextDomain'  => 'Text Domain',
 		'DomainPath'  => 'Domain Path',
 		'Network'     => 'Network',
 		'RequiresWP'  => 'Requires at least',
 		'RequiresPHP' => 'Requires PHP',
+		'UpdateURI'   => 'Update URI',
 		// Site Wide Only is deprecated in favor of Network.
 		'_sitewide'   => 'Site Wide Only',
 	);
 	$plugin_data = get_file_data( $plugin_file, $default_headers, 'plugin' );
 	if ( ! empty( $plugin_folder ) ) {
 		$plugin_root .= $plugin_folder;
 	}
 	// Files in wp-content/plugins directory.
-	$plugins_dir  = @ opendir( $plugin_root );
+	$plugins_dir  = @opendir( $plugin_root );
 	$plugin_files = array();
 	if ( $plugins_dir ) {
 		while ( ( $file = readdir( $plugins_dir ) ) !== false ) {
 			if ( '.' === substr( $file, 0, 1 ) ) {
 				continue;
 			}
 			if ( is_dir( $plugin_root . '/' . $file ) ) {
-				$plugins_subdir = @ opendir( $plugin_root . '/' . $file );
+				$plugins_subdir = @opendir( $plugin_root . '/' . $file );
 				if ( $plugins_subdir ) {
 					while ( ( $subfile = readdir( $plugins_subdir ) ) !== false ) {
 						if ( '.' === substr( $subfile, 0, 1 ) ) {
 							continue;
 	$requirements = validate_plugin_requirements( $plugin );
 	if ( is_wp_error( $requirements ) ) {
 		return $requirements;
 	}
-	if ( ( $network_wide && ! isset( $current[ $plugin ] ) ) || ( ! $network_wide && ! in_array( $plugin, $current, true ) ) ) {
+	if ( $network_wide && ! isset( $current[ $plugin ] )
+		|| ! $network_wide && ! in_array( $plugin, $current, true )
+	) {
 		if ( ! empty( $redirect ) ) {
 			// We'll override this later if the plugin can be included without fatal error.
 			wp_redirect( add_query_arg( '_error_nonce', wp_create_nonce( 'plugin-activation-error_' . $plugin ), $redirect ) );
 		}
 		ob_start();
-		if ( ! defined( 'WP_SANDBOX_SCRAPING' ) ) {
+		// Load the plugin to test whether it throws any errors.
-			define( 'WP_SANDBOX_SCRAPING', true );
+		plugin_sandbox_scrape( $plugin );
-		}
-		wp_register_plugin_realpath( WP_PLUGIN_DIR . '/' . $plugin );
-		$_wp_plugin_file = $plugin;
-		include_once WP_PLUGIN_DIR . '/' . $plugin;
-		$plugin = $_wp_plugin_file; // Avoid stomping of the $plugin variable in a plugin.
 		if ( ! $silent ) {
 			/**
 			 * Fires before a plugin is activated.
 			 *
 		if ( ob_get_length() > 0 ) {
 			$output = ob_get_clean();
 			return new WP_Error( 'unexpected_output', __( 'The plugin generated unexpected output.' ), $output );
 		}
 		ob_end_clean();
 	}
 	return null;
 }
 		$plugin = plugin_basename( trim( $plugin ) );
 		if ( ! is_plugin_active( $plugin ) ) {
 			continue;
 		}
-		$network_deactivating = false !== $network_wide && is_plugin_active_for_network( $plugin );
+		$network_deactivating = ( false !== $network_wide ) && is_plugin_active_for_network( $plugin );
 		if ( ! $silent ) {
 			/**
 			 * Fires before a plugin is deactivated.
 			 *
 		$this_plugin_dir = trailingslashit( dirname( $plugins_dir . $plugin_file ) );
 		// If plugin is in its own directory, recursively delete the directory.
 		// Base check on if plugin includes directory separator AND that it's not the root plugin folder.
-		if ( strpos( $plugin_file, '/' ) && $this_plugin_dir != $plugins_dir ) {
+		if ( strpos( $plugin_file, '/' ) && $this_plugin_dir !== $plugins_dir ) {
 			$deleted = $wp_filesystem->delete( $this_plugin_dir, true );
 		} else {
 			$deleted = $wp_filesystem->delete( $plugins_dir . $plugin_file );
 		}
 		if ( ! $deleted ) {
 			$errors[] = $plugin_file;
 			continue;
 		}
+		$plugin_slug = dirname( $plugin_file );
+		if ( 'hello.php' === $plugin_file ) {
+			$plugin_slug = 'hello-dolly';
+		}
 		// Remove language files, silently.
-		$plugin_slug = dirname( $plugin_file );
 		if ( '.' !== $plugin_slug && ! empty( $plugin_translations[ $plugin_slug ] ) ) {
 			$translations = $plugin_translations[ $plugin_slug ];
 			foreach ( $translations as $translation => $data ) {
 				$wp_filesystem->delete( WP_LANG_DIR . '/plugins/' . $plugin_slug . '-' . $translation . '.po' );
 * Validates the plugin requirements for WordPress version and PHP version.
 *
 * Uses the information from `Requires at least` and `Requires PHP` headers
 * defined in the plugin's main PHP file.
 *
-* If the headers are not present in the plugin's main PHP file,
-* `readme.txt` is also checked as a fallback.
-*
 * @since 5.2.0
 * @since 5.3.0 Added support for reading the headers from the plugin's
 *              main PHP file, with `readme.txt` as a fallback.
+* @since 5.8.0 Removed support for using `readme.txt` as a fallback.
 *
 * @param string $plugin Path to the plugin file relative to the plugins directory.
 * @return true|WP_Error True if requirements are met, WP_Error on failure.
 */
 function validate_plugin_requirements( $plugin ) {
 	$requirements = array(
 		'requires'     => ! empty( $plugin_headers['RequiresWP'] ) ? $plugin_headers['RequiresWP'] : '',
 		'requires_php' => ! empty( $plugin_headers['RequiresPHP'] ) ? $plugin_headers['RequiresPHP'] : '',
 	);
-	$readme_file = WP_PLUGIN_DIR . '/' . dirname( $plugin ) . '/readme.txt';
-	if ( file_exists( $readme_file ) ) {
-		$readme_headers = get_file_data(
-			$readme_file,
-			array(
-				'requires'     => 'Requires at least',
-				'requires_php' => 'Requires PHP',
-			),
-			'plugin'
-		);
-		$requirements = array_merge( $readme_headers, $requirements );
-	}
 	$compatible_wp  = is_wp_version_compatible( $requirements['requires'] );
 	$compatible_php = is_php_version_compatible( $requirements['requires_php'] );
-	/* translators: %s: URL to Update PHP page. */
 	$php_update_message = '</p><p>' . sprintf(
+		/* translators: %s: URL to Update PHP page. */
 		__( '<a href="%s">Learn more about updating PHP</a>.' ),
 		esc_url( wp_get_update_php_url() )
 	);
 	$annotation = wp_get_update_php_annotation();
 * Calls the uninstall hook, if it is available.
 *
 * @since 2.7.0
 *
 * @param string $plugin Path to the plugin file relative to the plugins directory.
-* @return true True if a plugin's uninstall.php file has been found and included.
+* @return true|void True if a plugin's uninstall.php file has been found and included.
+*                   Void otherwise.
 */
 function uninstall_plugin( $plugin ) {
 	$file = plugin_basename( $plugin );
 	$uninstallable_plugins = (array) get_option( 'uninstall_plugins' );
 	 * If the parent doesn't already have a submenu, add a link to the parent
 	 * as the first item in the submenu. If the submenu file is the same as the
 	 * parent file someone is trying to link back to the parent manually. In
 	 * this case, don't automatically add a link back to avoid duplication.
 	 */
-	if ( ! isset( $submenu[ $parent_slug ] ) && $menu_slug != $parent_slug ) {
+	if ( ! isset( $submenu[ $parent_slug ] ) && $menu_slug !== $parent_slug ) {
 		foreach ( (array) $menu as $parent_menu ) {
-			if ( $parent_menu[2] == $parent_slug && current_user_can( $parent_menu[1] ) ) {
+			if ( $parent_menu[2] === $parent_slug && current_user_can( $parent_menu[1] ) ) {
 				$submenu[ $parent_slug ][] = array_slice( $parent_menu, 0, 4 );
 			}
 		}
 	}
 * @since 3.1.0
 *
 * @global array $menu
 *
 * @param string $menu_slug The slug of the menu.
-* @return array|bool The removed menu on success, false if not found.
+* @return array|false The removed menu on success, false if not found.
 */
 function remove_menu_page( $menu_slug ) {
 	global $menu;
 	foreach ( $menu as $i => $item ) {
-		if ( $menu_slug == $item[2] ) {
+		if ( $menu_slug === $item[2] ) {
 			unset( $menu[ $i ] );
 			return $item;
 		}
 	}
 *
 * @global array $submenu
 *
 * @param string $menu_slug    The slug for the parent menu.
 * @param string $submenu_slug The slug of the submenu.
-* @return array|bool The removed submenu on success, false if not found.
+* @return array|false The removed submenu on success, false if not found.
 */
 function remove_submenu_page( $menu_slug, $submenu_slug ) {
 	global $submenu;
 	if ( ! isset( $submenu[ $menu_slug ] ) ) {
 		return false;
 	}
 	foreach ( $submenu[ $menu_slug ] as $i => $item ) {
-		if ( $submenu_slug == $item[2] ) {
+		if ( $submenu_slug === $item[2] ) {
 			unset( $submenu[ $menu_slug ][ $i ] );
 			return $item;
 		}
 	}
 function menu_page_url( $menu_slug, $echo = true ) {
 	global $_parent_pages;
 	if ( isset( $_parent_pages[ $menu_slug ] ) ) {
 		$parent_slug = $_parent_pages[ $menu_slug ];
 		if ( $parent_slug && ! isset( $_parent_pages[ $parent_slug ] ) ) {
 			$url = admin_url( add_query_arg( 'page', $menu_slug, $parent_slug ) );
 		} else {
 			$url = admin_url( 'admin.php?page=' . $menu_slug );
 		}
 	if ( ! empty( $parent ) && 'admin.php' !== $parent ) {
 		if ( isset( $_wp_real_parent_file[ $parent ] ) ) {
 			$parent = $_wp_real_parent_file[ $parent ];
 		}
 		return $parent;
 	}
 	if ( 'admin.php' === $pagenow && isset( $plugin_page ) ) {
 		foreach ( (array) $menu as $parent_menu ) {
-			if ( $parent_menu[2] == $plugin_page ) {
+			if ( $parent_menu[2] === $plugin_page ) {
 				$parent_file = $plugin_page;
 				if ( isset( $_wp_real_parent_file[ $parent_file ] ) ) {
 					$parent_file = $_wp_real_parent_file[ $parent_file ];
 				}
 				return $parent_file;
 			}
 		}
 		if ( isset( $_wp_menu_nopriv[ $plugin_page ] ) ) {
 			$parent_file = $plugin_page;
 			if ( isset( $_wp_real_parent_file[ $parent_file ] ) ) {
 					$parent_file = $_wp_real_parent_file[ $parent_file ];
 			}
 			return $parent_file;
 		}
 	}
 	if ( isset( $plugin_page ) && isset( $_wp_submenu_nopriv[ $pagenow ][ $plugin_page ] ) ) {
 		$parent_file = $pagenow;
 		if ( isset( $_wp_real_parent_file[ $parent_file ] ) ) {
 			$parent_file = $_wp_real_parent_file[ $parent_file ];
 		}
 		return $parent_file;
 	}
 	foreach ( array_keys( (array) $submenu ) as $parent ) {
 		foreach ( $submenu[ $parent ] as $submenu_array ) {
 			if ( isset( $_wp_real_parent_file[ $parent ] ) ) {
 				$parent = $_wp_real_parent_file[ $parent ];
 			}
-			if ( ! empty( $typenow ) && ( "$pagenow?post_type=$typenow" === $submenu_array[2] ) ) {
+			if ( ! empty( $typenow ) && "$pagenow?post_type=$typenow" === $submenu_array[2] ) {
 				$parent_file = $parent;
 				return $parent;
-			} elseif ( $submenu_array[2] == $pagenow && empty( $typenow ) && ( empty( $parent_file ) || false === strpos( $parent_file, '?' ) ) ) {
+			} elseif ( empty( $typenow ) && $pagenow === $submenu_array[2]
+				&& ( empty( $parent_file ) || false === strpos( $parent_file, '?' ) )
+			) {
 				$parent_file = $parent;
 				return $parent;
-			} elseif ( isset( $plugin_page ) && ( $plugin_page == $submenu_array[2] ) ) {
+			} elseif ( isset( $plugin_page ) && $plugin_page === $submenu_array[2] ) {
 				$parent_file = $parent;
 				return $parent;
 			}
 		}
 	}
 	$parent1 = $parent;
 	if ( empty( $parent ) ) {
 		foreach ( (array) $menu as $menu_array ) {
 			if ( isset( $menu_array[3] ) ) {
-				if ( $menu_array[2] == $pagenow ) {
+				if ( $menu_array[2] === $pagenow ) {
 					$title = $menu_array[3];
 					return $menu_array[3];
-				} elseif ( isset( $plugin_page ) && ( $plugin_page == $menu_array[2] ) && ( $hook == $menu_array[5] ) ) {
+				} elseif ( isset( $plugin_page ) && $plugin_page === $menu_array[2] && $hook === $menu_array[5] ) {
 					$title = $menu_array[3];
 					return $menu_array[3];
 				}
 			} else {
 				$title = $menu_array[0];
 			}
 		}
 	} else {
 		foreach ( array_keys( $submenu ) as $parent ) {
 			foreach ( $submenu[ $parent ] as $submenu_array ) {
-				if ( isset( $plugin_page ) &&
+				if ( isset( $plugin_page )
-					( $plugin_page == $submenu_array[2] ) &&
+					&& $plugin_page === $submenu_array[2]
-					(
+					&& ( $pagenow === $parent
-						( $parent == $pagenow ) ||
+						|| $plugin_page === $parent
-						( $parent == $plugin_page ) ||
+						|| $plugin_page === $hook
-						( $plugin_page == $hook ) ||
+						|| 'admin.php' === $pagenow && $parent1 !== $submenu_array[2]
-						( 'admin.php' === $pagenow && $parent1 != $submenu_array[2] ) ||
+						|| ! empty( $typenow ) && "$pagenow?post_type=$typenow" === $parent )
-						( ! empty( $typenow ) && $parent == $pagenow . '?post_type=' . $typenow )
-					)
 					) {
 						$title = $submenu_array[3];
 						return $submenu_array[3];
 				}
-				if ( $submenu_array[2] != $pagenow || isset( $_GET['page'] ) ) { // Not the current page.
+				if ( $submenu_array[2] !== $pagenow || isset( $_GET['page'] ) ) { // Not the current page.
 					continue;
 				}
 				if ( isset( $submenu_array[3] ) ) {
 					$title = $submenu_array[3];
 				}
 			}
 		}
 		if ( empty( $title ) ) {
 			foreach ( $menu as $menu_array ) {
-				if ( isset( $plugin_page ) &&
+				if ( isset( $plugin_page )
-					( $plugin_page == $menu_array[2] ) &&
+					&& $plugin_page === $menu_array[2]
-					( 'admin.php' === $pagenow ) &&
+					&& 'admin.php' === $pagenow
-					( $parent1 == $menu_array[2] ) ) {
+					&& $parent1 === $menu_array[2]
+				) {
 						$title = $menu_array[3];
 						return $menu_array[3];
 				}
 			}
 		}
 			return false;
 		}
 		if ( isset( $plugin_page ) && isset( $_wp_menu_nopriv[ $plugin_page ] ) ) {
 			return false;
 		}
 		foreach ( array_keys( $_wp_submenu_nopriv ) as $key ) {
 			if ( isset( $_wp_submenu_nopriv[ $key ][ $pagenow ] ) ) {
 				return false;
 			}
 			if ( isset( $plugin_page ) && isset( $_wp_submenu_nopriv[ $key ][ $plugin_page ] ) ) {
 				return false;
 			}
 		}
 		return true;
 	}
-	if ( isset( $plugin_page ) && ( $plugin_page == $parent ) && isset( $_wp_menu_nopriv[ $plugin_page ] ) ) {
+	if ( isset( $plugin_page ) && $plugin_page === $parent && isset( $_wp_menu_nopriv[ $plugin_page ] ) ) {
 		return false;
 	}
 	if ( isset( $submenu[ $parent ] ) ) {
 		foreach ( $submenu[ $parent ] as $submenu_array ) {
-			if ( isset( $plugin_page ) && ( $submenu_array[2] == $plugin_page ) ) {
+			if ( isset( $plugin_page ) && $submenu_array[2] === $plugin_page ) {
-				if ( current_user_can( $submenu_array[1] ) ) {
+				return current_user_can( $submenu_array[1] );
-					return true;
+			} elseif ( $submenu_array[2] === $pagenow ) {
-				} else {
+				return current_user_can( $submenu_array[1] );
-					return false;
-				}
-			} elseif ( $submenu_array[2] == $pagenow ) {
-				if ( current_user_can( $submenu_array[1] ) ) {
-					return true;
-				} else {
-					return false;
-				}
 			}
 		}
 	}
 	foreach ( $menu as $menu_array ) {
-		if ( $menu_array[2] == $parent ) {
+		if ( $menu_array[2] === $parent ) {
-			if ( current_user_can( $menu_array[1] ) ) {
+			return current_user_can( $menu_array[1] );
-				return true;
-			} else {
-				return false;
-			}
 		}
 	}
 	return true;
 }
 }
 /**
 * Adds an array of options to the list of allowed options.
 *
-* @since 2.7.0
+* @since 5.5.0
 *
 * @global array $allowed_options
 *
 * @param array        $new_options
 * @param string|array $options
 	if ( ! defined( 'WP_SANDBOX_SCRAPING' ) ) {
 		define( 'WP_SANDBOX_SCRAPING', true );
 	}
 	wp_register_plugin_realpath( WP_PLUGIN_DIR . '/' . $plugin );
-	include WP_PLUGIN_DIR . '/' . $plugin;
+	include_once WP_PLUGIN_DIR . '/' . $plugin;
 }
 /**
 * Helper function for adding content to the Privacy Policy Guide.
 *
 /**
 * Renders an admin notice in case some plugins have been paused due to errors.
 *
 * @since 5.2.0
+*
+* @global string $pagenow
 */
 function paused_plugins_notice() {
 	if ( 'plugins.php' === $GLOBALS['pagenow'] ) {
 		return;
 	}
 		__( 'You can find more details and make changes on the Plugins screen.' ),
 		esc_url( admin_url( 'plugins.php?plugin_status=paused' ) ),
 		__( 'Go to the Plugins screen' )
 	);
 }
+/**
+* Renders an admin notice when a plugin was deactivated during an update.
+*
+* Displays an admin notice in case a plugin has been deactivated during an
+* upgrade due to incompatibility with the current version of WordPress.
+*
+* @since 5.8.0
+* @access private
+*
+* @global string $pagenow
+* @global string $wp_version
+*/
+function deactivated_plugins_notice() {
+	if ( 'plugins.php' === $GLOBALS['pagenow'] ) {
+		return;
+	}
+	if ( ! current_user_can( 'activate_plugins' ) ) {
+		return;
+	}
+	$blog_deactivated_plugins = get_option( 'wp_force_deactivated_plugins' );
+	$site_deactivated_plugins = array();
+	if ( false === $blog_deactivated_plugins ) {
+		// Option not in database, add an empty array to avoid extra DB queries on subsequent loads.
+		update_option( 'wp_force_deactivated_plugins', array() );
+	}
+	if ( is_multisite() ) {
+		$site_deactivated_plugins = get_site_option( 'wp_force_deactivated_plugins' );
+		if ( false === $site_deactivated_plugins ) {
+			// Option not in database, add an empty array to avoid extra DB queries on subsequent loads.
+			update_site_option( 'wp_force_deactivated_plugins', array() );
+		}
+	}
+	if ( empty( $blog_deactivated_plugins ) && empty( $site_deactivated_plugins ) ) {
+		// No deactivated plugins.
+		return;
+	}
+	$deactivated_plugins = array_merge( $blog_deactivated_plugins, $site_deactivated_plugins );
+	foreach ( $deactivated_plugins as $plugin ) {
+		if ( ! empty( $plugin['version_compatible'] ) && ! empty( $plugin['version_deactivated'] ) ) {
+			$explanation = sprintf(
+				/* translators: 1: Name of deactivated plugin, 2: Plugin version deactivated, 3: Current WP version, 4: Compatible plugin version */
+				__( '%1$s %2$s was deactivated due to incompatibility with WordPress %3$s, please upgrade to %1$s %4$s or later.' ),
+				$plugin['plugin_name'],
+				$plugin['version_deactivated'],
+				$GLOBALS['wp_version'],
+				$plugin['version_compatible']
+			);
+		} else {
+			$explanation = sprintf(
+				/* translators: 1: Name of deactivated plugin, 2: Plugin version deactivated, 3: Current WP version */
+				__( '%1$s %2$s was deactivated due to incompatibility with WordPress %3$s.' ),
+				$plugin['plugin_name'],
+				! empty( $plugin['version_deactivated'] ) ? $plugin['version_deactivated'] : '',
+				$GLOBALS['wp_version'],
+				$plugin['version_compatible']
+			);
+		}
+		printf(
+			'<div class="notice notice-warning"><p><strong>%s</strong><br>%s</p><p><a href="%s">%s</a></p></div>',
+			sprintf(
+				/* translators: %s: Name of deactivated plugin */
+				__( '%s plugin deactivated during WordPress upgrade.' ),
+				$plugin['plugin_name']
+			),
+			$explanation,
+			esc_url( admin_url( 'plugins.php?plugin_status=inactive' ) ),
+			__( 'Go to the Plugins screen' )
+		);
+	}
+	// Empty the options.
+	update_option( 'wp_force_deactivated_plugins', array() );
+	if ( is_multisite() ) {
+		update_site_option( 'wp_force_deactivated_plugins', array() );
+	}
+}

changeset 18	be944660c56a
parent 16	a86126ab1dd4
child 19	3d72ae0968f4