Changeset 58396

Timestamp:

06/12/2024 06:15:33 PM (4 months ago)

Author:

hellofromTonya

Message:

Plugins: Ensure wp_get_plugin_action_button() returns a string.

[57545] 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 [57545].

Props costdev, rajinsharwar, hellofromTonya.
Fixes #61400.

Location:

trunk

Files:

• src/wp-admin/includes/plugin-install.php (modified) (2 diffs)
• tests/phpunit/tests/admin/includes (added)
• tests/phpunit/tests/admin/includes/wpGetPluginActionButton.php (added)

trunk/src/wp-admin/includes/plugin-install.php

@@ -913 +913 @@
  * @param bool         $compatible_php   The result of a PHP compatibility check.
  * @param bool         $compatible_wp    The result of a WP compatibility check.
- * @return string The markup for the dependency row button.
+ * @return string The markup for the dependency row button. An empty string if the user does not have capabilities.
  */
 function wp_get_plugin_action_button( $name, $data, $compatible_php, $compatible_wp ) {
@@ -1049 +1049 @@
                 break;
         }
-
-        return $button;
-    }
+    }
+
+    return $button;
 }