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

Timestamp:

06/04/2014 06:05:46 AM (12 years ago)

Author:

DrewAPicture

Message:

Improve inline documentation for the __construct() and add() methods in WP_Error class.

Props jdgrimes.
Fixes #28203.

File:

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

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

@@ -39 +39 @@
 
         /**
-         * Constructor - Sets up error message.
-         *
-         * If code parameter is empty then nothing will be done. It is possible to
-         * add multiple messages to the same code, but with other methods in the
-         * class.
-         *
-         * All parameters are optional, but if the code parameter is set, then the
-         * data parameter is optional.
+         * Initialize the error.
+         *
+         * If `$code` is empty, the other parameters will be ignored.
+         * When `$code` is not empty, `$message` will be used even if
+         * it is empty. The `$data` parameter will be used only if it
+         * is not empty.
+         *
+         * Though the class is constructed with a single error code and
+         * message, multiple codes can be added using the `add()` method.
          *
          * @since 2.1.0
@@ -55 +56 @@
          * @return WP_Error
          */
-        public function __construct($code = '', $message = '', $data = '') {
+        public function __construct( $code = '', $message = '', $data = '' ) {
                 if ( empty($code) )
                         return;
@@ -204 +205 @@
 
         /**
-         * Append more error messages to list of error messages.
+         * Add an error or append additional message to an existing error.
          *
          * @since 2.1.0