<!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>[58396] trunk: Plugins: Ensure wp_get_plugin_action_button() returns a string.</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/58396">58396</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/58396","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>hellofromTonya</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-06-12 18:15:33 +0000 (Wed, 12 Jun 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: Ensure wp_get_plugin_action_button() returns a string.
<a href="https://core.trac.wordpress.org/changeset/57545">[57545]</a> introduced `wp_get_plugin_action_button()`. This function is documented to return a `string`. However, if the user does not have the appropriate capabilities, it returned `void`, which is unexpected.
Resolves the issue by moving the `return $button` to the bottom of the function to ensure it always returns a `string` type. On success, the button's HTML string is returned; else, an empty string is returned.
Unit tests are included.
Follow-up to <a href="https://core.trac.wordpress.org/changeset/57545">[57545]</a>.
Props costdev, rajinsharwar, hellofromTonya.
Fixes <a href="https://core.trac.wordpress.org/ticket/61400">#61400</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesplugininstallphp">trunk/src/wp-admin/includes/plugin-install.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li>trunk/tests/phpunit/tests/admin/includes/</li>
<li><a href="#trunktestsphpunittestsadminincludeswpGetPluginActionButtonphp">trunk/tests/phpunit/tests/admin/includes/wpGetPluginActionButton.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesplugininstallphp"></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-install.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/plugin-install.php 2024-06-12 12:42:28 UTC (rev 58395)
+++ trunk/src/wp-admin/includes/plugin-install.php 2024-06-12 18:15:33 UTC (rev 58396)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -912,7 +912,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * }
</span><span class="cx" style="display: block; padding: 0 10px"> * @param bool $compatible_php The result of a PHP compatibility check.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param bool $compatible_wp The result of a WP compatibility check.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return string The markup for the dependency row button.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return string The markup for the dependency row button. An empty string if the user does not have capabilities.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_get_plugin_action_button( $name, $data, $compatible_php, $compatible_wp ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $button = '';
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1048,7 +1048,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> break;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return $button;
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return $button;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunittestsadminincludeswpGetPluginActionButtonphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/tests/admin/includes/wpGetPluginActionButton.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/admin/includes/wpGetPluginActionButton.php (rev 0)
+++ trunk/tests/phpunit/tests/admin/includes/wpGetPluginActionButton.php 2024-06-12 18:15:33 UTC (rev 58396)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,155 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+/**
+ * Tests for wp_get_plugin_action_button().
+ *
+ * @group plugins
+ * @group admin
+ *
+ * @covers ::wp_get_plugin_action_button
+ */
+class Tests_Admin_Includes_WpGetPluginActionButton extends WP_UnitTestCase {
+
+ /**
+ * User role.
+ *
+ * @var WP_Role
+ */
+ private static $role;
+
+ /**
+ * User ID.
+ *
+ * @var int
+ */
+ private static $user_id;
+
+ /**
+ * Test plugin data.
+ *
+ * @var stdClass
+ */
+ private static $test_plugin;
+
+ /**
+ * Sets up properties and adds a test plugin before any tests run.
+ */
+ public static function set_up_before_class() {
+ parent::set_up_before_class();
+
+ require_once ABSPATH . 'wp-admin/includes/plugin-install.php';
+
+ $role_name = 'wp_get_plugin_action_button-test-role';
+ add_role( $role_name, 'Test Role' );
+
+ self::$role = get_role( $role_name );
+ self::$user_id = self::factory()->user->create( array( 'role' => $role_name ) );
+ self::$test_plugin = (object) array(
+ 'name' => 'My Plugin',
+ 'slug' => 'my-plugin',
+ 'version' => '1.0.0',
+ );
+
+ mkdir( WP_PLUGIN_DIR . '/' . self::$test_plugin->slug );
+ file_put_contents(
+ WP_PLUGIN_DIR . '/' . self::$test_plugin->slug . '/my_plugin.php',
+ "<?php\n/**\n* Plugin Name: " . self::$test_plugin->name . "\n* Version: " . self::$test_plugin->version . "\n*/"
+ );
+ }
+
+ /**
+ * Removes the test plugin and its directory after all tests run.
+ */
+ public static function tear_down_after_class() {
+ parent::tear_down_after_class();
+
+ remove_role( self::$role->name );
+
+ unlink( WP_PLUGIN_DIR . '/' . self::$test_plugin->slug . '/my_plugin.php' );
+ rmdir( WP_PLUGIN_DIR . '/' . self::$test_plugin->slug );
+ }
+
+ /**
+ * Tests that an empty string is returned when the user does not have the correct capabilities.
+ *
+ * @ticket 61400
+ */
+ public function test_should_return_empty_string_without_proper_capabilities() {
+ wp_set_current_user( self::$user_id );
+
+ $actual = wp_get_plugin_action_button(
+ self::$test_plugin->name,
+ self::$test_plugin,
+ true,
+ true
+ );
+
+ $this->assertIsString( $actual, 'A string should be returned.' );
+ $this->assertEmpty( $actual, 'An empty string should be returned.' );
+ }
+
+ /**
+ * Tests that an empty string is not returned when the user
+ * has the correct capabilities on single site.
+ *
+ * @ticket 61400
+ *
+ * @group ms-excluded
+ *
+ * @dataProvider data_capabilities
+ *
+ * @param string $capability The name of the capability.
+ */
+ public function test_should_not_return_empty_string_with_proper_capabilities_single_site( $capability ) {
+ self::$role->add_cap( $capability );
+
+ wp_set_current_user( self::$user_id );
+
+ $actual = wp_get_plugin_action_button(
+ self::$test_plugin->name,
+ self::$test_plugin,
+ true,
+ true
+ );
+
+ self::$role->remove_cap( $capability );
+
+ $this->assertIsString( $actual, 'A string should be returned.' );
+ $this->assertNotEmpty( $actual, 'An empty string should not be returned.' );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array[]
+ */
+ public function data_capabilities() {
+ return self::text_array_to_dataprovider( array( 'install_plugins', 'update_plugins' ) );
+ }
+
+ /**
+ * Tests that an empty string is not returned when the user
+ * has the correct capabilities on multisite.
+ *
+ * @ticket 61400
+ *
+ * @group ms-required
+ */
+ public function test_should_not_return_empty_string_with_proper_capabilities_multisite() {
+ wp_set_current_user( self::$user_id );
+
+ grant_super_admin( self::$user_id );
+
+ $actual = wp_get_plugin_action_button(
+ self::$test_plugin->name,
+ self::$test_plugin,
+ true,
+ true
+ );
+
+ revoke_super_admin( self::$user_id );
+
+ $this->assertIsString( $actual, 'A string should be returned.' );
+ $this->assertNotEmpty( $actual, 'An empty string should not be returned.' );
+ }
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/tests/phpunit/tests/admin/includes/wpGetPluginActionButton.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span></div>
</body>
</html>