Role field

Author: polevaultweb

includes/actions.php

@@ -456,25 +456,7 @@ function wpum_action_profile_update( $userId, $oldUserData = [] ) {
 		$user = get_user_by('ID', $userId);
 
 		$wpum_roles = explode( '|', $_POST['_wpum_user_roles'] );
-		$currentRoles = $user->roles;
-
-		if ( empty( $wpum_roles ) || ! is_array( $wpum_roles )) {
-			return;
-		}
-
-		// Remove unselected roles
-		foreach ( $currentRoles as $role ) {
-			if ( ! in_array( $role, $wpum_roles ) ) {
-				$user->remove_role( $role );
-			}
-		}
-
-		// Add new roles
-		foreach ( $wpum_roles as $role ) {
-			if ( ! in_array( $role, $currentRoles ) ) {
-				$user->add_role( $role );
-			}
-		}
+		wpum_update_roles( $wpum_roles, $user );
 	}
 }
 

includes/functions.php

@@ -439,6 +439,32 @@ function wpum_send_registration_confirmation_email( $user_id, $psw = false, $pas
 	$emails->__set( 'plain_text_password', null );
 }
 
+/**
+ * @param array $roles
+ * @param WP_User $user
+ */
+function wpum_update_roles( $roles, $user, $remove_whitelist = array() ) {
+	$currentRoles = $user->roles;
+
+	if ( empty( $roles ) || ! is_array( $roles )) {
+		return;
+	}
+
+	// Remove unselected roles
+	foreach ( $currentRoles as $role ) {
+		if ( ( empty( $remove_whitelist ) || in_array( $role, $remove_whitelist ) ) && ! in_array( $role, $roles ) ) {
+			$user->remove_role( $role );
+		}
+	}
+
+	// Add new roles
+	foreach ( $roles as $role ) {
+		if ( ! in_array( $role, $currentRoles ) ) {
+			$user->add_role( $role );
+		}
+	}
+}
+
 /**
  * @param WP_User $user
  */

includes/wpum-fields/class-wpum-fields.php

@@ -63,6 +63,7 @@ public function load() {
 			'hidden',
 			'taxonomy',
 			'user',
+			'userrole',
 		] );
 
 		foreach ( $fields as $field ) {

includes/wpum-fields/types/class-wpum-field-userrole.php

@@ -0,0 +1,90 @@
+<?php
+/**
+ * Registers a User field for the forms.
+ *
+ * @package     wp-user-manager
+ * @copyright   Copyright (c) 2021, WP User Manager
+ * @license     https://opensource.org/licenses/GPL-3.0 GNU Public License
+ */
+
+// Exit if accessed directly
+if ( ! defined( 'ABSPATH' ) ) exit;
+
+/**
+ * Register a dropdown field type.
+ */
+class WPUM_Field_Userrole extends WPUM_Field_Type {
+
+	public function __construct() {
+		$this->name  = esc_html__( 'User Role', 'wp-user-manager' );
+		$this->type  = 'userrole';
+		$this->icon  = 'dashicons-admin-generic';
+		$this->group = 'advanced';
+		$this->allow_default = true;
+		$this->min_addon_version = '2.5';
+	}
+
+	public function get_data_keys() {
+		$keys = parent::get_data_keys();
+
+		return array_merge( $keys, array_keys( $this->get_editor_settings()['general'] ) );
+	}
+
+	/**
+	 * @return array
+	 */
+	public function get_editor_settings() {
+		$settings = [
+			'general' => [
+				'options'    => array(
+					'type'     => 'multiselect',
+					'label'    => __( 'User Roles', 'wp-user-manager' ),
+					'hint'     => esc_html__( 'List of roles the users can select from', 'wp-user-manager' ),
+					'model'    => 'options',
+					'labels'   => [],
+					'required' => true,
+					'options'  => wpum_get_roles(),
+					'multiple' => true,
+				),
+				'type_label' => array(
+					'type'      => 'input',
+					'inputType' => 'text',
+					'label'     => esc_html__( 'Type label', 'wp-user-manager' ),
+					'model'     => 'type_label',
+					'default'   => 'Role',
+				),
+			],
+		];
+
+		if ( wpum_get_option( 'allow_multiple_user_roles' ) ) {
+			$settings['allow_multiple'] = array(
+				'type'    => 'checkbox',
+				'label'   => esc_html__( 'Allow multiple selection', 'wp-user-manager' ),
+				'hint'    => esc_html__( 'Allow users to select multiple roles for themselves', 'wp-user-manager' ),
+				'model'   => 'allow_multiple',
+				'default' => false,
+			);
+		}
+
+		return $settings;
+	}
+
+	/**
+	 * Format the output onto the profiles for the taxonomy field.
+	 *
+	 * @param object $field
+	 * @param mixed $value
+	 * @return string
+	 */
+	function get_formatted_output( $field, $value ) {
+		if ( ! is_array( $value ) ) {
+			$value = array( $value );
+		}
+
+		return implode( ', ', $value );
+	}
+
+	public function template() {
+		return $this->type;
+	}
+}

templates/form-fields/userrole-field.php

@@ -0,0 +1,23 @@
+<?php
+/**
+ * The template for displaying the user role field.
+ *
+ * This template can be overridden by copying it to yourtheme/wpum/form-fields/userrole-field.php
+ *
+ * HOWEVER, on occasion WPUM will need to update template files and you
+ * (the theme developer) will need to copy the new files to your theme to
+ * maintain compatibility. We try to do this as little as possible, but it does
+ * happen. When this occurs the version of the template file will be bumped and
+ * the readme will list any important changes.
+ *
+ * @version 1.0.0
+ */
+
+ // Exit if accessed directly
+if ( ! defined( 'ABSPATH' ) ) exit;
+
+$field_type = empty( $data->allow_multiple ) ? 'select' : 'multiselect';
+
+$data->options = apply_filters( 'wpum_user_role_field_options', $data->options, $data );
+
+WPUM()->templates->set_template_data( $data )->get_template_part( 'form-fields/' . $field_type, 'field' );