Changeset 55398 for trunk/src/wp-includes/class-wp-error.php

Timestamp:

02/21/2023 04:37:03 PM (3 years ago)

Author:

SergeyBiryukov

Message:

Docs: Document default values for optional parameters in various DocBlocks.

Props paulkevan, costdev, audrasjb, SergeyBiryukov.
See #56792.

File:

• trunk/src/wp-includes/class-wp-error.php (modified) (5 diffs)

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

@@ -57 +57 @@
      * @param string|int $code    Error code.
      * @param string     $message Error message.
-     * @param mixed      $data    Optional. Error data.
+     * @param mixed      $data    Optional. Error data. Default empty string.
      */
     public function __construct( $code = '', $message = '', $data = '' ) {
@@ -104 +104 @@
      * @since 2.1.0
      *
-     * @param string|int $code Optional. Retrieve messages matching code, if exists.
+     * @param string|int $code Optional. Error code to retrieve the messages for.
+     *                         Default empty string.
      * @return string[] Error strings on success, or empty array if there are none.
      */
@@ -133 +134 @@
      * @since 2.1.0
      *
-     * @param string|int $code Optional. Error code to retrieve message.
+     * @param string|int $code Optional. Error code to retrieve the message for.
+     *                         Default empty string.
      * @return string The error message.
      */
@@ -152 +154 @@
      * @since 2.1.0
      *
-     * @param string|int $code Optional. Error code.
+     * @param string|int $code Optional. Error code. Default empty string.
      * @return mixed Error data, if it exists.
      */
@@ -186 +188 @@
      * @param string|int $code    Error code.
      * @param string     $message Error message.
-     * @param mixed      $data    Optional. Error data.
+     * @param mixed      $data    Optional. Error data. Default empty string.
      */
     public function add( $code, $message, $data = '' ) {