Changeset 7552

Timestamp:

11/09/2013 08:53:27 PM (13 years ago)

Author:

johnjamesjacoby

Message:

Clean up admin-notice code. Add $notices variable to BP_Admin class to help avoid debug notices.

Location:

trunk/bp-core

Files:

• admin/bp-core-functions.php (modified) (5 diffs)
• bp-core-admin.php (modified) (1 diff)

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

@@ -121 +121 @@
  */
 function bp_core_print_admin_notices() {
-        $bp = buddypress();
 
         // Only the super admin should see messages
-        if ( !bp_current_user_can( 'bp_moderate' ) )
-                return;
-
-        // On multisite installs, don't show on the Site Admin of a non-root blog, unless
-        // do_network_admin is overridden
-        if ( is_multisite() && bp_core_do_network_admin() && !bp_is_root_blog() )
-                return;
+        if ( ! bp_current_user_can( 'bp_moderate' ) ) {
+                return;
+        }
+
+        // On multisite installs, don't show on a non-root blog, unless
+        // 'do_network_admin' is overridden.
+        if ( is_multisite() && bp_core_do_network_admin() && ! bp_is_root_blog() ) {
+                return;
+        }
+
+        // Get the admin notices
+        $admin_notices = buddypress()->admin->notices;
 
         // Show the messages
-        if ( !empty( $bp->admin->notices ) ) {
-                ?>
+        if ( !empty( $admin_notices ) ) : ?>
+
                 <div id="message" class="updated fade">
-                <?php foreach ( $bp->admin->notices as $notice ) : ?>
-                                <p><?php echo $notice ?></p>
-                <?php endforeach ?>
+
+                        <?php foreach ( $admin_notices as $notice ) : ?>
+
+                                <p><?php echo $notice; ?></p>
+
+                        <?php endforeach; ?>
+
                 </div>
-                <?php
-        }
+
+        <?php endif;
 }
 add_action( 'admin_notices',         'bp_core_print_admin_notices' );
@@ -158 +166 @@
  * @param string $notice The notice you are adding to the queue
  */
-function bp_core_add_admin_notice( $notice ) {
-        $bp = buddypress();
-
-        if ( empty( $bp->admin->notices ) ) {
-                $bp->admin->notices = array();
-        }
-
-        $bp->admin->notices[] = $notice;
+function bp_core_add_admin_notice( $notice = '' ) {
+
+        // Do not add if the notice is empty
+        if ( empty( $notice ) ) {
+                return;
+        }
+
+        // Double check the object before referencing it
+        if ( ! isset( buddypress()->admin->notices ) ) {
+                buddypress()->admin->notices = array();
+        }
+
+        // Add the notice
+        buddypress()->admin->notices[] = $notice;
 }
 
@@ -187 +201 @@
 
         // Only the super admin gets warnings
-        if ( !bp_current_user_can( 'bp_moderate' ) )
-                return;
+        if ( ! bp_current_user_can( 'bp_moderate' ) ) {
+                return;
+        }
 
         // On multisite installs, don't load on a non-root blog, unless do_network_admin is overridden
-        if ( is_multisite() && bp_core_do_network_admin() && !bp_is_root_blog() )
-                return;
+        if ( is_multisite() && bp_core_do_network_admin() && !bp_is_root_blog() ) {
+                return;
+        }
 
         /**
@@ -210 +226 @@
          * Are pretty permalinks enabled?
          */
-        if ( isset( $_POST['permalink_structure'] ) )
-                return;
+        if ( isset( $_POST['permalink_structure'] ) ) {
+                return;
+        }
 
         if ( empty( $wp_rewrite->permalink_structure ) ) {
@@ -248 +265 @@
 
         // On the first admin screen after a new installation, this isn't set, so grab it to supress a misleading error message.
-        if ( empty( $bp->pages->members ) )
+        if ( empty( $bp->pages->members ) ) {
                 $bp->pages = bp_core_get_directory_pages();
+        }
 
         foreach( $wp_page_components as $component ) {

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

@@ -60 +60 @@
          */
         public $js_url = '';
+
+        /** Other *****************************************************************/
+
+        /**
+         * Notices used for user feedback, like saving settings.
+         *
+         * @var array()
+         */
+        public $notices = array();
 
         /** Methods ***************************************************************/