Changeset 12990

Timestamp:

07/08/2021 05:23:32 PM (3 years ago)

Author:

dcavins

Message:

Add php fallback for dismissing site-wide notices.

Dismissal of sitewide notices has been handled
solely via JavaScript in the Legacy and Nouveau
template packs. This commit adds a new action
URI at {user_profile}/messages/notices/dismiss
that will dismiss the currently active notice for
the logged-in user.

We also add a new template function to create the
nonced link, bp_get_message_notice_dismiss_link(),
and make use of it in the core template function
bp_message_get_notices() and in the Nouveau
template for site-wide notices. In both cases, button
elements have been converted to anchor elements
linking to the new dismissal URI, so the action can be
completed even if there is a problem with JavaScript.

Fixes #8505.

Location:

trunk/src

Files:

• bp-messages/actions/notices.php (modified) (1 diff)
• bp-messages/bp-messages-template.php (modified) (2 diffs)
• bp-templates/bp-legacy/css/buddypress-rtl.css (modified) (2 diffs)
• bp-templates/bp-legacy/css/buddypress.css (modified) (2 diffs)
• bp-templates/bp-nouveau/buddypress/common/notices/template-notices.php (modified) (1 diff)

trunk/src/bp-messages/actions/notices.php

@@ -93 +93 @@
 }
 add_action( 'bp_actions', 'bp_messages_action_edit_notice' );
+
+/**
+ * Handle user dismissal of sitewide notices.
+ *
+ * @since 9.0.0
+ *
+ * @return bool False on failure.
+ */
+function bp_messages_action_dismiss_notice() {
+
+    // Bail if not viewing a notice dismissal URL.
+    if ( ! bp_is_messages_component() || ! bp_is_current_action( 'notices' ) || 'dismiss' !== sanitize_key( bp_action_variable( 0 ) ) ) {
+        return false;
+    }
+
+    // Bail if the current user isn't logged in.
+    if ( ! is_user_logged_in() ) {
+        return false;
+    }
+
+    // Check the nonce.
+    check_admin_referer( 'messages_dismiss_notice' );
+
+    // Dismiss the notice.
+    $success = bp_messages_dismiss_sitewide_notice();
+
+    // User feedback.
+    if ( $success ) {
+        $feedback = __( 'Notice has been dismissed.', 'buddypress' );
+        $type     = 'success';
+    } else {
+        $feedback = __( 'There was a problem dismissing the notice.', 'buddypress');
+        $type     = 'error';
+    }
+
+    // Add feedback message.
+    bp_core_add_message( $feedback, $type );
+
+    // Redirect.
+    $redirect_to = trailingslashit( bp_loggedin_user_domain() . bp_get_messages_slug() );
+
+    bp_core_redirect( $redirect_to );
+}
+add_action( 'bp_actions', 'bp_messages_action_dismiss_notice' );

trunk/src/bp-messages/bp-messages-template.php

@@ -1312 +1312 @@
 
 /**
+ * Output the URL for dismissing the current notice for the current user.
+ *
+ * @since 9.0.0
+ * @return string URL for dismissing the current notice for the current user.
+ */
+function bp_message_notice_dismiss_link() {
+    echo esc_url( bp_get_message_notice_dismiss_link() );
+}
+    /**
+     * Get the URL for dismissing the current notice for the current user.
+     *
+     * @since 9.0.0
+     * @return string URL for dismissing the current notice for the current user.
+     */
+    function bp_get_message_notice_dismiss_link() {
+
+        $link = wp_nonce_url( trailingslashit( bp_loggedin_user_domain() . bp_get_messages_slug() . '/notices/dismiss/' ), 'messages_dismiss_notice' );
+
+        /**
+         * Filters the URL for dismissing the current notice for the current user.
+         *
+         * @since 9.0.0
+         *
+         * @param string $link URL for dismissing the current notice.
+         */
+        return apply_filters( 'bp_get_message_notice_dismiss_link', $link );
+    }
+
+/**
  * Output the messages component slug.
  *
@@ -1360 +1389 @@
             <div id="message" class="info notice" rel="n-<?php echo esc_attr( $notice->id ); ?>">
                 <strong><?php bp_message_notice_subject( $notice ); ?></strong>
-                <button type="button" id="close-notice" class="bp-tooltip" data-bp-tooltip="<?php esc_attr_e( 'Dismiss this notice', 'buddypress' ) ?>"><span class="bp-screen-reader-text"><?php _e( 'Dismiss this notice', 'buddypress' ) ?></span> <span aria-hidden="true">&Chi;</span></button>
+                <a href="<?php bp_message_notice_dismiss_link(); ?>" id="close-notice" class="bp-tooltip button" data-bp-tooltip="<?php esc_attr_e( 'Dismiss this notice', 'buddypress' ) ?>"><span class="bp-screen-reader-text"><?php _e( 'Dismiss this notice', 'buddypress' ) ?></span> <span aria-hidden="true">&Chi;</span></a>
                 <?php bp_message_notice_text( $notice ); ?>
                 <?php wp_nonce_field( 'bp_messages_close_notice', 'close-notice-nonce' ); ?>

trunk/src/bp-templates/bp-legacy/css/buddypress-rtl.css

@@ -1429 +1429 @@
 
 .bp-site-wide-message #message button,
-.admin-bar-on #message button {
+.bp-site-wide-message #message a.button,
+.admin-bar-on #message button,
+.admin-bar-on #message a.button {
     font-size: 0.8em;
     padding: 2px 4px;
@@ -1437 +1439 @@
 }
 
-.admin-bar-on #message button {
+.admin-bar-on #message button,
+.admin-bar-on #message a.button {
     left: 10px;
     top: 7px;

trunk/src/bp-templates/bp-legacy/css/buddypress.css

@@ -1429 +1429 @@
 
 .bp-site-wide-message #message button,
-.admin-bar-on #message button {
+.bp-site-wide-message #message a.button,
+.admin-bar-on #message button,
+.admin-bar-on #message a.button {
     font-size: 0.8em;
     padding: 2px 4px;
@@ -1437 +1439 @@
 }
 
-.admin-bar-on #message button {
+.admin-bar-on #message button,
+.admin-bar-on #message a.button {
     right: 10px;
     top: 7px;

trunk/src/bp-templates/bp-nouveau/buddypress/common/notices/template-notices.php

@@ -13 +13 @@
     <?php if ( bp_nouveau_has_dismiss_button() ) : ?>
 
-        <button type="button" class="bp-tooltip" data-bp-tooltip="<?php echo esc_attr_x( 'Close', 'button', 'buddypress' ); ?>" aria-label="<?php esc_attr_e( 'Close this notice', 'buddypress' ); ?>" data-bp-close="<?php bp_nouveau_dismiss_button_type(); ?>"><span class="dashicons dashicons-dismiss" aria-hidden="true"></span></button>
+        <a href="<?php bp_message_notice_dismiss_link(); ?>" class="bp-tooltip" data-bp-tooltip="<?php echo esc_attr_x( 'Close', 'button', 'buddypress' ); ?>" aria-label="<?php esc_attr_e( 'Close this notice', 'buddypress' ); ?>" data-bp-close="<?php bp_nouveau_dismiss_button_type(); ?>"><span class="dashicons dashicons-dismiss" aria-hidden="true"></span></a>
 
     <?php endif; ?>