WPCS - miscellaneous fixes for the BP Settings component.

See #9174
See #9173

git-svn-id: https://buddypress.svn.wordpress.org/trunk@14124 cdf35c40-ae34-48e0-9cc9-0c9da1808c22

Author: renatonascalves

phpcs.xml.dist

@@ -51,6 +51,10 @@
 		<exclude name="Generic.WhiteSpace.ScopeIndent.Incorrect" />
 		<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" />
 		<exclude name="WordPress.Security.NonceVerification.Missing" />

src/bp-settings/actions/capabilities.php

@@ -53,8 +53,8 @@ function bp_settings_action_capabilities() {
 
 	$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 );
 
 		/**

src/bp-settings/actions/general.php

@@ -155,7 +155,7 @@ function bp_settings_action_general() {
 
 				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;
 						$pass_changed             = true;
@@ -195,19 +195,19 @@ function bp_settings_action_general() {
 
 	// Email feedback.
 	switch ( $email_error ) {
-		case 'invalid' :
-			$feedback['email_invalid']  = __( 'That email address is invalid. Check the formatting and try again.', 'buddypress' );
+		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' );
+		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' );
+		case 'taken':
+			$feedback['email_taken'] = __( 'That email address is already taken.', 'buddypress' );
 			break;
-		case 'empty' :
-			$feedback['email_empty']    = __( 'Email address cannot be empty.', 'buddypress' );
+		case 'empty':
+			$feedback['email_empty'] = __( 'Email address cannot be empty.', 'buddypress' );
 			break;
-		case false :
+		case false:
 			// No change.
 			break;
 	}
@@ -217,7 +217,7 @@ function bp_settings_action_general() {
 	}
 
 	// 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';
 
@@ -296,10 +296,12 @@ function bp_settings_verify_email_change() {
 			return;
 		}
 
-		$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 ) {
 			// Delete the pending email change key.

src/bp-settings/actions/notifications.php

@@ -39,7 +39,7 @@ function bp_settings_action_notifications() {
 
 	// 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' );
 	}

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

@@ -7,8 +7,8 @@
  * @since 4.0.0
  */
 
-// Personal data export.
-add_filter( 'wp_privacy_personal_data_exporters', 'bp_settings_register_personal_data_exporter' );
+// Exit if accessed directly.
+defined( 'ABSPATH' ) || exit;
 
 /**
  * Registers Settings personal data exporter.
@@ -28,3 +28,4 @@ function bp_settings_register_personal_data_exporter( $exporters ) {
 
 	return $exporters;
 }
+add_filter( 'wp_privacy_personal_data_exporters', 'bp_settings_register_personal_data_exporter' );

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

@@ -88,14 +88,15 @@ function bp_settings_sanitize_notification_settings( $settings = array() ) {
  * @return array
  */
 function bp_settings_get_registered_notification_keys() {
-
 	ob_start();
+
 	/**
 	 * Fires at the start of the building of the notification keys allowed list.
 	 *
 	 * @since 1.0.0
 	 */
 	do_action( 'bp_notification_settings' );
+
 	$screen = ob_get_clean();
 
 	$matched = preg_match_all( '/<input[^>]+name="notifications\[([^\]]+)\]/', $screen, $matches );
@@ -113,12 +114,12 @@ function bp_settings_get_registered_notification_keys() {
  * Finds and exports personal data associated with an email address from the Settings component.
  *
  * @since 4.0.0
+ * @since 15.0.0 The `$page` parameter was removed since it was unused.
  *
- * @param string $email_address  The user's email address.
- * @param int    $page           Batch number.
+ * @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 );
 
 	$data_to_export = array();
@@ -238,20 +239,22 @@ function bp_settings_get_personal_data_request( $user_id = 0 ) {
 		return false;
 	}
 
-	$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;
 }
 
 /**
@@ -327,15 +330,19 @@ function bp_settings_personal_data_export_exists( WP_User_Request $request ) {
 function bp_settings_data_exporter_items() {
 	/** 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'];
 

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

@@ -78,7 +78,7 @@ function bp_settings_pending_email_notice() {
 		return;
 	}
 
-	if ( bp_get_displayed_user_email() == $pending_email['newemail'] ) {
+	if ( bp_get_displayed_user_email() === $pending_email['newemail'] ) {
 		return;
 	}
 

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

@@ -42,11 +42,13 @@ public function __construct() {
 	 * @param array $includes Array of values to include. Not used.
 	 */
 	public function includes( $includes = array() ) {
-		parent::includes( array(
-			'template',
-			'filters',
-			'functions',
-		) );
+		parent::includes(
+			array(
+				'template',
+				'filters',
+				'functions',
+			)
+		);
 	}
 
 	/**
@@ -112,10 +114,12 @@ public function setup_globals( $args = array() ) {
 		}
 
 		// 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,
+			)
+		);
 	}
 
 	/**
@@ -131,7 +135,7 @@ public function setup_globals( $args = array() ) {
 	 *                        description.
 	 */
 	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.
 		$main_nav = array(