<!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>[57769] trunk/src: Plugins: Improve plugin dependency admin notices.</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/57769">57769</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/57769","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:25:22 +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 admin notices.
This makes several refinements to the various notices displayed in 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, joedolson, afragen, swissspidy, peterwilsoncc, euthelup.
Fixes <a href="https://core.trac.wordpress.org/ticket/60465">#60465</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesclasswppluginslisttablephp">trunk/src/wp-admin/includes/class-wp-plugins-list-table.php</a></li>
<li><a href="#trunksrcwpincludesclasswpplugindependenciesphp">trunk/src/wp-includes/class-wp-plugin-dependencies.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesclasswppluginslisttablephp"></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/class-wp-plugins-list-table.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/class-wp-plugins-list-table.php 2024-03-05 05:32:19 UTC (rev 57768)
+++ trunk/src/wp-admin/includes/class-wp-plugins-list-table.php 2024-03-05 06:25:22 UTC (rev 57769)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1567,19 +1567,35 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $links[] = $this->get_dependency_view_details_link( $name, $slug );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $dependency_note = __( 'Note: This plugin cannot be activated until the plugins that are required by it are activated.' );
-
- $comma = wp_get_list_item_separator();
- $requires = sprintf(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $is_active = is_multisite() ? is_plugin_active_for_network( $dependent ) : is_plugin_active( $dependent );
+ $comma = wp_get_list_item_separator();
+ $requires = sprintf(
</ins><span class="cx" style="display: block; padding: 0 10px"> /* translators: %s: List of dependency names. */
</span><span class="cx" style="display: block; padding: 0 10px"> __( '<strong>Requires:</strong> %s' ),
</span><span class="cx" style="display: block; padding: 0 10px"> implode( $comma, $links )
</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">+ $notice = '';
+ $error_message = '';
+ if ( WP_Plugin_Dependencies::has_unmet_dependencies( $dependent ) ) {
+ if ( $is_active ) {
+ $error_message = __( 'This plugin is active but may not function correctly because required plugins are missing or inactive.' );
+ } else {
+ $error_message = __( 'This plugin cannot be activated because required plugins are missing or inactive.' );
+ }
+ $notice = wp_get_admin_notice(
+ $error_message,
+ array(
+ 'type' => 'error',
+ 'additional_classes' => array( 'inline', 'notice-alt' ),
+ )
+ );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> printf(
</span><span class="cx" style="display: block; padding: 0 10px"> '<div class="requires"><p>%1$s</p><p>%2$s</p></div>',
</span><span class="cx" style="display: block; padding: 0 10px"> $requires,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $dependency_note
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $notice
</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></span></pre></div>
<a id="trunksrcwpincludesclasswpplugindependenciesphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/class-wp-plugin-dependencies.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-plugin-dependencies.php 2024-03-05 05:32:19 UTC (rev 57768)
+++ trunk/src/wp-includes/class-wp-plugin-dependencies.php 2024-03-05 06:25:22 UTC (rev 57769)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -369,10 +369,30 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public static function display_admin_notice_for_unmet_dependencies() {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( in_array( false, self::get_dependency_filepaths(), true ) ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $error_message = __( 'Some required plugins are missing or inactive.' );
+
+ if ( is_multisite() ) {
+ if ( current_user_can( 'manage_network_plugins' ) ) {
+ $error_message .= ' ' . sprintf(
+ /* translators: %s: Link to the network plugins page. */
+ __( '<a href="%s">Manage plugins</a>.' ),
+ esc_url( network_admin_url( 'plugins.php' ) )
+ );
+ } else {
+ $error_message .= ' ' . __( 'Please contact your network administrator.' );
+ }
+ } elseif ( 'plugins' !== get_current_screen()->base ) {
+ $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"> wp_admin_notice(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- __( 'There are additional plugin dependencies that must be installed.' ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $error_message,
</ins><span class="cx" style="display: block; padding: 0 10px"> array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'type' => 'info',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'type' => 'warning',
</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></span></pre>
</div>
</div>
</body>
</html>