Ticket #42786: 42786.diff

src/wp-admin/includes/template.php

@@ -1437 +1437 @@
  *
  * @param string $setting Optional slug title of a specific setting who's errors you want.
  * @param boolean $sanitize Whether to re-sanitize the setting value before returning errors.
- * @return array Array of settings errors
+ * @return array {
+ *     @type string $setting    Slug title of the setting to which this error applies.
+ *     @type string $code       Slug-name to identify the error. Used as part of 'id' attribute in HTML output.
+ *     @type string $message    The formatted message text to display to the user (will be shown inside styled `<div>` and `<p>` tags).
+ *     @type string $type       Optional. Message type, controls HTML class. Accepts 'error' or 'updated'. Default 'error'.
+ * }
  */
 function get_settings_errors( $setting = '', $sanitize = false ) {
         global $wp_settings_errors;