Changeset 53316 for trunk/src/wp-includes/class-wp-recovery-mode-email-service.php

Timestamp:

04/29/2022 07:15:57 PM (4 years ago)

Author:

johnbillion

Message:

Docs: Corrections and improvements to docblocks for function and hooks relating to fatal error handling.

See #54729

File:

• trunk/src/wp-includes/class-wp-recovery-mode-email-service.php (modified) (5 diffs)

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

@@ -41 +41 @@
          *
          * @param int   $rate_limit Number of seconds before another email can be sent.
-         * @param array $error      Error details from {@see error_get_last()}
+         * @param array $error      Error details from `error_get_last()`.
          * @param array $extension {
          *     The extension that caused the error.
@@ -102 +102 @@
          *
          * @param int   $rate_limit Number of seconds before another email can be sent.
-         * @param array $error      Error details from {@see error_get_last()}
-         * @param array $extension  Extension that caused the error.
+         * @param array $error      Error details from `error_get_last()`.
+         * @param array $extension {
+         *     The extension that caused the error.
+         *
+         *     @type string $slug The extension slug. The directory of the plugin or theme.
+         *     @type string $type The extension type. Either 'plugin' or 'theme'.
+         * }
          * @return bool Whether the email was sent successfully.
          */
@@ -257 +262 @@
          * @since 5.2.0
          *
-         * @param array $extension The extension that caused the error.
+         * @param array $extension {
+         *     The extension that caused the error.
+         *
+         *     @type string $slug The extension slug. The directory of the plugin or theme.
+         *     @type string $type The extension type. Either 'plugin' or 'theme'.
+         * }
          * @return string Message about which extension caused the error.
          */
@@ -289 +299 @@
          * @since 5.3.0
          *
-         * @param array $extension The extension that caused the error.
+         * @param array $extension {
+         *     The extension that caused the error.
+         *
+         *     @type string $slug The extension slug. The directory of the plugin or theme.
+         *     @type string $type The extension type. Either 'plugin' or 'theme'.
+         * }
          * @return array|false A plugin array {@see get_plugins()} or `false` if no plugin was found.
          */
@@ -318 +333 @@
          * @since 5.3.0
          *
-         * @param array $extension The extension that caused the error.
+         * @param array $extension {
+         *     The extension that caused the error.
+         *
+         *     @type string $slug The extension slug. The directory of the plugin or theme.
+         *     @type string $type The extension type. Either 'plugin' or 'theme'.
+         * }
          * @return array An associative array of debug information.
          */