Restrict Usernames

Author:Scott Reilly
Version:3.2
Last update:2011-07-14
Compatibility:WP 3.1 – 3.3.2
Comments:go here
Download:[ zip ]
Description:

Restrict the usernames that new users may use when registering for your site.

Extended Description

Restrict the usernames that new users may use when registering for your site.

If open registration is enabled for your site (via Settings -> General -> Membership (“Anyone can register”)), WordPress allows visitors to register for an account on your blog. By default, any username they choose is allowed so long as it isn’t an already existing account and it doesn’t include invalid (i.e. non-alphanumeric) characters.

Possible reasons for wanting to restrict certain usernames:

  • Prevent usernames that contain foul, offensive, or otherwise undesired words
  • Prevent squatting on usernames that you may want to use in the future (but don’t want to actually create the account for just yet) (essentially placing a hold on the username)
  • Prevent official-sounding usernames from being used (i.e. help, support, pr, info, sales)
  • Prevent official username syntax from being used (i.e. if all of your administrators use a prefix to identify themselves, you don’t want a visitor to use that prefix)
  • Prevent spaces from being used in a username (which WordPress allows by default)
  • Require that a username begin, end, or contain one of a set of substrings (i.e. “support_”, “admin_”)

When attempting to register with a restricted username, the visitor will be given an error notice that says:
ERROR: This username is invalid. Please enter a valid username.

NOTE: This plugin does not put any restrictions on usernames that the admin chooses for users when creating user accounts from within the WordPress admin. This only restricts the names that users choose themselves when registering for your site.

Compatible with Multisite and BuddyPress as well.

Links: Plugin Homepage | Plugin Directory Page | Author Homepage

Find out more at the plugin’s WordPress Plugin Repository page.

Screenshots

Click to see full-size image.

  • restrict-usernames screenshot 1

    A screenshot of the plugin’s admin settings page.


Installation

  1. Whether installing or updating, whether this plugin or any other, it is always advisable to back-up your data before starting
  2. Unzip restrict-usernames.zip inside the /wp-content/plugins/ directory for your site (or install via the built-in WordPress plugin installer)
  3. Activate the plugin through the ‘Plugins’ admin menu in WordPress. In Multisite, Network Activate the plugin.
  4. Go to the Users -> Name Restrictions admin settings page (which you can also get to via the Settings link next to the plugin on the Manage Plugins page) and specify username restrictions. On a Multisite install, go to My Sites -> Network Admin -> Users -> Name Restrictions.

Frequently Asked Questions

Q. So if I restrict a username from being registered, does that mean that username can’t be used?
A. No. The plugin only prevents the usernames visitors can use when registering for an account. An admin that has user creation privileges can still create a user account, from within the admin, using any otherwise valid username. Username restrictions don’t apply to admins.

Q. Does this plugin provide any default username restrictions?
A. No.

= If I specify restricted usernames and a required username substring, must all criteria be matched by potential usernames?

Yes.

Q. What if I define username restrictions that some existing user accounts would violate?
A. Nothing happens to those accounts. The plugin does not do anything with existing accounts. Existing usernames are not checked against any username restriction rules; that only happens for accounts being newly registered.

Q. Is this Multisite compatible?
A. Yes.

Q. Is this BuddyPress compatible?
A. Yes, for at least BuddyPress 1.2+ and 1.3+, and perhaps other versions.


Release Log

3.2

  • Add support for Multisite
  • Update plugin framework to 034
  • Remove support for ‘c2c_restrict_usernames’ global
  • Note compatibility through WP 3.3+
  • Drop compatibility with versions of WP older than 3.1
  • Change parent constructor invocation
  • Create ‘lang’ subdirectory and move .pot file into it
  • Regenerate .pot
  • Add ‘Domain Path’ directive to top of main plugin file
  • Add link to plugin directory page to readme.txt
  • Tweak installation instructions in readme.txt
  • Update screenshots for WP 3.3
  • Update copyright date (2012)

3.1

  • Add support for BuddyPress
  • Add bp_members_validate_user_signup()
  • Fix to properly register activation and uninstall hooks
  • Update plugin framework to 023
  • Save a static version of itself in class variable $instance
  • Deprecate use of global variable $c2c_restrict_usernames to store instance
  • Add __construct(), activation()
  • Note deprecation of ‘c2c_restrict_usernames’ global
  • Note compatibility through WP 3.2+
  • Drop support for versions of WP older than 3.0
  • Add more FAQ questions
  • Minor code formatting changes (spacing)
  • Fix plugin homepage and author links in description in readme.txt

3.0.1

  • Update plugin framework to version 021
  • Explicitly declare all class functions public
  • Delete plugin options upon uninstallation
  • Note compatibility through WP 3.1+
  • Update copyright date (2011)

3.0

  • Re-implementation by extending C2C_Plugin_016, which among other things adds support for:
    • Reset of options to default values
    • Better sanitization of input values
    • Offload of core/basic functionality to generic plugin framework
    • Additional hooks for various stages/places of plugin operation
    • Easier localization support
  • Full localization support
  • Fix to display custom error message rather than the incorrect WordPress default validation error message
  • Store plugin instance in global variable, $c2c_restrict_usernames, to allow for external manipulation
  • Rename class from ‘RestrictUsernames’ to ‘c2c_RestrictUsernames’
  • Remove docs from top of plugin file (all that and more are in readme.txt)
  • Note compatibility with WP 2.9+, 3.0+
  • Drop compatibility with versions of WP older than 2.8
  • Add PHPDoc documentation
  • Minor tweaks to code formatting (spacing)
  • Add Upgrade Notice section to readme.txt
  • Remove trailing whitespace
  • Update screenshot
  • Update .pot file

2.0.1

  • Fix to add accidentally omitted get_option_names()

2.0

  • Add option to disallow use of spaces in usernames
  • Add option to allow requirement of any of numerous substrings as part of usernames (including start with and end with requirements)
  • Add reset button to reset options
  • Move initialization of config array out of constructor and into new function load_config()
  • Create init() to handle calling load_textdomain() and load_config() (textdomain must be loaded before initializing config)
  • Return immediately if username being check is already invalid
  • Use strpos() instead of stristr()
  • Changed invocation of plugin’s install function to action hooked in constructor rather than in global space
  • Extract settings saving code into maybe_save_options()
  • Extract settings display code into display_option()
  • Update object’s option buffer after saving changed submitted by user
  • Add support for localization
  • Add .pot file
  • Add PHPDoc documentation
  • Note compatibility with WP 2.9+
  • Drop compatibility with versions of WP older than 2.8
  • Update documentation
  • Update copyright date

1.1

  • Added ‘Settings’ link to plugin’s plugin listing entry
  • Used plugins_url() instead of hardcoded path
  • Noted compatibility with WP2.8+
  • Minor code formatting tweaks

1.0

  • Initial release

Copyright & Disclaimer

Copyright © 2009-2011 by Scott Reilly (aka coffee2code)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.