Changeset 6897

Timestamp:

01/29/2019 04:38:37 AM (6 years ago)

Author:

johnjamesjacoby

Message:

Upgrades: append upgrade count to "Tools" if there are pending upgrades

• Add function and method to tweak the $menu global
• Add styling for count in nav-tab-wrapper UI

This change adds a span.awaiting-mod wrapper around the pending upgrade count in a few strategic locations around the WordPress Admin UI.

See #3244.

Location:

trunk/src/includes

Files:

• admin/assets/css/admin.css (modified) (1 diff)
• admin/classes/class-bbp-admin.php (modified) (3 diffs)
• admin/tools.php (modified) (2 diffs)
• core/update.php (modified) (2 diffs)

trunk/src/includes/admin/assets/css/admin.css

@@ -623 +623 @@
     width: 10%;
 }
+
+.nav-tab-wrapper a span.awaiting-mod {
+    display: inline-block;
+    vertical-align: top;
+    margin: 3px 0 0 1px;
+    padding: 0 5px;
+    min-width: 7px;
+    height: 17px;
+    border-radius: 11px;
+    background-color: #ca4a1f;
+    color: #fff;
+    font-size: 9px;
+    line-height: 17px;
+    text-align: center;
+    z-index: 26;
+}

trunk/src/includes/admin/classes/class-bbp-admin.php

@@ -169 +169 @@
         add_action( 'bbp_admin_init',    array( $this, 'hide_notices'   ) );
         add_action( 'bbp_admin_notices', array( $this, 'output_notices' ) );
+
+        /** Upgrades **********************************************************/
+
+        add_action( 'bbp_admin_init', array( $this, 'add_upgrade_count' ) );
 
         /** Ajax **************************************************************/
@@ -387 +391 @@
 
     /**
+     * Maybe append the pending upgrade count to the "Tools" menu.
+     *
+     * @since 2.6.0 bbPress (r6896)
+     *
+     * @global menu $menu
+     */
+    public function add_upgrade_count() {
+        global $menu;
+
+        foreach ( $menu as $menu_index => $menu_item ) {
+            $found = array_search( 'tools.php', $menu_item, true );
+
+            if ( false !== $found ) {
+                $menu[ $menu_index ][ 0 ] = bbp_maybe_append_pending_upgrade_count( $menu[ $menu_index ][ 0 ] );
+                continue;
+            }
+        }
+    }
+
+    /**
      * Add the admin menus
      *
@@ -424 +448 @@
         add_management_page(
             esc_html__( 'Forums', 'bbpress' ),
-            esc_html__( 'Forums', 'bbpress' ),
+            bbp_maybe_append_pending_upgrade_count( esc_html__( 'Forums', 'bbpress' ) ),
             'bbp_tools_page',
             'bbp-repair',

trunk/src/includes/admin/tools.php

@@ -481 +481 @@
             $tab_class  = $is_current ? $active_class : $idle_class;
             $tab_url    = add_query_arg( array( 'page' => $tab['page'] ), admin_url( 'tools.php' ) );
-            $tabs_html .= '<a href="' . esc_url( $tab_url ) . '" class="' . esc_attr( $tab_class ) . '">' . esc_html( $tab['name'] ) . '</a>';
+
+            // Tab name is not escaped - may contain HTML
+            $tabs_html .= '<a href="' . esc_url( $tab_url ) . '" class="' . esc_attr( $tab_class ) . '">' . $tab['name'] . '</a>';
         }
 
@@ -515 +517 @@
             'func' => 'bbp_admin_upgrade_page',
             'cap'  => 'bbp_tools_upgrade_page',
-            'name' => esc_html__( 'Upgrade Forums', 'bbpress' ),
+            'name' => bbp_maybe_append_pending_upgrade_count( esc_html__( 'Upgrade Forums', 'bbpress' ) ),
 
             // Deprecated 2.6.0

trunk/src/includes/core/update.php

@@ -531 +531 @@
 
     // Maybe add upgrade ID to end of pending array
-    if ( ! isset( $pending[ $upgrade_id ] ) ) {
+    if ( false === array_search( $upgrade_id, $pending, true ) ) {
         array_push( $pending, $upgrade_id );
     }
@@ -568 +568 @@
     return delete_option( '_bbp_db_pending_upgrades' );
 }
+
+/**
+ * Maybe append an upgrade count to a string
+ *
+ * @since 2.6.0 bbPress (r6896)
+ *
+ * @param string $string
+ *
+ * @return string
+ */
+function bbp_maybe_append_pending_upgrade_count( $string = '' ) {
+
+    // Look for an upgrade count
+    $count = bbp_get_pending_upgrade_count();
+
+    // Append the count to the string
+    if ( ! empty( $count ) ) {
+        $suffix = ' <span class="awaiting-mod count-' . absint( $count ) . '"><span class="pending-count">' . bbp_number_format( $count ) . '</span></span>';
+        $string = "{$string}{$suffix}";
+    }
+
+    // Return the string, maybe with a count
+    return $string;
+}