# edit-flow/trunk/modules/user-groups/user-groups.php

Edit Flow, version trunk. 1,430 lines.

- Page: https://pluginprobe.com/plugins/edit-flow/trunk/code/modules/user-groups/user-groups.php
- Raw: https://pluginprobe.com/plugins/edit-flow/trunk/raw/modules/user-groups/user-groups.php
- Modified: 2026-06-10T10:58:52+00:00

Line numbers below start at 1. Link to a line or a range by appending a fragment to the
page URL, for example `https://pluginprobe.com/plugins/edit-flow/trunk/code/modules/user-groups/user-groups.php#L10-L20`.

```php
<?php
/**
 * User Groups module for Edit Flow.
 *
 * @package EditFlow
 *
 * @todo all of them PHPdocs
 * @todo Resolve whether the notifications component of this class should be moved to "subscriptions"
 * @todo Decide whether it's functional to store user_ids in the term description array
 * - Argument against: it's going to be expensive to look up usergroups for a user
 */

if ( ! class_exists( 'EF_User_Groups' ) ) {

	/**
	 * User Groups module for Edit Flow.
	 */
	class EF_User_Groups extends EF_Module {

		/**
		 * The module instance.
		 *
		 * @var object
		 */
		public $module;

		/**
		 * Taxonomy key used for custom taxonomy.
		 *
		 * @var string
		 */
		// phpcs:ignore Generic.NamingConventions.UpperCaseConstantName.ClassConstantNotUpperCase
		const taxonomy_key = 'ef_usergroup';

		/**
		 * Term prefix used for custom taxonomy terms.
		 *
		 * @var string
		 */
		// phpcs:ignore Generic.NamingConventions.UpperCaseConstantName.ClassConstantNotUpperCase
		const term_prefix = 'ef-usergroup-';

		/**
		 * Capability required to manage user groups.
		 *
		 * @var string
		 */
		public $manage_usergroups_cap = 'edit_usergroups';

		/**
		 * Register the module with Edit Flow but don't do anything else.
		 *
		 * @since 0.7
		 */
		public function __construct() {

			$this->module_url = $this->get_module_url( __FILE__ );

			// Register the User Groups module with Edit Flow.
			$args         = array(
				'title'                 => __( 'User Groups', 'edit-flow' ),
				'short_description'     => __( 'Organize your users into groups to mimic your organizational structure.', 'edit-flow' ),
				'extended_description'  => __( 'Configure user groups to organize all of the users on your site. Each user can be in many user groups and you can change them at any time.', 'edit-flow' ),
				'module_url'            => $this->module_url,
				'img_url'               => $this->module_url . 'lib/usergroups_s128.png',
				'slug'                  => 'user-groups',
				'default_options'       => array(
					'enabled'    => 'on',
					'post_types' => array(
						'post' => 'on',
						'page' => 'off',
					),
				),
				'messages'              => array(
					'usergroup-added'   => __( 'User group created. Feel free to add users to the usergroup.', 'edit-flow' ),
					'usergroup-updated' => __( 'User group updated.', 'edit-flow' ),
					'usergroup-missing' => __( "User group doesn't exist.", 'edit-flow' ),
					'usergroup-deleted' => __( 'User group deleted.', 'edit-flow' ),
				),
				'configure_page_cb'     => 'print_configure_view',
				'configure_link_text'   => __( 'Manage User Groups', 'edit-flow' ),
				'autoload'              => false,
				'settings_help_tab'     => array(
					'id'      => 'ef-user-groups-overview',
					'title'   => __( 'Overview', 'edit-flow' ),
					'content' => __( '<p>For those with many people involved in the publishing process, user groups helps you keep them organized.</p><p>Currently, user groups are primarily used for subscribing a set of users to a post for notifications.</p>', 'edit-flow' ),
				),
				'settings_help_sidebar' => __( '<p><strong>For more information:</strong></p><p><a href="https://editflow.org/features/user-groups/">User Groups Documentation</a></p><p><a href="https://wordpress.org/support/plugin/edit-flow/">Edit Flow Forum</a></p><p><a href="https://github.com/Automattic/Edit-Flow">Edit Flow on GitHub</a></p>', 'edit-flow' ),
			);
			$this->module = EditFlow()->register_module( 'user_groups', $args );
		}

		/**
		 * Module startup
		 */

		/**
		 * Initialize the rest of the stuff in the class if the module is active
		 *
		 * @since 0.7
		 */
		public function init() {

			// Register the objects where we'll be storing data and relationships.
			$this->register_usergroup_objects();

			$this->manage_usergroups_cap = apply_filters( 'ef_manage_usergroups_cap', $this->manage_usergroups_cap );

			// Register our settings.
			add_action( 'admin_init', array( $this, 'register_settings' ) );

			// Handle any adding, editing or saving.
			add_action( 'admin_init', array( $this, 'handle_add_usergroup' ) );
			add_action( 'admin_init', array( $this, 'handle_edit_usergroup' ) );
			add_action( 'admin_init', array( $this, 'handle_delete_usergroup' ) );
			add_action( 'wp_ajax_inline_save_usergroup', array( $this, 'handle_ajax_inline_save_usergroup' ) );

			// Usergroups can be managed from the User profile view.
			add_action( 'show_user_profile', array( $this, 'user_profile_page' ) );
			add_action( 'edit_user_profile', array( $this, 'user_profile_page' ) );
			add_action( 'user_profile_update_errors', array( $this, 'user_profile_update' ), 10, 3 );

			// Javascript and CSS if we need it.
			add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_admin_scripts' ) );
			add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_admin_styles' ) );
		}

		/**
		 * Load the capabilities onto users the first time the module is run
		 *
		 * @since 0.7
		 */
		public function install() {

			// Add necessary capabilities to allow management of user groups.
			$usergroup_roles = array(
				'administrator' => array( 'edit_usergroups' ),
			);
			foreach ( $usergroup_roles as $role => $caps ) {
				$this->add_caps_to_role( $role, $caps );
			}

			// Create our default usergroups.
			$default_usergroups = array(
				array(
					'name'        => __( 'Copy Editors', 'edit-flow' ),
					'description' => __( 'Making sure the quality is top-notch.', 'edit-flow' ),
				),
				array(
					'name'        => __( 'Photographers', 'edit-flow' ),
					'description' => __( 'Capturing the story visually.', 'edit-flow' ),
				),
				array(
					'name'        => __( 'Reporters', 'edit-flow' ),
					'description' => __( 'Out in the field, writing stories.', 'edit-flow' ),
				),
				array(
					'name'        => __( 'Section Editors', 'edit-flow' ),
					'description' => __( 'Providing feedback and direction.', 'edit-flow' ),
				),
			);
			foreach ( $default_usergroups as $args ) {
				$this->add_usergroup( $args );
			}
		}

		/**
		 * Upgrade our data in case we need to.
		 *
		 * @since 0.7
		 *
		 * @param string $previous_version The previous plugin version.
		 */
		public function upgrade( $previous_version ) {
			global $edit_flow;

			// Upgrade path to v0.7.
			if ( version_compare( $previous_version, '0.7', '<' ) ) {
				global $wpdb;

				// Set all of the user group terms to our new taxonomy.
				// phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching -- One-time upgrade query.
				$wpdb->update( $wpdb->term_taxonomy, array( 'taxonomy' => self::taxonomy_key ), array( 'taxonomy' => 'following_usergroups' ) );

				// Get all of the users who are a part of user groups and assign them to their new user group values.
				$query = "SELECT * FROM $wpdb->usermeta WHERE meta_key='wp_ef_usergroups';";
				// There's no userdata here in this query and it's an upgrade query.
				// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared, WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching
				$usergroup_users = $wpdb->get_results( $query );

				// Sort all of the users based on their usergroup(s).
				$users_to_add = array();
				foreach ( (array) $usergroup_users as $usergroup_user ) {
					if ( is_object( $usergroup_user ) ) {
						$users_to_add[ $usergroup_user->meta_value ][] = (int) $usergroup_user->user_id;
					}
				}
				// Add user IDs to each usergroup.
				foreach ( $users_to_add as $usergroup_slug => $users_array ) {
					$usergroup = $this->get_usergroup_by( 'slug', $usergroup_slug );
					$this->add_users_to_usergroup( $users_array, $usergroup->term_id );
				}
				// Update the term slugs for each user group.
				$all_usergroups = $this->get_usergroups();
				foreach ( $all_usergroups as $usergroup ) {
					$new_slug = str_replace( 'ef_', self::term_prefix, $usergroup->slug );
					$this->update_usergroup( $usergroup->term_id, array( 'slug' => $new_slug ) );
				}

				// Delete all of the previous usermeta values.
				// phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching -- One-time upgrade query.
				$wpdb->query( "DELETE FROM $wpdb->usermeta WHERE meta_key='wp_ef_usergroups';" );

				// Technically we've run this code before so we don't want to auto-install new data.
				$edit_flow->update_module_option( $this->module->name, 'loaded_once', true );
			}
			// Upgrade path to v0.7.4.
			if ( version_compare( $previous_version, '0.7.4', '<' ) ) {
				// Usergroup descriptions become base64_encoded, instead of maybe json_encoded.
				$this->upgrade_074_term_descriptions( self::taxonomy_key );
			}
		}

		/**
		 * Register usergroup objects.
		 *
		 * Individual Usergroups are stored using a custom taxonomy.
		 * Posts are associated with usergroups based on taxonomy relationship.
		 * User associations are stored serialized in the term's description field.
		 *
		 * @since 0.7
		 *
		 * @uses register_taxonomy()
		 */
		public function register_usergroup_objects() {

			// Load the currently supported post types so we only register against those.
			$supported_post_types = $this->get_post_types_for_module( $this->module );

			// Use a taxonomy to manage relationships between posts and usergroups.
			$args = array(
				'public'  => false,
				'rewrite' => false,
			);
			register_taxonomy( self::taxonomy_key, $supported_post_types, $args );
		}

		/**
		 * Enqueue necessary admin scripts
		 *
		 * @since 0.7
		 *
		 * @uses wp_enqueue_script()
		 */
		public function enqueue_admin_scripts() {

			if ( $this->is_post_management_page( $this->module->name ) || $this->is_whitelisted_settings_view( $this->module->name ) ) {
				wp_enqueue_script( 'jquery-listfilterizer' );
				wp_enqueue_script( 'edit-flow-user-groups-js', $this->module_url . 'lib/user-groups.js', array( 'jquery', 'jquery-listfilterizer' ), EDIT_FLOW_VERSION, true );
			}

			if ( $this->is_whitelisted_settings_view( $this->module->name ) ) {
				wp_enqueue_script( 'edit-flow-user-groups-configure-js', $this->module_url . 'lib/user-groups-configure.js', array( 'jquery' ), EDIT_FLOW_VERSION, true );
			}
		}

		/**
		 * Enqueue necessary admin styles, but only on the proper pages
		 *
		 * @since 0.7
		 *
		 * @uses wp_enqueue_style()
		 */
		public function enqueue_admin_styles() {


			if ( $this->is_post_management_page( $this->module->name ) || $this->is_whitelisted_settings_view( $this->module->name ) ) {
				wp_enqueue_style( 'jquery-listfilterizer' );
				wp_enqueue_style( 'edit-flow-user-groups-css', $this->module_url . 'lib/user-groups.css', false, EDIT_FLOW_VERSION );
			}
		}

		/**
		 * Module ???
		 */

		/**
		 * Handles a POST request to add a new Usergroup. Redirects to edit view after
		 * for admin to add users to usergroup
		 * Hooked into 'admin_init' and kicks out right away if no action
		 *
		 * @since 0.7
		 */
		public function handle_add_usergroup() {
			// phpcs:disable WordPress.Security.NonceVerification.Missing, WordPress.Security.NonceVerification.Recommended -- Nonce verified below.
			if ( ! isset( $_POST['submit'], $_POST['form-action'], $_GET['page'] )
			|| $_GET['page'] != $this->module->settings_slug || 'add-usergroup' != $_POST['form-action'] ) {
				return;
			}
			// phpcs:enable WordPress.Security.NonceVerification.Missing, WordPress.Security.NonceVerification.Recommended

			// phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- Nonce value passed directly to wp_verify_nonce().
			if ( ! isset( $_POST['_wpnonce'] ) || ! wp_verify_nonce( $_POST['_wpnonce'], 'add-usergroup' ) ) {
				wp_die( esc_html( $this->module->messages['nonce-failed'] ) );
			}

			if ( ! current_user_can( $this->manage_usergroups_cap ) ) {
				wp_die( esc_html( $this->module->messages['invalid-permissions'] ) );
			}

			// Sanitize all of the user-entered values.
			// phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- Values are sanitized below.
			$name = ( isset( $_POST['name'] ) ) ? sanitize_text_field( trim( $_POST['name'] ) ) : '';
			// phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- Values are sanitized below.
			$description = ( isset( $_POST['description'] ) ) ? stripslashes( wp_filter_nohtml_kses( trim( $_POST['description'] ) ) ) : '';

			EditFlow()->settings->form_errors = array();

			/*
			 * Form validation for adding new Usergroup.
			 *
			 * Details:
			 * - 'name' is a required field, but can't match an existing name or slug. Needs to be 40 characters or less.
			 * - "description" can accept a limited amount of HTML, and is optional.
			 */
			// Field is required.
			if ( empty( $name ) ) {
				EditFlow()->settings->form_errors['name'] = __( 'Please enter a name for the user group.', 'edit-flow' );
			}
			// Check to ensure a term with the same name doesn't exist.
			if ( $this->get_usergroup_by( 'name', $name ) ) {
				EditFlow()->settings->form_errors['name'] = __( 'Name already in use. Please choose another.', 'edit-flow' );
			}
			// Check to ensure a term with the same slug doesn't exist.
			if ( $this->get_usergroup_by( 'slug', sanitize_title( $name ) ) ) {
				EditFlow()->settings->form_errors['name'] = __( 'Name conflicts with slug for another term. Please choose again.', 'edit-flow' );
			}
			if ( strlen( $name ) > 40 ) {
				EditFlow()->settings->form_errors['name'] = __( 'User group name cannot exceed 40 characters. Please try a shorter name.', 'edit-flow' );
			}
			// Kick out if there are any errors.
			if ( count( EditFlow()->settings->form_errors ) ) {
				$_REQUEST['error'] = 'form-error';
				return;
			}

			// Try to add the Usergroup.
			$args      = array(
				'name'        => $name,
				'description' => $description,
			);
			$usergroup = $this->add_usergroup( $args );
			if ( is_wp_error( $usergroup ) ) {
				wp_die( esc_html__( 'Error adding usergroup.', 'edit-flow' ) );
			}

			$args         = array(
				'action'       => 'edit-usergroup',
				'usergroup-id' => $usergroup->term_id,
				'message'      => 'usergroup-added',
			);
			$redirect_url = $this->get_link( $args );
			// phpcs:ignore WordPress.Security.SafeRedirect.wp_redirect_wp_redirect -- Redirect URL is constructed internally.
			wp_redirect( $redirect_url );
			exit;
		}

		/**
		 * Handles a POST request to edit a Usergroup.
		 *
		 * Hooked into 'admin_init' and kicks out right away if no action.
		 *
		 * @since 0.7
		 */
		public function handle_edit_usergroup() {
			// phpcs:disable WordPress.Security.NonceVerification.Missing, WordPress.Security.NonceVerification.Recommended -- Nonce verified below.
			if ( ! isset( $_POST['submit'], $_POST['form-action'], $_GET['page'] )
			|| $_GET['page'] != $this->module->settings_slug || 'edit-usergroup' != $_POST['form-action'] ) {
				return;
			}
			// phpcs:enable WordPress.Security.NonceVerification.Missing, WordPress.Security.NonceVerification.Recommended

			// phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- Nonce value passed directly to wp_verify_nonce().
			if ( ! isset( $_POST['_wpnonce'] ) || ! wp_verify_nonce( $_POST['_wpnonce'], 'edit-usergroup' ) ) {
				wp_die( esc_html( $this->module->messages['nonce-failed'] ) );
			}

			if ( ! current_user_can( $this->manage_usergroups_cap ) ) {
				wp_die( esc_html( $this->module->messages['invalid-permissions'] ) );
			}

			$usergroup_id       = isset( $_POST['usergroup_id'] ) ? (int) $_POST['usergroup_id'] : 0;
			$existing_usergroup = $this->get_usergroup_by( 'id', $usergroup_id );
			if ( ! $existing_usergroup ) {
				wp_die( esc_html( $this->module->messages['usergroup-missing'] ) );
			}

			// Sanitize all of the user-entered values.
			// phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- Values are sanitized below.
			$name = isset( $_POST['name'] ) ? sanitize_text_field( trim( $_POST['name'] ) ) : '';
			// phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- Values are sanitized below.
			$description = isset( $_POST['description'] ) ? stripslashes( wp_filter_nohtml_kses( trim( $_POST['description'] ) ) ) : '';

			EditFlow()->settings->form_errors = array();

			/*
			 * Form validation for editing a Usergroup.
			 *
			 * Details:
			 * - 'name' is a required field, but can't match an existing name or slug. Needs to be 40 characters or less.
			 * - "description" can accept a limited amount of HTML, and is optional.
			 */
			// Field is required.
			if ( empty( $name ) ) {
				EditFlow()->settings->form_errors['name'] = __( 'Please enter a name for the user group.', 'edit-flow' );
			}
			// Check to ensure a term with the same name doesn't exist.
			$search_term = $this->get_usergroup_by( 'name', $name );
			if ( is_object( $search_term ) && (int) $search_term->term_id !== (int) $existing_usergroup->term_id ) {
				EditFlow()->settings->form_errors['name'] = __( 'Name already in use. Please choose another.', 'edit-flow' );
			}
			// Check to ensure a term with the same slug doesn't exist.
			$search_term = $this->get_usergroup_by( 'slug', sanitize_title( $name ) );
			if ( is_object( $search_term ) && (int) $search_term->term_id !== (int) $existing_usergroup->term_id ) {
				EditFlow()->settings->form_errors['name'] = __( 'Name conflicts with slug for another term. Please choose again.', 'edit-flow' );
			}
			if ( strlen( $name ) > 40 ) {
				EditFlow()->settings->form_errors['name'] = __( 'User group name cannot exceed 40 characters. Please try a shorter name.', 'edit-flow' );
			}
			// Kick out if there are any errors.
			if ( count( EditFlow()->settings->form_errors ) ) {
				$_REQUEST['error'] = 'form-error';
				return;
			}

			// Try to edit the Usergroup.
			$args = array(
				'name'        => $name,
				'description' => $description,
			);
			// Gracefully handle the case where all users have been unsubscribed from the user group.
			// phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- Values are sanitized with intval.
			$users     = isset( $_POST['usergroup_users'] ) ? (array) $_POST['usergroup_users'] : array();
			$users     = array_map( 'intval', $users );
			$usergroup = $this->update_usergroup( $existing_usergroup->term_id, $args, $users );
			if ( is_wp_error( $usergroup ) ) {
				wp_die( esc_html__( 'Error updating user group.', 'edit-flow' ) );
			}

			$args         = array(
				'message' => 'usergroup-updated',
			);
			$redirect_url = $this->get_link( $args );
			// phpcs:ignore WordPress.Security.SafeRedirect.wp_redirect_wp_redirect -- Redirect URL is constructed internally.
			wp_redirect( $redirect_url );
			exit;
		}

		/**
		 * Handles a request to delete a Usergroup.
		 *
		 * Hooked into 'admin_init' and kicks out right away if no action.
		 *
		 * @since 0.7
		 */
		public function handle_delete_usergroup() {
			// phpcs:disable WordPress.Security.NonceVerification.Recommended -- Nonce verified below.
			if ( ! isset( $_GET['page'], $_GET['action'], $_GET['usergroup-id'] )
			|| $_GET['page'] != $this->module->settings_slug || 'delete-usergroup' != $_GET['action'] ) {
				return;
			}
			// phpcs:enable WordPress.Security.NonceVerification.Recommended

			// phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- Nonce value passed directly to wp_verify_nonce().
			if ( ! isset( $_GET['nonce'] ) || ! wp_verify_nonce( $_GET['nonce'], 'delete-usergroup' ) ) {
				wp_die( esc_html( $this->module->messages['nonce-failed'] ) );
			}

			if ( ! current_user_can( $this->manage_usergroups_cap ) ) {
				wp_die( esc_html( $this->module->messages['invalid-permissions'] ) );
			}

			$result = $this->delete_usergroup( (int) $_GET['usergroup-id'] );
			if ( ! $result || is_wp_error( $result ) ) {
				wp_die( esc_html__( 'Error deleting user group.', 'edit-flow' ) );
			}

			$redirect_url = $this->get_link( array( 'message' => 'usergroup-deleted' ) );
			// phpcs:ignore WordPress.Security.SafeRedirect.wp_redirect_wp_redirect -- Redirect URL is constructed internally.
			wp_redirect( $redirect_url );
			exit;
		}

		/**
		 * Handle the request to update a given Usergroup via inline edit.
		 *
		 * @since 0.7
		 */
		public function handle_ajax_inline_save_usergroup() {
			// phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- Nonce value passed directly to wp_verify_nonce().
			if ( ! isset( $_POST['inline_edit'] ) || ! wp_verify_nonce( $_POST['inline_edit'], 'usergroups-inline-edit-nonce' ) ) {
				wp_die( esc_html( $this->module->messages['nonce-failed'] ) );
			}

			if ( ! current_user_can( $this->manage_usergroups_cap ) ) {
				wp_die( esc_html( $this->module->messages['invalid-permissions'] ) );
			}

			$usergroup_id  = isset( $_POST['usergroup_id'] ) ? (int) $_POST['usergroup_id'] : 0;
			$existing_term = $this->get_usergroup_by( 'id', $usergroup_id );
			if ( ! $existing_term ) {
				wp_die( esc_html( $this->module->messages['usergroup-missing'] ) );
			}

			// phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- Values are sanitized below.
			$name = isset( $_POST['name'] ) ? sanitize_text_field( trim( $_POST['name'] ) ) : '';
			// phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized,WordPressVIPMinimum.Functions.StripTagsRegistry.strip_tags -- Values are sanitized.
			$description = isset( $_POST['description'] ) ? stripslashes( wp_filter_nohtml_kses( trim( $_POST['description'] ) ) ) : '';

			// Form validation for editing Usergroup.
			// Check if name field was filled in.
			if ( empty( $name ) ) {
				$change_error = new WP_Error( 'invalid', esc_html__( 'Please enter a name for the user group.', 'edit-flow' ) );
				wp_die( esc_html( $change_error->get_error_message() ) );
			}
			// Check that the name doesn't exceed 40 chars.
			if ( strlen( $name ) > 40 ) {
				$change_error = new WP_Error( 'invalid', esc_html__( 'User group name cannot exceed 40 characters. Please try a shorter name.', 'edit-flow' ) );
				wp_die( esc_html( $change_error->get_error_message() ) );
			}
			// Check to ensure a term with the same name doesn't exist.
			$search_term = $this->get_usergroup_by( 'name', $name );
			if ( is_object( $search_term ) && (int) $search_term->term_id !== (int) $existing_term->term_id ) {
				$change_error = new WP_Error( 'invalid', esc_html__( 'Name already in use. Please choose another.', 'edit-flow' ) );
				wp_die( esc_html( $change_error->get_error_message() ) );
			}
			// Check to ensure a term with the same slug doesn't exist.
			$search_term = $this->get_usergroup_by( 'slug', sanitize_title( $name ) );
			if ( is_object( $search_term ) && (int) $search_term->term_id !== (int) $existing_term->term_id ) {
				$change_error = new WP_Error( 'invalid', esc_html__( 'Name conflicts with slug for another term. Please choose again.', 'edit-flow' ) );
				wp_die( esc_html( $change_error->get_error_message() ) );
			}

			// Prepare the term name and description for saving.
			$args   = array(
				'name'        => $name,
				'description' => $description,
			);
			$return = $this->update_usergroup( $existing_term->term_id, $args );
			if ( ! is_wp_error( $return ) ) {
				set_current_screen( 'edit-usergroup' );
				$wp_list_table = new EF_Usergroups_List_Table();
				$wp_list_table->prepare_items();
				// single_row() echoes its own output; column_* callbacks are
				// responsible for escaping, as per WP_List_Table's contract.
				$wp_list_table->single_row( $return );
				wp_die();
			} else {
				// translators: %s is the name of the user group.
				$change_error = new WP_Error( 'invalid', sprintf( __( 'Could not update the user group: <strong>%s</strong>', 'edit-flow' ), esc_html( $name ) ) );
				wp_die( wp_kses( $change_error->get_error_message(), array( 'strong' => array() ) ) );
			}
		}

		/**
		 * Register settings for notifications so we can partially use the Settings API.
		 *
		 * We use the Settings API for form generation, but not saving.
		 *
		 * @since 0.7
		 * @uses add_settings_section(), add_settings_field()
		 */
		public function register_settings() {
			add_settings_section( $this->module->options_group_name . '_general', false, '__return_false', $this->module->options_group_name );
			add_settings_field( 'post_types', __( 'Add to these post types:', 'edit-flow' ), array( $this, 'settings_post_types_option' ), $this->module->options_group_name, $this->module->options_group_name . '_general' );
		}

		/**
		 * Choose the post types for Usergroups.
		 *
		 * @since 0.7
		 */
		public function settings_post_types_option() {
			global $edit_flow;
			$edit_flow->settings->helper_option_custom_post_type( $this->module );
		}

		/**
		 * Validate data entered by the user.
		 *
		 * @since 0.7
		 *
		 * @param array $new_options New values that have been entered by the user.
		 * @return array Form values after they've been sanitized.
		 */
		public function settings_validate( $new_options ) {


			// Whitelist validation for the post type options.
			if ( ! isset( $new_options['post_types'] ) ) {
				$new_options['post_types'] = array();
			}
			$new_options['post_types'] = $this->clean_post_type_options( $new_options['post_types'], $this->module->post_type_support );

			return $new_options;
		}

		/**
		 * Build a configuration view so we can manage our usergroups.
		 *
		 * @since 0.7
		 */
		public function print_configure_view() {
			global $edit_flow;

			// phpcs:disable WordPress.Security.NonceVerification.Missing,WordPress.Security.NonceVerification.Recommended -- Nonce verification happens in handler functions, this is just rendering.
			if ( isset( $_GET['action'], $_GET['usergroup-id'] ) && 'edit-usergroup' == $_GET['action'] ) :
				// Full page width view for editing a given usergroup.
				// Check whether the usergroup exists.
				$usergroup_id = (int) $_GET['usergroup-id'];
				$usergroup    = $this->get_usergroup_by( 'id', $usergroup_id );
				if ( ! $usergroup ) {
					echo '<div class="error"><p>' . esc_html( $this->module->messages['usergroup-missing'] ) . '</p></div>';
					return;
				}
				// phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- Value is sanitized via stripslashes.
				$name = ( isset( $_POST['name'] ) ) ? stripslashes( $_POST['name'] ) : $usergroup->name;
				// phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- Values are sanitized with wp_strip_all_tags.
				$description = ( isset( $_POST['description'] ) ) ? wp_strip_all_tags( stripslashes( $_POST['description'] ) ) : $usergroup->description;
				?>
		<form method="post" action="
				<?php
				echo esc_url( $this->get_link( array(
					'action'       => 'edit-usergroup',
					'usergroup-id' => $usergroup_id,
				) ) );
				?>
									">
		<div id="col-right"><div class="col-wrap"><div id="ef-usergroup-users" class="form-wrap">
			<h4><?php _e( 'Users', 'edit-flow' ); ?></h4>
				<?php
				$select_form_args = array(
					'list_class' => 'ef-post_following_list',
					'input_id'   => 'usergroup_users',
				);
				?>
				<?php $this->users_select_form( $usergroup->user_ids, $select_form_args ); ?>
		</div></div></div>
		<div id="col-left"><div class="col-wrap"><div class="form-wrap">
			<input type="hidden" name="form-action" value="edit-usergroup" />
			<input type="hidden" name="usergroup_id" value="<?php echo esc_attr( $usergroup_id ); ?>" />
				<?php
				wp_original_referer_field();
				wp_nonce_field( 'edit-usergroup' );
				?>
			<div class="form-field form-required">
				<label for="name"><?php _e( 'Name', 'edit-flow' ); ?></label>
				<input name="name" id="name" type="text" value="<?php echo esc_attr( $name ); ?>" size="40" maxlength="40" aria-required="true" />
				<?php $edit_flow->settings->helper_print_error_or_description( 'name', __( 'The name is used to identify the user group.', 'edit-flow' ) ); ?>
			</div>
			<div class="form-field">
				<label for="description"><?php _e( 'Description', 'edit-flow' ); ?></label>
				<textarea name="description" id="description" rows="5" cols="40"><?php echo esc_html( $description ); ?></textarea>
				<?php $edit_flow->settings->helper_print_error_or_description( 'description', __( 'The description is primarily for administrative use, to give you some context on what the user group is to be used for.', 'edit-flow' ) ); ?>
			</div>
			<p class="submit">
				<?php submit_button( __( 'Update User Group', 'edit-flow' ), 'primary', 'submit', false ); ?>
			<a class="cancel-settings-link" href="<?php echo esc_url( $this->get_link() ); ?>"><?php _e( 'Cancel', 'edit-flow' ); ?></a>
			</p>
		</div></div></div>
		</form>

				<?php
		else :
				// Full page width view to allow adding a usergroup and edit the existing ones.
				$wp_list_table = new EF_Usergroups_List_Table();
				$wp_list_table->prepare_items();
			?>
			<script type="text/javascript">
				var ef_confirm_delete_usergroup_string = "<?php _e( 'Are you sure you want to delete the user group?', 'edit-flow' ); ?>";
			</script>
			<div id="col-right"><div class="col-wrap">
				<?php $wp_list_table->display(); ?>
			</div></div>
			<div id="col-left"><div class="col-wrap"><div class="form-wrap">
				<h3 class="nav-tab-wrapper">
					<?php $add_new_nav_class = ! isset( $_GET['action'] ) || 'change-options' != $_GET['action'] ? 'nav-tab-active' : ''; ?>
					<a href="<?php echo esc_url( $this->get_link() ); ?>" class="nav-tab <?php echo esc_attr( $add_new_nav_class ); ?>"><?php esc_html_e( 'Add New', 'edit-flow' ); ?></a>
					<?php $options_nav_class = isset( $_GET['action'] ) && 'change-options' == $_GET['action'] ? 'nav-tab-active' : ''; ?>
					<a href="<?php echo esc_url( $this->get_link( array( 'action' => 'change-options' ) ) ); ?>" class="nav-tab <?php echo esc_attr( $options_nav_class ); ?>"><?php esc_html_e( 'Options', 'edit-flow' ); ?></a>
				</h3>
				<?php if ( isset( $_GET['action'] ) && 'change-options' == $_GET['action'] ) : ?>
				<form class="basic-settings" action="<?php echo esc_url( $this->get_link( array( 'action' => 'change-options' ) ) ); ?>" method="post">
					<?php settings_fields( $this->module->options_group_name ); ?>
					<?php do_settings_sections( $this->module->options_group_name ); ?>
					<input id="edit_flow_module_name" name="edit_flow_module_name" type="hidden" value="<?php echo esc_attr( $this->module->name ); ?>" />
					<?php submit_button(); ?>
				</form>
				<?php else : ?>
					<?php // Custom form for adding a new Usergroup. ?>
					<form class="add:the-list:" action="<?php echo esc_url( $this->get_link() ); ?>" method="post" id="addusergroup" name="addusergroup">
					<div class="form-field form-required">
						<label for="name"><?php _e( 'Name', 'edit-flow' ); ?></label>
						<?php // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- Value is escaped with esc_attr. ?>
						<input type="text" aria-required="true" id="name" name="name" maxlength="40" value="<?php echo ( empty( $_POST['name'] ) ? '' : esc_attr( wp_unslash( $_POST['name'] ) ) ); ?>"/>
						<?php $edit_flow->settings->helper_print_error_or_description( 'name', __( 'The name is used to identify the user group.', 'edit-flow' ) ); ?>
					</div>
					<div class="form-field">
						<label for="description"><?php _e( 'Description', 'edit-flow' ); ?></label>
						<textarea cols="40" rows="5" id="description" name="description"><?php echo ( empty( $_POST['description'] ) ? '' : esc_textarea( sanitize_textarea_field( wp_unslash( $_POST['description'] ) ) ) ); ?></textarea>
						<?php $edit_flow->settings->helper_print_error_or_description( 'description', __( 'The description is primarily for administrative use, to give you some context on what the user group is to be used for.', 'edit-flow' ) ); ?>
					</div>
					<?php wp_nonce_field( 'add-usergroup' ); ?>
					<input id="form-action" name="form-action" type="hidden" value="add-usergroup" />
					<?php submit_button( __( 'Add New User Group', 'edit-flow' ) ); ?>
					</form>
				<?php endif; ?>
			</div></div></div>
				<?php $wp_list_table->inline_edit(); ?>
			<?php
		endif;
			// phpcs:enable WordPress.Security.NonceVerification.Missing,WordPress.Security.NonceVerification.Recommended
		}

		/**
		 * Adds a form to the user profile page to allow adding usergroup selecting options.
		 */
		public function user_profile_page() {
			global $user_id, $profileuser;

			if ( ! $user_id || ! current_user_can( $this->manage_usergroups_cap ) ) {
				return;
			}

			// Don't allow display of user groups from network.
			if ( ( ! is_null( get_current_screen() ) ) && ( get_current_screen()->is_network ) ) {
				return;
			}

			// Assemble all necessary data.
			$usergroups           = $this->get_usergroups();
			$selected_usergroups  = $this->get_usergroups_for_user( $user_id );
			$usergroups_form_args = array( 'input_id' => 'ef_usergroups' );
			?>
		<table id="ef-user-usergroups" class="form-table"><tbody><tr>
			<th>
				<h3><?php _e( 'Usergroups', 'edit-flow' ); ?></h3>
				<?php if ( wp_get_current_user()->ID === $user_id ) : ?>
				<p><?php _e( 'Select the user groups that you would like to be a part of:', 'edit-flow' ); ?></p>
				<?php else : ?>
				<p><?php _e( 'Select the user groups that this user should be a part of:', 'edit-flow' ); ?></p>
				<?php endif; ?>
			</th>
			<td>
				<?php $this->usergroups_select_form( $selected_usergroups, $usergroups_form_args ); ?>
				<script type="text/javascript">
				jQuery(document).ready(function(){
					jQuery('#ef-user-usergroups ul').listFilterizer();
				});
				</script>
			</td>
		</tr></tbody></table>
			<?php wp_nonce_field( 'ef_edit_profile_usergroups_nonce', 'ef_edit_profile_usergroups_nonce' ); ?>
			<?php
		}

		/**
		 * Function called when a user's profile is updated.
		 *
		 * Adds user to specified usergroups.
		 *
		 * @since 0.7
		 *
		 * @param WP_Error $errors Error object for validation errors.
		 * @param bool     $update Whether this is a user update.
		 * @param WP_User  $user   The user object being updated.
		 * @return array The errors, update flag, and user.
		 */
		public function user_profile_update( $errors, $update, $user ) {

			if ( ! $update ) {
				return array( &$errors, $update, &$user );
			}

			// `get_current_screen()` is defined on most admin pages, but not all.
			if ( function_exists( 'get_current_screen' ) ) {
				// Don't allow update of user groups from network.
				$screen = get_current_screen();
				if ( ! is_null( $screen ) && $screen->is_network ) {
					return;
				}
			}

			// phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- Nonce value passed directly to wp_verify_nonce().
			if ( isset( $_POST['ef_edit_profile_usergroups_nonce'] ) && current_user_can( $this->manage_usergroups_cap ) && wp_verify_nonce( $_POST['ef_edit_profile_usergroups_nonce'], 'ef_edit_profile_usergroups_nonce' ) ) {
				// Sanitize the data and save.
				// Gracefully handle the case where the user was unsubscribed from all usergroups.
				$usergroups     = isset( $_POST['ef_usergroups'] ) ? array_map( 'intval', (array) $_POST['ef_usergroups'] ) : array();
				$all_usergroups = $this->get_usergroups();
				foreach ( $all_usergroups as $usergroup ) {
					if ( in_array( (int) $usergroup->term_id, $usergroups, true ) ) {
						$this->add_user_to_usergroup( $user->ID, $usergroup->term_id );
					} else {
						$this->remove_user_from_usergroup( $user->ID, $usergroup->term_id );
					}
				}
			}

			return array( &$errors, $update, &$user );
		}

		/**
		 * Generate a link to one of the usergroups actions.
		 *
		 * @since 0.7
		 *
		 * @param array $args Any query args to add to the URL.
		 * @return string Direct link to usergroup action.
		 */
		public function get_link( $args = array() ) {
			if ( ! isset( $args['action'] ) ) {
				$args['action'] = '';
			}
			if ( ! isset( $args['page'] ) ) {
				$args['page'] = $this->module->settings_slug;
			}
			// Add other things we may need depending on the action.
			switch ( $args['action'] ) {
				case 'delete-usergroup':
					$args['nonce'] = wp_create_nonce( $args['action'] );
					break;
				default:
					break;
			}
			return add_query_arg( $args, get_admin_url( null, 'admin.php' ) );
		}

		/**
		 * Displays a list of usergroups with checkboxes.
		 *
		 * @since 0.7
		 *
		 * @param array $selected List of usergroup keys that should be checked.
		 * @param array $args     Optional arguments for the form.
		 */
		public function usergroups_select_form( $selected = array(), $args = null ) {

			// @todo Add $args for additional options, e.g. showing members assigned to group,
			// before/after tags, class names, id names, etc.
			$defaults = array(
				'list_class' => 'ef-post_following_list',
				'list_id'    => 'ef-following_usergroups',
				'input_id'   => 'following_usergroups',
			);

			$parsed_args = wp_parse_args( $args, $defaults );
			$list_class  = $parsed_args['list_class'];
			$list_id     = $parsed_args['list_id'];
			$input_id    = $parsed_args['input_id'];
			$usergroups  = $this->get_usergroups();
			if ( empty( $usergroups ) ) {
				?>
			<p><?php esc_html_e( 'No user groups were found.', 'edit-flow' ); ?> <a href="<?php echo esc_url( $this->get_link() ); ?>" title="<?php esc_attr_e( 'Add a new user group. Opens new window.', 'edit-flow' ); ?>" target="_blank"><?php esc_html_e( 'Add a User Group', 'edit-flow' ); ?></a></p>
				<?php
			} else {

				?>
			<ul id="<?php echo esc_attr( $list_id ); ?>" class="<?php echo esc_attr( $list_class ); ?>">
				<?php
				foreach ( $usergroups as $usergroup ) {
					?>
				<li>
					<label for="<?php echo esc_attr( $input_id ) . esc_attr( $usergroup->term_id ); ?>" title="<?php echo esc_attr( $usergroup->description ); ?>">
						<div class="ef-user-subscribe-actions">
							<input type="checkbox" id="<?php echo esc_attr( $input_id . $usergroup->term_id ); ?>" name="<?php echo esc_attr( $input_id ); ?>[]" value="<?php echo esc_attr( $usergroup->term_id ); ?>"<?php echo checked( in_array( (int) $usergroup->term_id, array_map( 'intval', (array) $selected ), true ) ); ?> />
						</div>
						<span class="ef-usergroup_name"><?php echo esc_html( $usergroup->name ); ?></span>
						<span class="ef-usergroup_description" title="<?php echo esc_attr( $usergroup->description ); ?>">
							<?php echo esc_html( wp_html_excerpt( $usergroup->description, 50, '...' ) ); ?>
						</span>
					</label>
				</li>
					<?php
				}
				?>
			</ul>
				<?php
			}
		}

		/**
		 * Core Usergroups Module Functionality
		 */

		/**
		 * Get all of the registered usergroups. Returns an array of objects.
		 *
		 * @since 0.7
		 *
		 * @param array $args Arguments to filter/sort by.
		 * @return array|bool $usergroups Array of Usergroups with relevant data, false if none.
		 */
		public function get_usergroups( $args = array() ) {

			// We want empty terms by default.
			$usergroup_terms = get_terms( array(
				'taxonomy'   => self::taxonomy_key,
				'hide_empty' => isset( $args['hide_empty'] ),
			));
			if ( ! $usergroup_terms ) {
				return false;
			}

			// Run the usergroups through get_usergroup_by() so we load users too.
			$usergroups = array();
			foreach ( $usergroup_terms as $usergroup_term ) {
				$usergroups[] = $this->get_usergroup_by( 'id', $usergroup_term->term_id );
			}
			return $usergroups;
		}

		/**
		 * Get all of the data associated with a single usergroup.
		 *
		 * Usergroup contains:
		 * - ID (key = term_id)
		 * - Slug (prefixed with our special key to avoid conflicts)
		 * - Name
		 * - Description
		 * - User IDs (array of IDs)
		 *
		 * @since 0.7
		 *
		 * @param string     $field 'id', 'name', or 'slug'.
		 * @param int|string $value Value for the search field.
		 * @return object|array|WP_Error $usergroup Usergroup information as specified by $output.
		 */
		public function get_usergroup_by( $field, $value ) {

			$usergroup = get_term_by( $field, $value, self::taxonomy_key );

			if ( ! $usergroup || is_wp_error( $usergroup ) ) {
				return $usergroup;
			}

			// We store extra values in an encoded description field.
			// Initialize the users array in case it's empty in the stored data.
			$usergroup->user_ids   = array();
			$unencoded_description = $this->get_unencoded_description( $usergroup->description );
			if ( is_array( $unencoded_description ) ) {
				foreach ( $unencoded_description as $key => $value ) {
					$usergroup->$key = $value;
				}
			}

			$usergroup = apply_filters( 'ef_usergroup_object', $usergroup );

			return $usergroup;
		}

		/**
		 * Create a new usergroup.
		 *
		 * Usergroup contains:
		 * - Name
		 * - Slug (prefixed with our special key to avoid conflicts)
		 * - Description
		 * - Users
		 *
		 * @since 0.7
		 *
		 * @param array $args     Name (optional), slug and description for the usergroup.
		 * @param array $user_ids IDs for the users to be added to the Usergroup.
		 * @return object|WP_Error $usergroup Object for the new Usergroup on success, WP_Error otherwise.
		 */
		public function add_usergroup( $args = array(), $user_ids = array() ) {

			if ( ! isset( $args['name'] ) ) {
				return new WP_Error( 'invalid', __( 'New user groups must have a name', 'edit-flow' ) );
			}

			$name    = $args['name'];
			$default = array(
				'name'        => '',
				'slug'        => self::term_prefix . sanitize_title( $name ),
				'description' => '',
			);
			$args    = array_merge( $default, $args );

			// Encode our extra fields and then store them in the description field.
			$args_to_encode      = array(
				'description' => $args['description'],
				'user_ids'    => array_unique( $user_ids ),
			);
			$encoded_description = $this->get_encoded_description( $args_to_encode );
			$args['description'] = $encoded_description;
			$usergroup           = wp_insert_term( $name, self::taxonomy_key, $args );
			if ( is_wp_error( $usergroup ) ) {
				return $usergroup;
			}

			return $this->get_usergroup_by( 'id', $usergroup['term_id'] );
		}

		/**
		 * Update a usergroup with new data.
		 *
		 * Fields can include:
		 * - Name
		 * - Slug (prefixed with our special key, of course)
		 * - Description
		 * - Users
		 *
		 * @since 0.7
		 *
		 * @param int   $id    Unique ID for the usergroup.
		 * @param array $args  Usergroup meta to update (name, slug, description).
		 * @param array $users Users to be added to the Usergroup. If set, removes existing users first.
		 * @return object|WP_Error $usergroup Object for the updated Usergroup on success, WP_Error otherwise.
		 */
		public function update_usergroup( $id, $args = array(), $users = null ) {

			$existing_usergroup = $this->get_usergroup_by( 'id', $id );
			if ( is_wp_error( $existing_usergroup ) ) {
				return new WP_Error( 'invalid', __( "User group doesn't exist.", 'edit-flow' ) );
			}

			// Encode our extra fields and then store them in the description field.
			$args_to_encode                = array();
			$args_to_encode['description'] = ( isset( $args['description'] ) ) ? $args['description'] : $existing_usergroup->description;
			$args_to_encode['user_ids']    = ( is_array( $users ) ) ? $users : $existing_usergroup->user_ids;
			$args_to_encode['user_ids']    = array_unique( $args_to_encode['user_ids'] );
			$encoded_description           = $this->get_encoded_description( $args_to_encode );
			$args['description']           = $encoded_description;

			$usergroup = wp_update_term( $id, self::taxonomy_key, $args );
			if ( is_wp_error( $usergroup ) ) {
				return $usergroup;
			}

			return $this->get_usergroup_by( 'id', $usergroup['term_id'] );
		}

		/**
		 * Delete a usergroup based on its term ID.
		 *
		 * @since 0.7
		 *
		 * @param int $id Unique ID for the Usergroup.
		 * @return bool|WP_Error Returns true on success, WP_Error on failure.
		 */
		public function delete_usergroup( $id ) {
			$retval = wp_delete_term( $id, self::taxonomy_key );
			return $retval;
		}

		/**
		 * Add an array of user logins or IDs to a given usergroup.
		 *
		 * @since 0.7
		 *
		 * @param array $user_ids_or_logins User IDs or logins to be added to the usergroup.
		 * @param int   $id                 Usergroup to perform the action on.
		 * @param bool  $reset              Delete all of the relationships before adding.
		 * @return bool|WP_Error Whether or not we were successful.
		 */
		public function add_users_to_usergroup( $user_ids_or_logins, $id, $reset = true ) {

			if ( ! is_array( $user_ids_or_logins ) ) {
				return new WP_Error( 'invalid', __( 'Invalid users variable. Should be array.', 'edit-flow' ) );
			}

			// To dump the existing users from a usergroup, we need to pass an empty array.
			$usergroup = $this->get_usergroup_by( 'id', $id );
			if ( $reset ) {
				$retval = $this->update_usergroup( $id, null, array() );
				if ( is_wp_error( $retval ) ) {
					return $retval;
				}
			}

			// Add the new users one by one to an array we'll pass back to the usergroup.
			$new_users = array();
			foreach ( (array) $user_ids_or_logins as $user_id_or_login ) {
				if ( ! is_numeric( $user_id_or_login ) ) {
					$new_users[] = get_user_by( 'login', $user_id_or_login )->ID;
				} else {
					$new_users[] = (int) $user_id_or_login;
				}
			}
			$retval = $this->update_usergroup( $id, null, $new_users );
			if ( is_wp_error( $retval ) ) {
				return $retval;
			}
			return true;
		}

		/**
		 * Add a given user to a Usergroup. Can use User ID or user login.
		 *
		 * @since 0.7
		 *
		 * @param int|string $user_id_or_login User ID or login to be added to the Usergroups.
		 * @param int|array  $ids              ID for the Usergroup(s).
		 * @return bool|WP_Error Return true on success, WP_Error on error.
		 */
		public function add_user_to_usergroup( $user_id_or_login, $ids ) {

			if ( ! is_numeric( $user_id_or_login ) ) {
				$user_id = get_user_by( 'login', $user_id_or_login )->ID;
			} else {
				$user_id = (int) $user_id_or_login;
			}

			foreach ( (array) $ids as $usergroup_id ) {
				$usergroup = $this->get_usergroup_by( 'id', $usergroup_id );

				// Skip if user is already in this group.
				if ( in_array( (int) $user_id, array_map( 'intval', (array) $usergroup->user_ids ), true ) ) {
					continue;
				}

				$usergroup->user_ids[] = $user_id;
				$retval                = $this->update_usergroup( $usergroup_id, null, $usergroup->user_ids );
				if ( is_wp_error( $retval ) ) {
					return $retval;
				}
			}
			return true;
		}

		/**
		 * Remove a given user from one or more usergroups.
		 *
		 * @since 0.7
		 *
		 * @param int|string $user_id_or_login User ID or login to be removed from the Usergroups.
		 * @param int|array  $ids              ID for the Usergroup(s).
		 * @return bool|WP_Error Return true on success, WP_Error on error.
		 */
		public function remove_user_from_usergroup( $user_id_or_login, $ids ) {

			if ( ! is_numeric( $user_id_or_login ) ) {
				$user_id = get_user_by( 'login', $user_id_or_login )->ID;
			} else {
				$user_id = (int) $user_id_or_login;
			}

			// Remove the user from each usergroup specified.
			foreach ( (array) $ids as $usergroup_id ) {
				$usergroup = $this->get_usergroup_by( 'id', $usergroup_id );
				// @todo I bet there's a PHP function for this I couldn't look up at 35,000 over the Atlantic.
				foreach ( $usergroup->user_ids as $key => $usergroup_user_id ) {
					if ( (int) $usergroup_user_id === (int) $user_id ) {
						unset( $usergroup->user_ids[ $key ] );
					}
				}
				$retval = $this->update_usergroup( $usergroup_id, null, $usergroup->user_ids );
				if ( is_wp_error( $retval ) ) {
					return $retval;
				}
			}
			return true;
		}

		/**
		 * Get all of the Usergroup ids or objects for a given user.
		 *
		 * @since 0.7
		 *
		 * @param int|string $user_id_or_login User ID or login to search against.
		 * @param string     $ids_or_objects   Whether to retrieve an array of IDs or usergroup objects.
		 * @return array|bool Array of usergroup 'ids' or 'objects', false if none.
		 */
		public function get_usergroups_for_user( $user_id_or_login, $ids_or_objects = 'ids' ) {

			if ( ! is_numeric( $user_id_or_login ) ) {
				$user_id = get_user_by( 'login', $user_id_or_login )->ID;
			} else {
				$user_id = (int) $user_id_or_login;
			}

			// Unfortunately, the easiest way to do this is get all usergroups
			// and then loop through each one to see if the user ID is stored.
			$all_usergroups = $this->get_usergroups();
			if ( ! empty( $all_usergroups ) ) {
				$usergroup_objects_or_ids = array();
				foreach ( $all_usergroups as $usergroup ) {
					// Not in this usergroup, so keep going.
					if ( ! in_array( (int) $user_id, array_map( 'intval', (array) $usergroup->user_ids ), true ) ) {
						continue;
					}
					if ( 'ids' == $ids_or_objects ) {
						$usergroup_objects_or_ids[] = (int) $usergroup->term_id;
					} elseif ( 'objects' == $ids_or_objects ) {
						$usergroup_objects_or_ids[] = $usergroup;
					}
				}
				return $usergroup_objects_or_ids;
			} else {
				return false;
			}
		}
	}

}

// phpcs:disable Generic.Files.OneObjectStructurePerFile.MultipleFound

if ( ! class_exists( 'EF_Usergroups_List_Table' ) ) {
	/**
	 * Usergroups uses WordPress' List Table API for generating the Usergroup management table.
	 *
	 * @since 0.7
	 */
	class EF_Usergroups_List_Table extends WP_List_Table {

		/**
		 * Callback arguments.
		 *
		 * @var array
		 */
		protected $callback_args;

		/**
		 * Constructor.
		 */
		public function __construct() {

			parent::__construct( array(
				'plural'   => 'user groups',
				'singular' => 'user group',
				'ajax'     => true,
			) );
		}

		/**
		 * Prepare items for display.
		 *
		 * @todo Paginate if we have a lot of usergroups.
		 *
		 * @since 0.7
		 */
		public function prepare_items() {
			global $edit_flow;

			$columns  = $this->get_columns();
			$hidden   = array();
			$sortable = array();

			$this->_column_headers = array( $columns, $hidden, $sortable );

			$this->items = $edit_flow->user_groups->get_usergroups();

			if ( ! is_array( $this->items ) ) {
				$this->items = array();
			}

			$this->set_pagination_args( array(
				'total_items' => count( $this->items ),
				'per_page'    => count( $this->items ),
			) );
		}

		/**
		 * Message to be displayed when there are no usergroups.
		 *
		 * @since 0.7
		 */
		public function no_items() {
			esc_html_e( 'No user groups found.', 'edit-flow' );
		}

		/**
		 * Columns in our Usergroups table.
		 *
		 * @since 0.7
		 *
		 * @return array The columns.
		 */
		public function get_columns() {

			$columns = array(
				'name'        => __( 'Name', 'edit-flow' ),
				'description' => __( 'Description', 'edit-flow' ),
				'users'       => __( 'Users in Group', 'edit-flow' ),
			);

			return $columns;
		}

		/**
		 * Process the Usergroup column value for all methods that aren't registered.
		 *
		 * @since 0.7
		 *
		 * @param object $usergroup   The usergroup object.
		 * @param string $column_name The column name.
		 */
		public function column_default( $usergroup, $column_name ) {
		}

		/**
		 * Process the Usergroup name column value.
		 *
		 * Displays the name of the Usergroup, and action links.
		 *
		 * @since 0.7
		 *
		 * @param object $usergroup The usergroup object.
		 * @return string The column output.
		 */
		public function column_name( $usergroup ) {
			global $edit_flow;

			// @todo direct edit link.
			$output = '<strong><a href="' . esc_url( $edit_flow->user_groups->get_link( array(
				'action'       => 'edit-usergroup',
				'usergroup-id' => $usergroup->term_id,
			) ) ) . '">' . esc_html( $usergroup->name ) . '</a></strong>';

			$actions                            = array();
			$actions['edit edit-usergroup']     = sprintf( '<a href="%1$s">' . __( 'Edit', 'edit-flow' ) . '</a>', esc_url( $edit_flow->user_groups->get_link( array(
				'action'       => 'edit-usergroup',
				'usergroup-id' => $usergroup->term_id,
			) ) ) );
			$actions['inline hide-if-no-js']    = '<a href="#" class="editinline">' . __( 'Quick&nbsp;Edit', 'edit-flow' ) . '</a>';
			$actions['delete delete-usergroup'] = sprintf( '<a href="%1$s">' . __( 'Delete', 'edit-flow' ) . '</a>', esc_url( $edit_flow->user_groups->get_link( array(
				'action'       => 'delete-usergroup',
				'usergroup-id' => $usergroup->term_id,
			) ) ) );

			$output .= $this->row_actions( $actions, false );
			$output .= '<div class="hidden" id="inline_' . $usergroup->term_id . '">';
			$output .= '<div class="name">' . esc_html( $usergroup->name ) . '</div>';
			$output .= '<div class="description">' . esc_html( $usergroup->description ) . '</div>';
			$output .= '</div>';

			return $output;
		}

		/**
		 * Handle the 'description' column for the table of Usergroups.
		 *
		 * Don't need to unencode this because we already did when the usergroup was loaded.
		 *
		 * @since 0.7
		 *
		 * @param object $usergroup The usergroup object.
		 * @return string The column output.
		 */
		public function column_description( $usergroup ) {
			return esc_html( $usergroup->description );
		}

		/**
		 * Show the "Total Users" in a given usergroup.
		 *
		 * @since 0.7
		 *
		 * @param object $usergroup The usergroup object.
		 * @return string The column output.
		 */
		public function column_users( $usergroup ) {
			global $edit_flow;
			return '<a href="' . esc_url( $edit_flow->user_groups->get_link( array(
				'action'       => 'edit-usergroup',
				'usergroup-id' => $usergroup->term_id,
			) ) ) . '">' . count( $usergroup->user_ids ) . '</a>';
		}

		/**
		 * Prepare a single row of information about a usergroup.
		 *
		 * @since 0.7
		 *
		 * @param object $usergroup The usergroup object.
		 */
		public function single_row( $usergroup ) {
			static $is_alternate = false;
			$is_alternate        = ! $is_alternate;

			printf(
				'<tr id="usergroup-%d"%s>',
				(int) $usergroup->term_id,
				$is_alternate ? ' class="alternate"' : ''
			);
			// single_row_columns() echoes its own output; the column_* callbacks are
			// responsible for escaping, as per WP_List_Table's contract.
			$this->single_row_columns( $usergroup );
			echo '</tr>';
		}

		/**
		 * If we use this form, we can have inline editing!
		 *
		 * @since 0.7
		 */
		public function inline_edit() {
			global $edit_flow;
			?>
	<form method="get" action=""><table style="display: none"><tbody id="inlineedit">
		<tr id="inline-edit" class="inline-edit-row" style="display: none"><td colspan="<?php echo esc_attr( $this->get_column_count() ); ?>" class="colspanchange">
			<fieldset><div class="inline-edit-col">
				<h4><?php esc_html_e( 'Quick Edit', 'edit-flow' ); ?></h4>
				<label>
					<span class="title"><?php _e( 'Name', 'edit-flow' ); ?></span>
					<span class="input-text-wrap"><input type="text" name="name" class="ptitle" value="" maxlength="40" /></span>
				</label>
				<label>
					<span class="title"><?php _e( 'Description', 'edit-flow' ); ?></span>
					<span class="input-text-wrap"><input type="text" name="description" class="pdescription" value="" /></span>
				</label>
			</div></fieldset>
		<p class="inline-edit-save submit">
			<a accesskey="c" href="#inline-edit" title="<?php esc_attr_e( 'Cancel', 'edit-flow' ); ?>" class="cancel button-secondary alignleft"><?php esc_html_e( 'Cancel', 'edit-flow' ); ?></a>
			<?php $update_text = __( 'Update User Group', 'edit-flow' ); ?>
			<a accesskey="s" href="#inline-edit" title="<?php echo esc_attr( $update_text ); ?>" class="save button-primary alignright"><?php echo esc_html( $update_text ); ?></a>
			<img class="waiting" style="display:none;" src="<?php echo esc_url( admin_url( 'images/wpspin_light.gif' ) ); ?>" alt="" />
			<span class="error" style="display:none;"></span>
			<?php wp_nonce_field( 'usergroups-inline-edit-nonce', 'inline_edit', false ); ?>
			<br class="clear" />
		</p>
		</td></tr>
		</tbody></table></form>
			<?php
		}
	}
}

```