Changeset 14124

Timestamp:

04/19/2025 01:12:19 PM (10 months ago)

Author:

espellcaste

Message:

WPCS - miscellaneous fixes for the BP Settings component.

See #9174
See #9173

Location:

trunk

Files:

• phpcs.xml.dist (modified) (1 diff)
• src/bp-settings/actions/capabilities.php (modified) (1 diff)
• src/bp-settings/actions/general.php (modified) (4 diffs)
• src/bp-settings/actions/notifications.php (modified) (1 diff)
• src/bp-settings/bp-settings-filters.php (modified) (2 diffs)
• src/bp-settings/bp-settings-functions.php (modified) (5 diffs)
• src/bp-settings/bp-settings-template.php (modified) (1 diff)
• src/bp-settings/classes/class-bp-settings-component.php (modified) (3 diffs)

trunk/phpcs.xml.dist

@@ -52 +52 @@
         <exclude name="Generic.WhiteSpace.ScopeIndent.IncorrectExact" />
 
+        <!-- Usually harmless, let's skip them. -->
+        <exclude name="Squiz.Commenting.InlineComment.InvalidEndChar" />
+        <exclude name="Squiz.PHP.CommentedOutCode.Found" />
+
         <exclude name="WordPress.Security.ValidatedSanitizedInput.InputNotValidated" />
         <exclude name="WordPress.Security.ValidatedSanitizedInput.InputNotSanitized" />

trunk/src/bp-settings/actions/capabilities.php

@@ -54 +54 @@
     $is_spammer = ! empty( $_POST['user-spammer'] ) ? true : false;
 
-    if ( bp_is_user_spammer( bp_displayed_user_id() ) != $is_spammer ) {
-        $status = ( true == $is_spammer ) ? 'spam' : 'ham';
+    if ( bp_is_user_spammer( bp_displayed_user_id() ) !== $is_spammer ) {
+        $status = ( true === $is_spammer ) ? 'spam' : 'ham';
         bp_core_process_spammer_status( bp_displayed_user_id(), $status );
 

trunk/src/bp-settings/actions/general.php

@@ -156 +156 @@
                 if ( ! $pass_error->get_error_message() ) {
                     // Password change attempt is successful.
-                    if ( ( ! empty( $_POST['pwd'] ) && wp_unslash( $_POST['pwd'] ) !== $pass ) || is_super_admin() )  {
+                    if ( ( ! empty( $_POST['pwd'] ) && wp_unslash( $_POST['pwd'] ) !== $pass ) || is_super_admin() ) {
                         $update_user['user_pass'] = $_POST['pass1'];
                         $pass_error               = false;
@@ -196 +196 @@
     // Email feedback.
     switch ( $email_error ) {
-        case 'invalid' :
-            $feedback['email_invalid']  = __( 'That email address is invalid. Check the formatting and try again.', 'buddypress' );
-            break;
-        case 'blocked' :
-            $feedback['email_blocked']  = __( 'That email address is currently unavailable for use.', 'buddypress' );
-            break;
-        case 'taken' :
-            $feedback['email_taken']    = __( 'That email address is already taken.', 'buddypress' );
-            break;
-        case 'empty' :
-            $feedback['email_empty']    = __( 'Email address cannot be empty.', 'buddypress' );
-            break;
-        case false :
+        case 'invalid':
+            $feedback['email_invalid'] = __( 'That email address is invalid. Check the formatting and try again.', 'buddypress' );
+            break;
+        case 'blocked':
+            $feedback['email_blocked'] = __( 'That email address is currently unavailable for use.', 'buddypress' );
+            break;
+        case 'taken':
+            $feedback['email_taken'] = __( 'That email address is already taken.', 'buddypress' );
+            break;
+        case 'empty':
+            $feedback['email_empty'] = __( 'Email address cannot be empty.', 'buddypress' );
+            break;
+        case false:
             // No change.
             break;
@@ -218 +218 @@
 
     // No errors so show a simple success message.
-    if ( ( ( false === $email_error ) || ( false == $pass_error ) ) && ( ( true === $pass_changed ) || ( true === $email_changed ) ) ) {
+    if ( ( ( false === $email_error ) || ( false === $pass_error ) ) && ( ( true === $pass_changed ) || ( true === $email_changed ) ) ) {
         $feedback[]    = __( 'Your settings have been saved.', 'buddypress' );
         $feedback_type = 'success';
@@ -297 +297 @@
         }
 
-        $email_changed = wp_update_user( array(
-            'ID'         => $user_id,
-            'user_email' => trim( $pending_email['newemail'] ),
-        ) );
+        $email_changed = wp_update_user(
+            array(
+                'ID'         => $user_id,
+                'user_email' => trim( $pending_email['newemail'] ),
+            )
+        );
 
         if ( $email_changed ) {

trunk/src/bp-settings/actions/notifications.php

@@ -40 +40 @@
     // Switch feedback for super admins.
     if ( bp_is_my_profile() ) {
-        bp_core_add_message( __( 'Your notification settings have been saved.',        'buddypress' ), 'success' );
+        bp_core_add_message( __( 'Your notification settings have been saved.', 'buddypress' ), 'success' );
     } else {
         bp_core_add_message( __( "This user's notification settings have been saved.", 'buddypress' ), 'success' );

trunk/src/bp-settings/bp-settings-filters.php

@@ -8 +8 @@
  */
 
-// Personal data export.
-add_filter( 'wp_privacy_personal_data_exporters', 'bp_settings_register_personal_data_exporter' );
+// Exit if accessed directly.
+defined( 'ABSPATH' ) || exit;
 
 /**
@@ -29 +29 @@
     return $exporters;
 }
+add_filter( 'wp_privacy_personal_data_exporters', 'bp_settings_register_personal_data_exporter' );

trunk/src/bp-settings/bp-settings-functions.php

@@ -89 +89 @@
  */
 function bp_settings_get_registered_notification_keys() {
-
     ob_start();
+
     /**
      * Fires at the start of the building of the notification keys allowed list.
@@ -97 +97 @@
      */
     do_action( 'bp_notification_settings' );
+
     $screen = ob_get_clean();
 
@@ -114 +115 @@
  *
  * @since 4.0.0
- *
- * @param string $email_address  The user's email address.
- * @param int    $page           Batch number.
+ * @since 15.0.0 The `$page` parameter was removed since it was unused.
+ *
+ * @param string $email_address The user's email address.
  * @return array An array of personal data.
  */
-function bp_settings_personal_data_exporter( $email_address, $page ) {
+function bp_settings_personal_data_exporter( $email_address ) {
     $email_address = trim( $email_address );
 
@@ -239 +240 @@
     }
 
-    $query = new WP_Query( array(
-        'author'        => (int) $user_id,
-        'post_type'     => 'user_request',
-        'post_status'   => 'any',
-        'post_name__in' => array(
-            'export_personal_data',
-        ),
-    ) );
+    $query = new WP_Query(
+        array(
+            'author'        => (int) $user_id,
+            'post_type'     => 'user_request',
+            'post_status'   => 'any',
+            'post_name__in' => array(
+                'export_personal_data',
+            ),
+        )
+    );
 
     if ( ! empty( $query->post ) ) {
         return wp_get_user_request( $query->post->ID );
-    } else {
-        return false;
-    }
+    }
+
+    return false;
 }
 
@@ -328 +331 @@
     /** This filter is documented in /wp-admin/includes/ajax-actions.php */
     $exporters             = apply_filters( 'wp_privacy_personal_data_exporters', array() );
-    $custom_friendly_names = apply_filters( 'bp_settings_data_custom_friendly_names', array(
-        'wordpress-comments' => _x( 'Comments', 'WP Comments data exporter friendly name', 'buddypress' ),
-        'wordpress-media'    => _x( 'Media', 'WP Media data exporter friendly name', 'buddypress' ),
-        'wordpress-user'     => _x( 'Personal information', 'WP Media data exporter friendly name', 'buddypress' ),
-    ) );
+    $custom_friendly_names = apply_filters(
+        'bp_settings_data_custom_friendly_names',
+        array(
+            'wordpress-comments' => _x( 'Comments', 'WP Comments data exporter friendly name', 'buddypress' ),
+            'wordpress-media'    => _x( 'Media', 'WP Media data exporter friendly name', 'buddypress' ),
+            'wordpress-user'     => _x( 'Personal information', 'WP Media data exporter friendly name', 'buddypress' ),
+        )
+    );
 
 ?>
     <ul>
-    <?php foreach ( $exporters as $exporter => $data ) :
+    <?php
+    foreach ( $exporters as $exporter => $data ) :
         // Use the exporter friendly name by default.
         $friendly_name = $data['exporter_friendly_name'];

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

@@ -79 +79 @@
     }
 
-    if ( bp_get_displayed_user_email() == $pending_email['newemail'] ) {
+    if ( bp_get_displayed_user_email() === $pending_email['newemail'] ) {
         return;
     }

trunk/src/bp-settings/classes/class-bp-settings-component.php

@@ -43 +43 @@
      */
     public function includes( $includes = array() ) {
-        parent::includes( array(
-            'template',
-            'filters',
-            'functions',
-        ) );
+        parent::includes(
+            array(
+                'template',
+                'filters',
+                'functions',
+            )
+        );
     }
 
@@ -113 +115 @@
 
         // All globals for settings component.
-        parent::setup_globals( array(
-            'slug'          => $default_slug,
-            'has_directory' => false,
-        ) );
+        parent::setup_globals(
+            array(
+                'slug'          => $default_slug,
+                'has_directory' => false,
+            )
+        );
     }
 
@@ -132 +136 @@
      */
     public function register_nav( $main_nav = array(), $sub_nav = array() ) {
-        $slug   = bp_get_settings_slug();
+        $slug = bp_get_settings_slug();
 
         // Add the settings navigation item.