Elgg / Elgg

engine/lib/users.php

Indentation +503 added lines, -503 removed lines

@@ -16,7 +16,7 @@ 
  * @access private
  */
 function get_user_entity_as_row($guid) {
-	return _elgg_services()->usersTable->getRow($guid);
+    return _elgg_services()->usersTable->getRow($guid);
 }
 
 /**
@@ -27,7 +27,7 @@ 
  * @return bool Depending on success
  */
 function disable_user_entities($owner_guid) {
-	return _elgg_services()->usersTable->disableEntities($owner_guid);
+    return _elgg_services()->usersTable->disableEntities($owner_guid);
 }
 
 /**
@@ -39,7 +39,7 @@ 
  * @return bool
  */
 function ban_user($user_guid, $reason = "") {
-	return _elgg_services()->usersTable->ban($user_guid, $reason);
+    return _elgg_services()->usersTable->ban($user_guid, $reason);
 }
 
 /**
@@ -50,7 +50,7 @@ 
  * @return bool
  */
 function unban_user($user_guid) {
-	return _elgg_services()->usersTable->unban($user_guid);
+    return _elgg_services()->usersTable->unban($user_guid);
 }
 
 /**
@@ -61,7 +61,7 @@ 
  * @return bool
  */
 function make_user_admin($user_guid) {
-	return _elgg_services()->usersTable->makeAdmin($user_guid);
+    return _elgg_services()->usersTable->makeAdmin($user_guid);
 }
 
 /**
@@ -72,7 +72,7 @@ 
  * @return bool
  */
 function remove_user_admin($user_guid) {
-	return _elgg_services()->usersTable->removeAdmin($user_guid);
+    return _elgg_services()->usersTable->removeAdmin($user_guid);
 }
 
 /**
@@ -85,7 +85,7 @@ 
  * @return \ElggUser|false
  */
 function get_user($guid) {
-	return _elgg_services()->entityTable->get($guid, 'user');
+    return _elgg_services()->entityTable->get($guid, 'user');
 }
 
 /**
@@ -96,7 +96,7 @@ 
  * @return \ElggUser|false Depending on success
  */
 function get_user_by_username($username) {
-	return _elgg_services()->usersTable->getByUsername($username);
+    return _elgg_services()->usersTable->getByUsername($username);
 }
 
 /**
@@ -107,7 +107,7 @@ 
  * @return \ElggUser
  */
 function get_user_by_code($hash) {
-	return _elgg_services()->persistentLogin->getUserFromHash($hash);
+    return _elgg_services()->persistentLogin->getUserFromHash($hash);
 }
 
 /**
@@ -118,7 +118,7 @@ 
  * @return array
  */
 function get_user_by_email($email) {
-	return _elgg_services()->usersTable->getByEmail($email);
+    return _elgg_services()->usersTable->getByEmail($email);
 }
 
 /**
@@ -134,7 +134,7 @@ 
  * @return \ElggUser[]|int
  */
 function find_active_users(array $options = []) {
-	return _elgg_services()->usersTable->findActive($options);
+    return _elgg_services()->usersTable->findActive($options);
 }
 
 /**
@@ -145,7 +145,7 @@ 
  * @return bool
  */
 function send_new_password_request($user_guid) {
-	return _elgg_services()->passwords->sendNewPasswordRequest($user_guid);
+    return _elgg_services()->passwords->sendNewPasswordRequest($user_guid);
 }
 
 /**
@@ -159,7 +159,7 @@ 
  * @return bool
  */
 function force_user_password_reset($user_guid, $password) {
-	return _elgg_services()->passwords->forcePasswordReset($user_guid, $password);
+    return _elgg_services()->passwords->forcePasswordReset($user_guid, $password);
 }
 
 /**
@@ -172,7 +172,7 @@ 
  * @return bool True on success
  */
 function execute_new_password_request($user_guid, $conf_code, $password = null) {
-	return _elgg_services()->passwords->executeNewPasswordReset($user_guid, $conf_code, $password);
+    return _elgg_services()->passwords->executeNewPasswordReset($user_guid, $conf_code, $password);
 }
 
 /**
@@ -181,7 +181,7 @@ 
  * @return string
  */
 function generate_random_cleartext_password() {
-	return _elgg_services()->crypto->getRandomString(12, \ElggCrypto::CHARS_PASSWORD);
+    return _elgg_services()->crypto->getRandomString(12, \ElggCrypto::CHARS_PASSWORD);
 }
 
 
@@ -197,57 +197,57 @@ 
  * @throws RegistrationException on invalid
  */
 function validate_username($username) {
-	global $CONFIG;
-
-	// Basic, check length
-	if (!isset($CONFIG->minusername)) {
-		$CONFIG->minusername = 4;
-	}
-
-	if (strlen($username) < $CONFIG->minusername) {
-		$msg = elgg_echo('registration:usernametooshort', [$CONFIG->minusername]);
-		throw new \RegistrationException($msg);
-	}
-
-	// username in the database has a limit of 128 characters
-	if (strlen($username) > 128) {
-		$msg = elgg_echo('registration:usernametoolong', [128]);
-		throw new \RegistrationException($msg);
-	}
-
-	// Blacklist for bad characters (partially nicked from mediawiki)
-	$blacklist = '/[' .
-		'\x{0080}-\x{009f}' . // iso-8859-1 control chars
-		'\x{00a0}' .          // non-breaking space
-		'\x{2000}-\x{200f}' . // various whitespace
-		'\x{2028}-\x{202f}' . // breaks and control chars
-		'\x{3000}' .          // ideographic space
-		'\x{e000}-\x{f8ff}' . // private use
-		']/u';
-
-	if (preg_match($blacklist, $username)) {
-		// @todo error message needs work
-		throw new \RegistrationException(elgg_echo('registration:invalidchars'));
-	}
-
-	// Belts and braces
-	// @todo Tidy into main unicode
-	$blacklist2 = '\'/\\"*& ?#%^(){}[]~?<>;|¬`@+=';
-
-	$blacklist2 = elgg_trigger_plugin_hook('username:character_blacklist', 'user',
-		['blacklist' => $blacklist2], $blacklist2);
-
-	for ($n = 0; $n < strlen($blacklist2); $n++) {
-		if (strpos($username, $blacklist2[$n]) !== false) {
-			$msg = elgg_echo('registration:invalidchars', [$blacklist2[$n], $blacklist2]);
-			$msg = htmlspecialchars($msg, ENT_QUOTES, 'UTF-8');
-			throw new \RegistrationException($msg);
-		}
-	}
-
-	$result = true;
-	return elgg_trigger_plugin_hook('registeruser:validate:username', 'all',
-		['username' => $username], $result);
+    global $CONFIG;
+
+    // Basic, check length
+    if (!isset($CONFIG->minusername)) {
+        $CONFIG->minusername = 4;
+    }
+
+    if (strlen($username) < $CONFIG->minusername) {
+        $msg = elgg_echo('registration:usernametooshort', [$CONFIG->minusername]);
+        throw new \RegistrationException($msg);
+    }
+
+    // username in the database has a limit of 128 characters
+    if (strlen($username) > 128) {
+        $msg = elgg_echo('registration:usernametoolong', [128]);
+        throw new \RegistrationException($msg);
+    }
+
+    // Blacklist for bad characters (partially nicked from mediawiki)
+    $blacklist = '/[' .
+        '\x{0080}-\x{009f}' . // iso-8859-1 control chars
+        '\x{00a0}' .          // non-breaking space
+        '\x{2000}-\x{200f}' . // various whitespace
+        '\x{2028}-\x{202f}' . // breaks and control chars
+        '\x{3000}' .          // ideographic space
+        '\x{e000}-\x{f8ff}' . // private use
+        ']/u';
+
+    if (preg_match($blacklist, $username)) {
+        // @todo error message needs work
+        throw new \RegistrationException(elgg_echo('registration:invalidchars'));
+    }
+
+    // Belts and braces
+    // @todo Tidy into main unicode
+    $blacklist2 = '\'/\\"*& ?#%^(){}[]~?<>;|¬`@+=';
+
+    $blacklist2 = elgg_trigger_plugin_hook('username:character_blacklist', 'user',
+        ['blacklist' => $blacklist2], $blacklist2);
+
+    for ($n = 0; $n < strlen($blacklist2); $n++) {
+        if (strpos($username, $blacklist2[$n]) !== false) {
+            $msg = elgg_echo('registration:invalidchars', [$blacklist2[$n], $blacklist2]);
+            $msg = htmlspecialchars($msg, ENT_QUOTES, 'UTF-8');
+            throw new \RegistrationException($msg);
+        }
+    }
+
+    $result = true;
+    return elgg_trigger_plugin_hook('registeruser:validate:username', 'all',
+        ['username' => $username], $result);
 }
 
 /**
@@ -259,20 +259,20 @@ 
  * @throws RegistrationException on invalid
  */
 function validate_password($password) {
-	global $CONFIG;
+    global $CONFIG;
 
-	if (!isset($CONFIG->min_password_length)) {
-		$CONFIG->min_password_length = 6;
-	}
+    if (!isset($CONFIG->min_password_length)) {
+        $CONFIG->min_password_length = 6;
+    }
 
-	if (strlen($password) < $CONFIG->min_password_length) {
-		$msg = elgg_echo('registration:passwordtooshort', [$CONFIG->min_password_length]);
-		throw new \RegistrationException($msg);
-	}
+    if (strlen($password) < $CONFIG->min_password_length) {
+        $msg = elgg_echo('registration:passwordtooshort', [$CONFIG->min_password_length]);
+        throw new \RegistrationException($msg);
+    }
 
-	$result = true;
-	return elgg_trigger_plugin_hook('registeruser:validate:password', 'all',
-		['password' => $password], $result);
+    $result = true;
+    return elgg_trigger_plugin_hook('registeruser:validate:password', 'all',
+        ['password' => $password], $result);
 }
 
 /**
@@ -284,14 +284,14 @@ 
  * @return bool
  */
 function validate_email_address($address) {
-	if (!is_email_address($address)) {
-		throw new \RegistrationException(elgg_echo('registration:notemail'));
-	}
-
-	// Got here, so lets try a hook (defaulting to ok)
-	$result = true;
-	return elgg_trigger_plugin_hook('registeruser:validate:email', 'all',
-		['email' => $address], $result);
+    if (!is_email_address($address)) {
+        throw new \RegistrationException(elgg_echo('registration:notemail'));
+    }
+
+    // Got here, so lets try a hook (defaulting to ok)
+    $result = true;
+    return elgg_trigger_plugin_hook('registeruser:validate:email', 'all',
+        ['email' => $address], $result);
 }
 
 /**
@@ -308,7 +308,7 @@ 
  * @throws RegistrationException
  */
 function register_user($username, $password, $name, $email, $allow_multiple_emails = false) {
-	return _elgg_services()->usersTable->register($username, $password, $name, $email, $allow_multiple_emails);
+    return _elgg_services()->usersTable->register($username, $password, $name, $email, $allow_multiple_emails);
 }
 
 /**
@@ -320,7 +320,7 @@ 
  * @see elgg_validate_invite_code
  */
 function generate_invite_code($username) {
-	return _elgg_services()->usersTable->generateInviteCode($username);
+    return _elgg_services()->usersTable->generateInviteCode($username);
 }
 
 /**
@@ -334,7 +334,7 @@ 
  * @since 1.10
  */
 function elgg_validate_invite_code($username, $code) {
-	return _elgg_services()->usersTable->validateInviteCode($username, $code);
+    return _elgg_services()->usersTable->validateInviteCode($username, $code);
 }
 
 /**
@@ -347,7 +347,7 @@ 
  * @since 1.8.0
  */
 function elgg_set_user_validation_status($user_guid, $status, $method = '') {
-	return _elgg_services()->usersTable->setValidationStatus($user_guid, $status, $method);
+    return _elgg_services()->usersTable->setValidationStatus($user_guid, $status, $method);
 }
 
 /**
@@ -358,7 +358,7 @@ 
  * @since 1.8.0
  */
 function elgg_get_user_validation_status($user_guid) {
-	return _elgg_services()->usersTable->getValidationStatus($user_guid);
+    return _elgg_services()->usersTable->getValidationStatus($user_guid);
 }
 
 /**
@@ -372,24 +372,24 @@ 
  */
 function elgg_user_account_page_handler($page_elements, $handler) {
 
-	switch ($handler) {
-		case 'login':
-			echo elgg_view_resource("account/login");
-			break;
-		case 'forgotpassword':
-			echo elgg_view_resource("account/forgotten_password");
-			break;
-		case 'changepassword':
-			echo elgg_view_resource("account/change_password");
-			break;
-		case 'register':
-			echo elgg_view_resource("account/register");
-			break;
-		default:
-			return false;
-	}
-
-	return true;
+    switch ($handler) {
+        case 'login':
+            echo elgg_view_resource("account/login");
+            break;
+        case 'forgotpassword':
+            echo elgg_view_resource("account/forgotten_password");
+            break;
+        case 'changepassword':
+            echo elgg_view_resource("account/change_password");
+            break;
+        case 'register':
+            echo elgg_view_resource("account/register");
+            break;
+        default:
+            return false;
+    }
+
+    return true;
 }
 
 /**
@@ -403,9 +403,9 @@ 
  * @return string
  */
 function elgg_get_registration_url(array $query = [], $fragment = '') {
-	$url = elgg_normalize_url('register');
-	$url = elgg_http_add_url_query_elements($url, $query) . $fragment;
-	return elgg_trigger_plugin_hook('registration_url', 'site', $query, $url);
+    $url = elgg_normalize_url('register');
+    $url = elgg_http_add_url_query_elements($url, $query) . $fragment;
+    return elgg_trigger_plugin_hook('registration_url', 'site', $query, $url);
 }
 
 /**
@@ -418,9 +418,9 @@ 
  * @return string
  */
 function elgg_get_login_url(array $query = [], $fragment = '') {
-	$url = elgg_normalize_url('login');
-	$url = elgg_http_add_url_query_elements($url, $query) . $fragment;
-	return elgg_trigger_plugin_hook('login_url', 'site', $query, $url);
+    $url = elgg_normalize_url('login');
+    $url = elgg_http_add_url_query_elements($url, $query) . $fragment;
+    return elgg_trigger_plugin_hook('login_url', 'site', $query, $url);
 }
 
 /**
@@ -430,11 +430,11 @@ 
  * @return void
  */
 function set_last_action($user_guid) {
-	$user = get_user($user_guid);
-	if (!$user) {
-		return;
-	}
-	_elgg_services()->usersTable->setLastAction($user);
+    $user = get_user($user_guid);
+    if (!$user) {
+        return;
+    }
+    _elgg_services()->usersTable->setLastAction($user);
 }
 
 /**
@@ -444,11 +444,11 @@ 
  * @return void
  */
 function set_last_login($user_guid) {
-	$user = get_user($user_guid);
-	if (!$user) {
-		return;
-	}
-	_elgg_services()->usersTable->setLastLogin($user);
+    $user = get_user($user_guid);
+    if (!$user) {
+        return;
+    }
+    _elgg_services()->usersTable->setLastLogin($user);
 }
 
 /**
@@ -463,23 +463,23 @@ 
  * @access private
  */
 function user_avatar_hook($hook, $type, $return, $params) {
-	$user = elgg_extract('entity', $params);
-	$size = elgg_extract('size', $params, 'medium');
+    $user = elgg_extract('entity', $params);
+    $size = elgg_extract('size', $params, 'medium');
 
-	if (!$user instanceof ElggUser) {
-		return;
-	}
+    if (!$user instanceof ElggUser) {
+        return;
+    }
 
-	if (elgg_get_config('walled_garden')) {
-		return;
-	}
+    if (elgg_get_config('walled_garden')) {
+        return;
+    }
 
-	if (!$user->hasIcon($size, 'icon')) {
-		return;
-	}
+    if (!$user->hasIcon($size, 'icon')) {
+        return;
+    }
 	
-	$icon = $user->getIcon($size, 'icon');
-	return elgg_get_inline_url($icon, false);
+    $icon = $user->getIcon($size, 'icon');
+    return elgg_get_inline_url($icon, false);
 }
 
 /**
@@ -487,112 +487,112 @@ 
  * @access private
  */
 function elgg_user_hover_menu($hook, $type, $return, $params) {
-	$user = elgg_extract('entity', $params);
-	/* @var \ElggUser $user */
+    $user = elgg_extract('entity', $params);
+    /* @var \ElggUser $user */
 
-	if (!$user instanceof \ElggUser) {
-		return;
-	}
+    if (!$user instanceof \ElggUser) {
+        return;
+    }
 
-	if (!elgg_is_logged_in()) {
-		return;
-	}
+    if (!elgg_is_logged_in()) {
+        return;
+    }
 	
-	if ($user->canEdit()) {
-		$return[] = ElggMenuItem::factory([
-			'name' => 'profile:edit',
-			'text' => elgg_echo('profile:edit'),
-			'icon' => 'address-card',
-			'href' => "profile/$user->username/edit",
-			'section' => (elgg_get_logged_in_user_guid() == $user->guid)? 'action' : 'admin',
-		]);
-
-		$return[] = ElggMenuItem::factory([
-			'name' => 'avatar:edit',
-			'text' => elgg_echo('avatar:edit'),
-			'icon' => 'image',
-			'href' => "avatar/edit/$user->username",
-			'section' => (elgg_get_logged_in_user_guid() == $user->guid)? 'action' : 'admin',
-		]);
-	}
-
-	// prevent admins from banning or deleting themselves
-	if (elgg_get_logged_in_user_guid() == $user->guid) {
-		return $return;
-	}
-
-	if (!elgg_is_admin_logged_in()) {
-		return $return;
-	}
+    if ($user->canEdit()) {
+        $return[] = ElggMenuItem::factory([
+            'name' => 'profile:edit',
+            'text' => elgg_echo('profile:edit'),
+            'icon' => 'address-card',
+            'href' => "profile/$user->username/edit",
+            'section' => (elgg_get_logged_in_user_guid() == $user->guid)? 'action' : 'admin',
+        ]);
+
+        $return[] = ElggMenuItem::factory([
+            'name' => 'avatar:edit',
+            'text' => elgg_echo('avatar:edit'),
+            'icon' => 'image',
+            'href' => "avatar/edit/$user->username",
+            'section' => (elgg_get_logged_in_user_guid() == $user->guid)? 'action' : 'admin',
+        ]);
+    }
+
+    // prevent admins from banning or deleting themselves
+    if (elgg_get_logged_in_user_guid() == $user->guid) {
+        return $return;
+    }
+
+    if (!elgg_is_admin_logged_in()) {
+        return $return;
+    }
 	
-	// following items are admin only
-	if (!$user->isBanned()) {
-		$return[] = ElggMenuItem::factory([
-			'name' => 'ban',
-			'text' => elgg_echo('ban'),
-			'icon' => 'ban',
-			'href' => "action/admin/user/ban?guid={$user->guid}",
-			'confirm' => true,
-			'section' => 'admin',
-		]);
-	} else {
-		$return[] = ElggMenuItem::factory([
-			'name' => 'unban',
-			'text' => elgg_echo('unban'),
-			'icon' => 'ban',
-			'href' => "action/admin/user/unban?guid={$user->guid}",
-			'confirm' => true,
-			'section' => 'admin',
-		]);
-	}
+    // following items are admin only
+    if (!$user->isBanned()) {
+        $return[] = ElggMenuItem::factory([
+            'name' => 'ban',
+            'text' => elgg_echo('ban'),
+            'icon' => 'ban',
+            'href' => "action/admin/user/ban?guid={$user->guid}",
+            'confirm' => true,
+            'section' => 'admin',
+        ]);
+    } else {
+        $return[] = ElggMenuItem::factory([
+            'name' => 'unban',
+            'text' => elgg_echo('unban'),
+            'icon' => 'ban',
+            'href' => "action/admin/user/unban?guid={$user->guid}",
+            'confirm' => true,
+            'section' => 'admin',
+        ]);
+    }
 	
-	$return[] = ElggMenuItem::factory([
-		'name' => 'delete',
-		'text' => elgg_echo('delete'),
-		'icon' => 'delete',
-		'href' => "action/admin/user/delete?guid={$user->guid}",
-		'confirm' => true,
-		'section' => 'admin',
-	]);
+    $return[] = ElggMenuItem::factory([
+        'name' => 'delete',
+        'text' => elgg_echo('delete'),
+        'icon' => 'delete',
+        'href' => "action/admin/user/delete?guid={$user->guid}",
+        'confirm' => true,
+        'section' => 'admin',
+    ]);
 	
-	$return[] = ElggMenuItem::factory([
-		'name' => 'resetpassword',
-		'text' => elgg_echo('resetpassword'),
-		'icon' => 'refresh',
-		'href' => "action/admin/user/resetpassword?guid={$user->guid}",
-		'confirm' => true,
-		'section' => 'admin',
-	]);
+    $return[] = ElggMenuItem::factory([
+        'name' => 'resetpassword',
+        'text' => elgg_echo('resetpassword'),
+        'icon' => 'refresh',
+        'href' => "action/admin/user/resetpassword?guid={$user->guid}",
+        'confirm' => true,
+        'section' => 'admin',
+    ]);
 	
-	if (!$user->isAdmin()) {
-		$return[] = ElggMenuItem::factory([
-			'name' => 'makeadmin',
-			'text' => elgg_echo('makeadmin'),
-			'icon' => 'level-up',
-			'href' => "action/admin/user/makeadmin?guid={$user->guid}",
-			'confirm' => true,
-			'section' => 'admin',
-		]);
-	} else {
-		$return[] = ElggMenuItem::factory([
-			'name' => 'removeadmin',
-			'text' => elgg_echo('removeadmin'),
-			'icon' => 'level-down',
-			'href' => "action/admin/user/removeadmin?guid={$user->guid}",
-			'confirm' => true,
-			'section' => 'admin',
-		]);
-	}
+    if (!$user->isAdmin()) {
+        $return[] = ElggMenuItem::factory([
+            'name' => 'makeadmin',
+            'text' => elgg_echo('makeadmin'),
+            'icon' => 'level-up',
+            'href' => "action/admin/user/makeadmin?guid={$user->guid}",
+            'confirm' => true,
+            'section' => 'admin',
+        ]);
+    } else {
+        $return[] = ElggMenuItem::factory([
+            'name' => 'removeadmin',
+            'text' => elgg_echo('removeadmin'),
+            'icon' => 'level-down',
+            'href' => "action/admin/user/removeadmin?guid={$user->guid}",
+            'confirm' => true,
+            'section' => 'admin',
+        ]);
+    }
 	
-	$return[] = ElggMenuItem::factory([
-		'name' => 'settings:edit',
-		'text' => elgg_echo('settings:edit'),
-		'icon' => 'cogs',
-		'href' => "settings/user/$user->username",
-		'section' => 'admin',
-	]);
-
-	return $return;
+    $return[] = ElggMenuItem::factory([
+        'name' => 'settings:edit',
+        'text' => elgg_echo('settings:edit'),
+        'icon' => 'cogs',
+        'href' => "settings/user/$user->username",
+        'section' => 'admin',
+    ]);
+
+    return $return;
 }
 
 /**
@@ -607,41 +607,41 @@ 
  * @access private
  */
 function elgg_users_setup_entity_menu($hook, $type, $return, $params) {
-	if (elgg_in_context('widgets')) {
-		return $return;
-	}
-
-	$entity = $params['entity'];
-	if (!elgg_instanceof($entity, 'user')) {
-		return $return;
-	}
-	/* @var \ElggUser $entity */
-
-	if ($entity->isBanned()) {
-		$banned = elgg_echo('banned');
-		$options = [
-			'name' => 'banned',
-			'text' => "<span>$banned</span>",
-			'href' => false,
-			'priority' => 0,
-		];
-		$return = [\ElggMenuItem::factory($options)];
-	} else {
-		$return = [];
-		$location = $entity->location;
-		if (is_string($location) && $location !== '') {
-			$location = htmlspecialchars($location, ENT_QUOTES, 'UTF-8', false);
-			$options = [
-				'name' => 'location',
-				'text' => "<span>$location</span>",
-				'href' => false,
-				'priority' => 150,
-			];
-			$return[] = \ElggMenuItem::factory($options);
-		}
-	}
-
-	return $return;
+    if (elgg_in_context('widgets')) {
+        return $return;
+    }
+
+    $entity = $params['entity'];
+    if (!elgg_instanceof($entity, 'user')) {
+        return $return;
+    }
+    /* @var \ElggUser $entity */
+
+    if ($entity->isBanned()) {
+        $banned = elgg_echo('banned');
+        $options = [
+            'name' => 'banned',
+            'text' => "<span>$banned</span>",
+            'href' => false,
+            'priority' => 0,
+        ];
+        $return = [\ElggMenuItem::factory($options)];
+    } else {
+        $return = [];
+        $location = $entity->location;
+        if (is_string($location) && $location !== '') {
+            $location = htmlspecialchars($location, ENT_QUOTES, 'UTF-8', false);
+            $options = [
+                'name' => 'location',
+                'text' => "<span>$location</span>",
+                'href' => false,
+                'priority' => 150,
+            ];
+            $return[] = \ElggMenuItem::factory($options);
+        }
+    }
+
+    return $return;
 }
 
 /**
@@ -653,49 +653,49 @@ 
  * @access private
  */
 function elgg_profile_fields_setup() {
-	global $CONFIG;
-
-	$profile_defaults =  [
-		'description' => 'longtext',
-		'briefdescription' => 'text',
-		'location' => 'location',
-		'interests' => 'tags',
-		'skills' => 'tags',
-		'contactemail' => 'email',
-		'phone' => 'text',
-		'mobile' => 'text',
-		'website' => 'url',
-		'twitter' => 'text',
-	];
-
-	$loaded_defaults = [];
-	$fieldlist = elgg_get_config('profile_custom_fields');
-	if ($fieldlist || $fieldlist === '0') {
-		$fieldlistarray = explode(',', $fieldlist);
-		foreach ($fieldlistarray as $listitem) {
-			if ($translation = elgg_get_config("admin_defined_profile_{$listitem}")) {
-				$type = elgg_get_config("admin_defined_profile_type_{$listitem}");
-				$loaded_defaults["admin_defined_profile_{$listitem}"] = $type;
-				add_translation(get_current_language(), ["profile:admin_defined_profile_{$listitem}" => $translation]);
-			}
-		}
-	}
-
-	if (count($loaded_defaults)) {
-		$CONFIG->profile_using_custom = true;
-		$profile_defaults = $loaded_defaults;
-	}
-
-	$CONFIG->profile_fields = elgg_trigger_plugin_hook('profile:fields', 'profile', null, $profile_defaults);
-
-	// register any tag metadata names
-	foreach ($CONFIG->profile_fields as $name => $type) {
-		if ($type == 'tags' || $type == 'location' || $type == 'tag') {
-			elgg_register_tag_metadata_name($name);
-			// register a tag name translation
-			add_translation(get_current_language(), ["tag_names:$name" => elgg_echo("profile:$name")]);
-		}
-	}
+    global $CONFIG;
+
+    $profile_defaults =  [
+        'description' => 'longtext',
+        'briefdescription' => 'text',
+        'location' => 'location',
+        'interests' => 'tags',
+        'skills' => 'tags',
+        'contactemail' => 'email',
+        'phone' => 'text',
+        'mobile' => 'text',
+        'website' => 'url',
+        'twitter' => 'text',
+    ];
+
+    $loaded_defaults = [];
+    $fieldlist = elgg_get_config('profile_custom_fields');
+    if ($fieldlist || $fieldlist === '0') {
+        $fieldlistarray = explode(',', $fieldlist);
+        foreach ($fieldlistarray as $listitem) {
+            if ($translation = elgg_get_config("admin_defined_profile_{$listitem}")) {
+                $type = elgg_get_config("admin_defined_profile_type_{$listitem}");
+                $loaded_defaults["admin_defined_profile_{$listitem}"] = $type;
+                add_translation(get_current_language(), ["profile:admin_defined_profile_{$listitem}" => $translation]);
+            }
+        }
+    }
+
+    if (count($loaded_defaults)) {
+        $CONFIG->profile_using_custom = true;
+        $profile_defaults = $loaded_defaults;
+    }
+
+    $CONFIG->profile_fields = elgg_trigger_plugin_hook('profile:fields', 'profile', null, $profile_defaults);
+
+    // register any tag metadata names
+    foreach ($CONFIG->profile_fields as $name => $type) {
+        if ($type == 'tags' || $type == 'location' || $type == 'tag') {
+            elgg_register_tag_metadata_name($name);
+            // register a tag name translation
+            add_translation(get_current_language(), ["tag_names:$name" => elgg_echo("profile:$name")]);
+        }
+    }
 }
 
 /**
@@ -708,15 +708,15 @@ 
  * @access private
  */
 function elgg_avatar_page_handler($page) {
-	$user = get_user_by_username(elgg_extract(1, $page));
-	if ($user) {
-		elgg_set_page_owner_guid($user->getGUID());
-	}
-
-	if ($page[0] == 'edit') {
-		echo elgg_view_resource("avatar/edit");
-		return true;
-	}
+    $user = get_user_by_username(elgg_extract(1, $page));
+    if ($user) {
+        elgg_set_page_owner_guid($user->getGUID());
+    }
+
+    if ($page[0] == 'edit') {
+        echo elgg_view_resource("avatar/edit");
+        return true;
+    }
 }
 
 /**
@@ -727,14 +727,14 @@ 
  * @access private
  */
 function elgg_profile_page_handler($page) {
-	$user = get_user_by_username($page[0]);
-	elgg_set_page_owner_guid($user->guid);
-
-	if ($page[1] == 'edit') {
-		echo elgg_view_resource("profile/edit");
-		return true;
-	}
-	return false;
+    $user = get_user_by_username($page[0]);
+    elgg_set_page_owner_guid($user->guid);
+
+    if ($page[1] == 'edit') {
+        echo elgg_view_resource("profile/edit");
+        return true;
+    }
+    return false;
 }
 
 /**
@@ -753,28 +753,28 @@ 
  */
 function _elgg_user_page_menu($hook, $type, $return, $params) {
 	
-	$owner = elgg_get_page_owner_entity();
-	if (!$owner) {
-		return;
-	}
-
-	$return[] = \ElggMenuItem::factory([
-		'name' => 'edit_avatar',
-		'href' => "avatar/edit/{$owner->username}",
-		'text' => elgg_echo('avatar:edit'),
-		'section' => '1_profile',
-		'contexts' => ['settings'],
-	]);
+    $owner = elgg_get_page_owner_entity();
+    if (!$owner) {
+        return;
+    }
+
+    $return[] = \ElggMenuItem::factory([
+        'name' => 'edit_avatar',
+        'href' => "avatar/edit/{$owner->username}",
+        'text' => elgg_echo('avatar:edit'),
+        'section' => '1_profile',
+        'contexts' => ['settings'],
+    ]);
 	
-	$return[] = \ElggMenuItem::factory([
-		'name' => 'edit_profile',
-		'href' => "profile/{$owner->username}/edit",
-		'text' => elgg_echo('profile:edit'),
-		'section' => '1_profile',
-		'contexts' => ['settings'],
-	]);
+    $return[] = \ElggMenuItem::factory([
+        'name' => 'edit_profile',
+        'href' => "profile/{$owner->username}/edit",
+        'text' => elgg_echo('profile:edit'),
+        'section' => '1_profile',
+        'contexts' => ['settings'],
+    ]);
 	
-	return $return;
+    return $return;
 }
 
 /**
@@ -793,68 +793,68 @@ 
  */
 function _elgg_user_topbar_menu($hook, $type, $return, $params) {
 	
-	$viewer = elgg_get_logged_in_user_entity();
-	if (!$viewer) {
-		return;
-	}
-
-	$toggle = elgg_view_icon('chevron-down', ['class' => 'elgg-state-closed']);
-	$toggle .= elgg_view_icon('chevron-up', ['class' => 'elgg-state-opened']);
-
-	// If JS fails here, allow easy access to place where they can upgrade/flush caches
-	$href = elgg_is_admin_logged_in() ? elgg_get_login_url() : '#';
-
-	$return[] = \ElggMenuItem::factory([
-		'name' => 'account',
-		'text' => elgg_echo('account') . $toggle,
-		'href' => $href,
-		'priority' => 800,
-		'section' => 'alt',
-		'child_menu' => [
-			'display' => 'dropdown',
-			'class' => 'elgg-topbar-child-menu',
-			'data-position' => json_encode([
-				'at' => 'right+10px bottom',
-				'my' => 'right top',
-				'collision' => 'fit fit',
-			]),
-		],
-	]);
+    $viewer = elgg_get_logged_in_user_entity();
+    if (!$viewer) {
+        return;
+    }
+
+    $toggle = elgg_view_icon('chevron-down', ['class' => 'elgg-state-closed']);
+    $toggle .= elgg_view_icon('chevron-up', ['class' => 'elgg-state-opened']);
+
+    // If JS fails here, allow easy access to place where they can upgrade/flush caches
+    $href = elgg_is_admin_logged_in() ? elgg_get_login_url() : '#';
+
+    $return[] = \ElggMenuItem::factory([
+        'name' => 'account',
+        'text' => elgg_echo('account') . $toggle,
+        'href' => $href,
+        'priority' => 800,
+        'section' => 'alt',
+        'child_menu' => [
+            'display' => 'dropdown',
+            'class' => 'elgg-topbar-child-menu',
+            'data-position' => json_encode([
+                'at' => 'right+10px bottom',
+                'my' => 'right top',
+                'collision' => 'fit fit',
+            ]),
+        ],
+    ]);
 	
-	$return[] = \ElggMenuItem::factory([
-		'name' => 'usersettings',
-		'parent_name' => 'account',
-		'href' => "settings/user/{$viewer->username}",
-		'text' => elgg_echo('settings'),
-		'icon' => 'cogs',
-		'priority' => 300,
-		'section' => 'alt',
-	]);
+    $return[] = \ElggMenuItem::factory([
+        'name' => 'usersettings',
+        'parent_name' => 'account',
+        'href' => "settings/user/{$viewer->username}",
+        'text' => elgg_echo('settings'),
+        'icon' => 'cogs',
+        'priority' => 300,
+        'section' => 'alt',
+    ]);
 	
-	if ($viewer->isAdmin()) {
-		$return[] = \ElggMenuItem::factory([
-			'name' => 'administration',
-			'parent_name' => 'account',
-			'href' => 'admin',
-			'text' => elgg_echo('admin'),
-			'icon' => 'tasks',
-			'priority' => 800,
-			'section' => 'alt',
-		]);
-	}
+    if ($viewer->isAdmin()) {
+        $return[] = \ElggMenuItem::factory([
+            'name' => 'administration',
+            'parent_name' => 'account',
+            'href' => 'admin',
+            'text' => elgg_echo('admin'),
+            'icon' => 'tasks',
+            'priority' => 800,
+            'section' => 'alt',
+        ]);
+    }
 	
-	$return[] = \ElggMenuItem::factory([
-		'name' => 'logout',
-		'parent_name' => 'account',
-		'href' => 'action/logout',
-		'text' => elgg_echo('logout'),
-		'icon' => 'sign-out',
-		'is_action' => true,
-		'priority' => 900,
-		'section' => 'alt',
-	]);
+    $return[] = \ElggMenuItem::factory([
+        'name' => 'logout',
+        'parent_name' => 'account',
+        'href' => 'action/logout',
+        'text' => elgg_echo('logout'),
+        'icon' => 'sign-out',
+        'is_action' => true,
+        'priority' => 900,
+        'section' => 'alt',
+    ]);
 	
-	return $return;
+    return $return;
 }
 
 /**
@@ -868,13 +868,13 @@ 
  */
 function _elgg_user_set_icon_file($hook, $type, $icon, $params) {
 
-	$entity = elgg_extract('entity', $params);
-	$size = elgg_extract('size', $params, 'medium');
+    $entity = elgg_extract('entity', $params);
+    $size = elgg_extract('size', $params, 'medium');
 
-	$icon->owner_guid = $entity->guid;
-	$icon->setFilename("profile/{$entity->guid}{$size}.jpg");
+    $icon->owner_guid = $entity->guid;
+    $icon->setFilename("profile/{$entity->guid}{$size}.jpg");
 	
-	return $icon;
+    return $icon;
 }
 
 /**
@@ -889,27 +889,27 @@ 
  */
 function _elgg_user_get_subscriber_unban_action($hook, $type, $return_value, $params) {
 	
-	if (!elgg_get_config('security_notify_user_ban')) {
-		return;
-	}
+    if (!elgg_get_config('security_notify_user_ban')) {
+        return;
+    }
 	
-	$event = elgg_extract('event', $params);
-	if (!($event instanceof \Elgg\Notifications\Event)) {
-		return;
-	}
+    $event = elgg_extract('event', $params);
+    if (!($event instanceof \Elgg\Notifications\Event)) {
+        return;
+    }
 	
-	if ($event->getAction() !== 'unban') {
-		return;
-	}
+    if ($event->getAction() !== 'unban') {
+        return;
+    }
 	
-	$user = $event->getObject();
-	if (!($user instanceof \ElggUser)) {
-		return;
-	}
+    $user = $event->getObject();
+    if (!($user instanceof \ElggUser)) {
+        return;
+    }
 	
-	$return_value[$user->getGUID()] = ['email'];
+    $return_value[$user->getGUID()] = ['email'];
 	
-	return $return_value;
+    return $return_value;
 }
 
 /**
@@ -925,29 +925,29 @@ 
  */
 function _elgg_user_ban_notification($event, $type, $user) {
 	
-	if (!elgg_get_config('security_notify_user_ban')) {
-		return;
-	}
+    if (!elgg_get_config('security_notify_user_ban')) {
+        return;
+    }
 	
-	if (!($user instanceof \ElggUser)) {
-		return;
-	}
+    if (!($user instanceof \ElggUser)) {
+        return;
+    }
 	
-	$site = elgg_get_site_entity();
+    $site = elgg_get_site_entity();
 	
-	$subject = elgg_echo('user:notification:ban:subject', [$site->name], $language);
-	$body = elgg_echo('user:notification:ban:body', [
-		$recipient->name,
-		$site->name,
-		$site->getURL(),
-	], $language);
+    $subject = elgg_echo('user:notification:ban:subject', [$site->name], $language);
+    $body = elgg_echo('user:notification:ban:body', [
+        $recipient->name,
+        $site->name,
+        $site->getURL(),
+    ], $language);
 	
-	$params = [
-		'action' => 'ban',
-		'object' => $user,
-	];
+    $params = [
+        'action' => 'ban',
+        'object' => $user,
+    ];
 	
-	notify_user($user->getGUID(), $site->getGUID(), $subject, $body, $params, ['email']);
+    notify_user($user->getGUID(), $site->getGUID(), $subject, $body, $params, ['email']);
 }
 
 /**
@@ -962,34 +962,34 @@ 
  */
 function _elgg_user_prepare_unban_notification($hook, $type, $return_value, $params) {
 	
-	if (!($return_value instanceof \Elgg\Notifications\Notification)) {
-		return;
-	}
+    if (!($return_value instanceof \Elgg\Notifications\Notification)) {
+        return;
+    }
 	
-	$recipient = elgg_extract('recipient', $params);
-	$object = elgg_extract('object', $params);
-	$language = elgg_extract('language', $params);
+    $recipient = elgg_extract('recipient', $params);
+    $object = elgg_extract('object', $params);
+    $language = elgg_extract('language', $params);
 	
-	if (!($recipient instanceof ElggUser) || !($object instanceof ElggUser)) {
-		return;
-	}
+    if (!($recipient instanceof ElggUser) || !($object instanceof ElggUser)) {
+        return;
+    }
 	
-	if ($recipient->getGUID() !== $object->getGUID()) {
-		return;
-	}
+    if ($recipient->getGUID() !== $object->getGUID()) {
+        return;
+    }
 	
-	$site = elgg_get_site_entity();
+    $site = elgg_get_site_entity();
 	
-	$return_value->subject = elgg_echo('user:notification:unban:subject', [$site->name], $language);
-	$return_value->body = elgg_echo('user:notification:unban:body', [
-		$recipient->name,
-		$site->name,
-		$site->getURL(),
-	], $language);
-
-	$return_value->url = $recipient->getURL();
+    $return_value->subject = elgg_echo('user:notification:unban:subject', [$site->name], $language);
+    $return_value->body = elgg_echo('user:notification:unban:body', [
+        $recipient->name,
+        $site->name,
+        $site->getURL(),
+    ], $language);
+
+    $return_value->url = $recipient->getURL();
 	
-	return $return_value;
+    return $return_value;
 }
 
 /**
@@ -1000,42 +1000,42 @@ 
  */
 function users_init() {
 
-	elgg_register_page_handler('register', 'elgg_user_account_page_handler');
-	elgg_register_page_handler('forgotpassword', 'elgg_user_account_page_handler');
-	elgg_register_page_handler('changepassword', 'elgg_user_account_page_handler');
-	elgg_register_page_handler('login', 'elgg_user_account_page_handler');
-	elgg_register_page_handler('avatar', 'elgg_avatar_page_handler');
-	elgg_register_page_handler('profile', 'elgg_profile_page_handler');
+    elgg_register_page_handler('register', 'elgg_user_account_page_handler');
+    elgg_register_page_handler('forgotpassword', 'elgg_user_account_page_handler');
+    elgg_register_page_handler('changepassword', 'elgg_user_account_page_handler');
+    elgg_register_page_handler('login', 'elgg_user_account_page_handler');
+    elgg_register_page_handler('avatar', 'elgg_avatar_page_handler');
+    elgg_register_page_handler('profile', 'elgg_profile_page_handler');
 
-	elgg_register_plugin_hook_handler('register', 'menu:user_hover', 'elgg_user_hover_menu');
-	elgg_register_plugin_hook_handler('register', 'menu:page', '_elgg_user_page_menu');
-	elgg_register_plugin_hook_handler('register', 'menu:topbar', '_elgg_user_topbar_menu');
+    elgg_register_plugin_hook_handler('register', 'menu:user_hover', 'elgg_user_hover_menu');
+    elgg_register_plugin_hook_handler('register', 'menu:page', '_elgg_user_page_menu');
+    elgg_register_plugin_hook_handler('register', 'menu:topbar', '_elgg_user_topbar_menu');
 
-	elgg_register_action('login', '', 'public');
-	elgg_register_action('logout');
-	elgg_register_action('register', '', 'public');
-	elgg_register_action('useradd', '', 'admin');
-	elgg_register_action('avatar/upload');
-	elgg_register_action('avatar/crop');
-	elgg_register_action('avatar/remove');
-	elgg_register_action('profile/edit');
+    elgg_register_action('login', '', 'public');
+    elgg_register_action('logout');
+    elgg_register_action('register', '', 'public');
+    elgg_register_action('useradd', '', 'admin');
+    elgg_register_action('avatar/upload');
+    elgg_register_action('avatar/crop');
+    elgg_register_action('avatar/remove');
+    elgg_register_action('profile/edit');
 
-	elgg_register_plugin_hook_handler('entity:icon:url', 'user', 'user_avatar_hook');
+    elgg_register_plugin_hook_handler('entity:icon:url', 'user', 'user_avatar_hook');
 
-	elgg_register_action('user/changepassword', '', 'public');
-	elgg_register_action('user/requestnewpassword', '', 'public');
+    elgg_register_action('user/changepassword', '', 'public');
+    elgg_register_action('user/requestnewpassword', '', 'public');
 
-	// Register the user type
-	elgg_register_entity_type('user', '');
+    // Register the user type
+    elgg_register_entity_type('user', '');
 
-	elgg_register_plugin_hook_handler('register', 'menu:entity', 'elgg_users_setup_entity_menu', 501);
+    elgg_register_plugin_hook_handler('register', 'menu:entity', 'elgg_users_setup_entity_menu', 501);
 
-	elgg_register_plugin_hook_handler('entity:icon:file', 'user', '_elgg_user_set_icon_file');
+    elgg_register_plugin_hook_handler('entity:icon:file', 'user', '_elgg_user_set_icon_file');
 	
-	elgg_register_notification_event('user', '', ['unban']);
-	elgg_register_plugin_hook_handler('get', 'subscriptions', '_elgg_user_get_subscriber_ban_action');
-	elgg_register_event_handler('ban', 'user', '_elgg_user_ban_notification');
-	elgg_register_plugin_hook_handler('prepare', 'notification:unban:user:', '_elgg_user_prepare_unban_notification');
+    elgg_register_notification_event('user', '', ['unban']);
+    elgg_register_plugin_hook_handler('get', 'subscriptions', '_elgg_user_get_subscriber_ban_action');
+    elgg_register_event_handler('ban', 'user', '_elgg_user_ban_notification');
+    elgg_register_plugin_hook_handler('prepare', 'notification:unban:user:', '_elgg_user_prepare_unban_notification');
 	
 }
 
@@ -1051,13 +1051,13 @@ 
  * @access private
  */
 function users_test($hook, $type, $value, $params) {
-	global $CONFIG;
-	$value[] = "{$CONFIG->path}engine/tests/ElggUserTest.php";
-	return $value;
+    global $CONFIG;
+    $value[] = "{$CONFIG->path}engine/tests/ElggUserTest.php";
+    return $value;
 }
 
 return function(\Elgg\EventsService $events, \Elgg\HooksRegistrationService $hooks) {
-	$events->registerHandler('init', 'system', 'users_init', 0);
-	$events->registerHandler('init', 'system', 'elgg_profile_fields_setup', 10000); // Ensure this runs after other plugins
-	$hooks->registerHandler('unit_test', 'system', 'users_test');
+    $events->registerHandler('init', 'system', 'users_init', 0);
+    $events->registerHandler('init', 'system', 'elgg_profile_fields_setup', 10000); // Ensure this runs after other plugins
+    $hooks->registerHandler('unit_test', 'system', 'users_test');
 };

Spacing +13 added lines, -13 removed lines

@@ -216,13 +216,13 @@ 
 	}
 
 	// Blacklist for bad characters (partially nicked from mediawiki)
-	$blacklist = '/[' .
-		'\x{0080}-\x{009f}' . // iso-8859-1 control chars
-		'\x{00a0}' .          // non-breaking space
-		'\x{2000}-\x{200f}' . // various whitespace
-		'\x{2028}-\x{202f}' . // breaks and control chars
-		'\x{3000}' .          // ideographic space
-		'\x{e000}-\x{f8ff}' . // private use
+	$blacklist = '/['.
+		'\x{0080}-\x{009f}'.// iso-8859-1 control chars
+		'\x{00a0}'.// non-breaking space
+		'\x{2000}-\x{200f}'.// various whitespace
+		'\x{2028}-\x{202f}'.// breaks and control chars
+		'\x{3000}'.// ideographic space
+		'\x{e000}-\x{f8ff}'.// private use
 		']/u';
 
 	if (preg_match($blacklist, $username)) {
@@ -404,7 +404,7 @@ 
  */
 function elgg_get_registration_url(array $query = [], $fragment = '') {
 	$url = elgg_normalize_url('register');
-	$url = elgg_http_add_url_query_elements($url, $query) . $fragment;
+	$url = elgg_http_add_url_query_elements($url, $query).$fragment;
 	return elgg_trigger_plugin_hook('registration_url', 'site', $query, $url);
 }
 
@@ -419,7 +419,7 @@ 
  */
 function elgg_get_login_url(array $query = [], $fragment = '') {
 	$url = elgg_normalize_url('login');
-	$url = elgg_http_add_url_query_elements($url, $query) . $fragment;
+	$url = elgg_http_add_url_query_elements($url, $query).$fragment;
 	return elgg_trigger_plugin_hook('login_url', 'site', $query, $url);
 }
 
@@ -504,7 +504,7 @@ 
 			'text' => elgg_echo('profile:edit'),
 			'icon' => 'address-card',
 			'href' => "profile/$user->username/edit",
-			'section' => (elgg_get_logged_in_user_guid() == $user->guid)? 'action' : 'admin',
+			'section' => (elgg_get_logged_in_user_guid() == $user->guid) ? 'action' : 'admin',
 		]);
 
 		$return[] = ElggMenuItem::factory([
@@ -512,7 +512,7 @@ 
 			'text' => elgg_echo('avatar:edit'),
 			'icon' => 'image',
 			'href' => "avatar/edit/$user->username",
-			'section' => (elgg_get_logged_in_user_guid() == $user->guid)? 'action' : 'admin',
+			'section' => (elgg_get_logged_in_user_guid() == $user->guid) ? 'action' : 'admin',
 		]);
 	}
 
@@ -655,7 +655,7 @@ 
 function elgg_profile_fields_setup() {
 	global $CONFIG;
 
-	$profile_defaults =  [
+	$profile_defaults = [
 		'description' => 'longtext',
 		'briefdescription' => 'text',
 		'location' => 'location',
@@ -806,7 +806,7 @@ 
 
 	$return[] = \ElggMenuItem::factory([
 		'name' => 'account',
-		'text' => elgg_echo('account') . $toggle,
+		'text' => elgg_echo('account').$toggle,
 		'href' => $href,
 		'priority' => 800,
 		'section' => 'alt',