<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[57770] trunk/src/wp-admin/includes/plugin.php: Plugins: Improve plugin dependency related error messages.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/57770">57770</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/57770","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>desrosj</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-03-05 06:46:34 +0000 (Tue, 05 Mar 2024)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Plugins: Improve plugin dependency related error messages.
This makes several refinements to the various error messages displayed throughout the WordPress admin related to plugin dependencies. Additionally, it adds some conditions to display more appropriate messages for multisite installs with proper context to the user's capabilities.
Props costdev, swissspidy, afragen, huzaifaalmesbah, knutsp.
Fixes <a href="https://core.trac.wordpress.org/ticket/60465">#60465</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludespluginphp">trunk/src/wp-admin/includes/plugin.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludespluginphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/plugin.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/plugin.php 2024-03-05 06:25:22 UTC (rev 57769)
+++ trunk/src/wp-admin/includes/plugin.php 2024-03-05 06:46:34 UTC (rev 57770)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1202,26 +1202,55 @@
</span><span class="cx" style="display: block; padding: 0 10px"> WP_Plugin_Dependencies::initialize();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( WP_Plugin_Dependencies::has_unmet_dependencies( $plugin ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $dependencies = WP_Plugin_Dependencies::get_dependencies( $plugin );
- $unmet_dependencies = array();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $dependency_names = WP_Plugin_Dependencies::get_dependency_names( $plugin );
+ $unmet_dependencies = array();
+ $unmet_dependency_names = array();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- foreach ( $dependencies as $dependency ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ foreach ( $dependency_names as $dependency => $dependency_name ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $dependency_file = WP_Plugin_Dependencies::get_dependency_filepath( $dependency );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( false === $dependency_file ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $unmet_dependencies['not_installed'][] = $dependency;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $unmet_dependencies['not_installed'][ $dependency ] = $dependency_name;
+ $unmet_dependency_names[] = $dependency_name;
</ins><span class="cx" style="display: block; padding: 0 10px"> } elseif ( is_plugin_inactive( $dependency_file ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $unmet_dependencies['inactive'][] = $dependency;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $unmet_dependencies['inactive'][ $dependency ] = $dependency_name;
+ $unmet_dependency_names[] = $dependency_name;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $error_message = sprintf(
+ /* translators: 1: Plugin name, 2: Number of plugins, 3: A comma-separated list of plugin names. */
+ _n(
+ '<strong>Error:</strong> %1$s requires %2$d plugin to be installed and activated: %3$s.',
+ '<strong>Error:</strong> %1$s requires %2$d plugins to be installed and activated: %3$s.',
+ count( $unmet_dependency_names )
+ ),
+ $plugin_headers['Name'],
+ count( $unmet_dependency_names ),
+ implode( wp_get_list_item_separator(), $unmet_dependency_names )
+ );
+
+ if ( is_multisite() ) {
+ if ( current_user_can( 'manage_network_plugins' ) ) {
+ $error_message .= ' ' . sprintf(
+ /* translators: %s: Link to the plugins page. */
+ __( '<a href="%s">Manage plugins</a>.' ),
+ esc_url( network_admin_url( 'plugins.php' ) )
+ );
+ } else {
+ $error_message .= ' ' . __( 'Please contact your network administrator.' );
+ }
+ } else {
+ $error_message .= ' ' . sprintf(
+ /* translators: %s: Link to the plugins page. */
+ __( '<a href="%s">Manage plugins</a>.' ),
+ esc_url( admin_url( 'plugins.php' ) )
+ );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> return new WP_Error(
</span><span class="cx" style="display: block; padding: 0 10px"> 'plugin_missing_dependencies',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- '<p>' . sprintf(
- /* translators: %s: Plugin name. */
- _x( '<strong>Error:</strong> %s requires plugins that are not installed or activated.', 'plugin' ),
- $plugin_headers['Name']
- ) . '</p>',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ "<p>{$error_message}</p>",
</ins><span class="cx" style="display: block; padding: 0 10px"> $unmet_dependencies
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>