Changeset 59336

Timestamp:

11/02/2024 02:59:16 PM (2 months ago)

Author:

SergeyBiryukov

Message:

Docs: Add missing void to DocBlock @return types.

This commit adds missing void return types to (parent) methods that can explicitly return void as one of their conditional paths.

Addressed methods:

• WP_Privacy_Requests_Table::column_status()
• WP_Recovery_Mode::handle_error()
• WP_Widget::form() — unlike the others, it's the child classes that return void when the method is correctly implemented.

Note: @return void (where void is the single type returned) should not be used outside the default bundled themes and the PHP compatibility shims included in WordPress Core, as per the ​documentation standards.

Follow-up to [30382], [42967], [43256], [44973], [45448].

Props justlevine.
See #52217, #62281.

Location:

trunk/src

Files:

• wp-admin/includes/class-wp-privacy-requests-table.php (modified) (1 diff)
• wp-includes/class-wp-recovery-mode.php (modified) (1 diff)
• wp-includes/class-wp-widget.php (modified) (1 diff)

trunk/src/wp-admin/includes/class-wp-privacy-requests-table.php

@@ -431 +431 @@
      *
      * @param WP_User_Request $item Item being shown.
-     * @return string Status column markup.
+     * @return string|void Status column markup. Returns a string if no status is found,
+     *                     otherwise it displays the markup.
      */
     public function column_status( $item ) {

trunk/src/wp-includes/class-wp-recovery-mode.php

@@ -162 +162 @@
      *
      * @param array $error Error details from `error_get_last()`.
-     * @return true|WP_Error True if the error was handled and headers have already been sent.
-     *                       Or the request will exit to try and catch multiple errors at once.
-     *                       WP_Error if an error occurred preventing it from being handled.
+     * @return true|WP_Error|void True if the error was handled and headers have already been sent.
+     *                            Or the request will exit to try and catch multiple errors at once.
+     *                            WP_Error if an error occurred preventing it from being handled.
      */
     public function handle_error( array $error ) {

trunk/src/wp-includes/class-wp-widget.php

@@ -139 +139 @@
      *
      * @param array $instance The settings for the particular instance of the widget.
-     * @return string Default return is 'noform'.
+     * @return string|void Default return is 'noform'.
      */
     public function form( $instance ) {