Changeset 9171

Timestamp:

11/25/2014 08:45:16 AM (10 years ago)

Author:

djpaul

Message:

Core: admin notice functions now support a "type".

The type parameter is used to set a CSS class when the notices are
rendered in wp-admin. It defaults to “updated”, which is the same as
the previous behaviour, which is visually styled as the box with the
green border.

Fixes #6041

File:

• trunk/src/bp-core/admin/bp-core-functions.php (modified) (4 diffs)

trunk/src/bp-core/admin/bp-core-functions.php

@@ -120 +120 @@
  * boxes.
  *
- * @package BuddyPress Core
  * @since BuddyPress (1.5)
  *
@@ -139 +138 @@
     }
 
-    // Get the admin notices
-    $admin_notices = buddypress()->admin->notices;
-
-    // Show the messages
-    if ( !empty( $admin_notices ) ) : ?>
-
-        <div id="message" class="updated fade">
-
-            <?php foreach ( $admin_notices as $notice ) : ?>
-
-                <p><?php echo $notice; ?></p>
-
-            <?php endforeach; ?>
-
-        </div>
-
-    <?php endif;
+    $notice_types = array();
+    foreach ( buddypress()->admin->notices as $notice ) {
+        $notice_types[] = $notice['type'];
+    }
+    $notice_types = array_unique( $notice_types );
+
+    foreach ( $notice_types as $type ) {
+        $notices = wp_list_filter( buddypress()->admin->notices, array( 'type' => $type ) );
+        printf( '<div id="message" class="fade %s">', sanitize_html_class( $type ) );
+
+        foreach ( $notices as $notice ) {
+            printf( '<p>%s</p>', $notice['message'] );
+        }
+
+        printf( '</div>' );
+    }
 }
 add_action( 'admin_notices',         'bp_core_print_admin_notices' );
@@ -167 +165 @@
  * loaded in time.
  *
- * @package BuddyPress Core
  * @since BuddyPress (1.5)
  *
- * @param string $notice The notice you are adding to the queue
- */
-function bp_core_add_admin_notice( $notice = '' ) {
+ * @param string $notice The notice you are adding to the queue.
+ * @param string $type The notice type; optional. Usually either "updated" or "error".
+ */
+function bp_core_add_admin_notice( $notice = '', $type = 'updated' ) {
 
     // Do not add if the notice is empty
@@ -185 +183 @@
 
     // Add the notice
-    buddypress()->admin->notices[] = $notice;
+    buddypress()->admin->notices[] = array(
+        'message' => $notice,
+        'type'    => $type,
+    );
 }