Roles and Capabilities in WordPress - Revision history

Jamii: /* For Developers */

2014-01-14T23:02:39Z

For Developers

← Older revision		Revision as of 17:02, 14 January 2014
Line 151:		Line 151:

	[[WP User Roles]]		[[WP User Roles]]

			[[Category: WordPress]]

Jamii: /* For Developers */

2013-08-22T17:30:10Z

For Developers

← Older revision		Revision as of 11:30, 22 August 2013
Line 149:		Line 149:

	Useful classes: WP_Role, WP_Roles, WP_User		Useful classes: WP_Role, WP_Roles, WP_User

			[[WP User Roles]]

Jamii: /* For Developers */

2013-06-20T00:45:33Z

For Developers

← Older revision		Revision as of 18:45, 19 June 2013
Line 144:		Line 144:
	# get_role - Get the current user's Role		# get_role - Get the current user's Role
	# remove_role - Remove a role from the master list of Roles		# remove_role - Remove a role from the master list of Roles
	# add_cap - Add a capability		# add_cap - Add a capability to a Role or a User.
	# remove_cap - Remove a capability		# remove_cap - Remove a capability from a Role or a User.
	# current_user_can - Checks if the currently logged in user has a particular capability.		# current_user_can - Checks if the currently logged in user has a particular capability.

	Useful classes: WP_Role, WP_Roles, WP_User		Useful classes: WP_Role, WP_Roles, WP_User

Jamii: /* For Developers */

2013-06-20T00:44:18Z

For Developers

← Older revision		Revision as of 18:44, 19 June 2013
Line 147:		Line 147:
	# remove_cap - Remove a capability		# remove_cap - Remove a capability
	# current_user_can - Checks if the currently logged in user has a particular capability.		# current_user_can - Checks if the currently logged in user has a particular capability.

			Useful classes: WP_Role, WP_Roles, WP_User

Jamii at 00:43, 20 June 2013

2013-06-20T00:43:31Z

← Older revision		Revision as of 18:43, 19 June 2013
Line 1:		Line 1:
			==Standard Roles==

	One of the wonderful things about WordPress is the ability to have different levels of people		One of the wonderful things about WordPress is the ability to have different levels of people
	all working on the web site. This is done by setting users with different levels of authorization.		all working on the web site. This is done by setting users with different levels of authorization.
Line 84:		Line 86:
	[http://codex.wordpress.org/Roles_and_Capabilities Codex Roles & Capabilites]		[http://codex.wordpress.org/Roles_and_Capabilities Codex Roles & Capabilites]

	===Restricting Access to Pages and Posts===		==Restricting Access to Pages and Posts==
	# You can password protect a Post or Page		# You can password protect a Post or Page
	# You can create a Page Template that checks to see if the user is logged in		# You can create a Page Template that checks to see if the user is logged in
	# You can use a Plugin		# You can use a Plugin

	====Password protecting a page====		===Password protecting a page===
	Open a post/page for editing, you'll find '''Visibility''' under the '''Publish''' box.		Open a post/page for editing, you'll find '''Visibility''' under the '''Publish''' box.
	This contains an option to specify '''Password Protect'''.		This contains an option to specify '''Password Protect'''.

	====Create a Page Template====		===Create a Page Template===
	Copy the index.php file to index-protected.php		Copy the index.php file to index-protected.php
	Then add a template header, like below:		Then add a template header, like below:
Line 112:		Line 114:
	Note this is for pages only, not posts.		Note this is for pages only, not posts.

	====Plugins====		===Plugins===
	# '''Members''' - A simple way to look at and create Roles and Capabilities and protect a page/post based on roles.		# '''Members''' - A simple way to look at and create Roles and Capabilities and protect a page/post based on roles.
	# '''Capabilities Manager Enhanced''' - Allows creation of Roles/Capabilities and has a nice layout for viewing this information. Does NOT provide page/post protection. This is Part of a larger system of plugins called Press Permit.		# '''Capabilities Manager Enhanced''' - Allows creation of Roles/Capabilities and has a nice layout for viewing this information. Does NOT provide page/post protection. This is Part of a larger system of plugins called Press Permit.
Line 120:		Line 122:
	# '''Advanced Access Manager''' - Lots of options. All your setup is done within an AAM dashboard, so it's a little counter intuitive. Make backups before playing with it, powerful but a bit confusing.		# '''Advanced Access Manager''' - Lots of options. All your setup is done within an AAM dashboard, so it's a little counter intuitive. Make backups before playing with it, powerful but a bit confusing.
	# '''Press Permit''' - by Agapetry This is a set of plugins that will probably do everything you could want in the way of permissions. It is by the maker of Role Scoper and isn't a free solution. It is complex and there isn't much documentation at this point in time. There is a support forum and the author answers lots of questions. As with AAM, if you want something this complex please set aside some time to play with it and understand it.		# '''Press Permit''' - by Agapetry This is a set of plugins that will probably do everything you could want in the way of permissions. It is by the maker of Role Scoper and isn't a free solution. It is complex and there isn't much documentation at this point in time. There is a support forum and the author answers lots of questions. As with AAM, if you want something this complex please set aside some time to play with it and understand it.

			==Getting Started with Roles and Capabilities==
			I'd recommend installing Members. It's a straight forward way to be able to look at roles and what capabilities make them up. Use the Codex to get a more complete definition of what a capability means. Install other plugins, such as ecommerce plugins and take a look at what roles they add and how those
			roles are constructed.

			===Why do we care?===
			Understanding that Roles are made up of a set of Capabilities will help you out if you
			wind up having odd permission problems with a plugin or a theme.

			Understanding roles can help you understand how WordPress functions. For example: when you login into the Dashboard WordPress builds the page you
			see one piece at at time, asking what capability does this piece of the dashboard require, and does the current user have that capability. This is why the
			dashboard looks so different for a subscriber than for an admin.

			==For Developers==
			Roles and Capabilities are useful tools for theme and plugin developers. Here are a couple of good pointers to get started.
			# [http://codex.wordpress.org/Roles_and_Capabilities Roles_and_Capabilities The Codex on Roles and Capabilites]
			# [http://www.garyc40.com/2010/04/ultimate-guide-to-roles-and-capabilities/ The Ultimate Guide to Roles and Capabilites]

			Functions that are helpful:
			# add_role - Add a role to the master list of Roles
			# get_role - Get the current user's Role
			# remove_role - Remove a role from the master list of Roles
			# add_cap - Add a capability
			# remove_cap - Remove a capability
			# current_user_can - Checks if the currently logged in user has a particular capability.

Jamii: /* Plugins */

2013-06-20T00:29:29Z

Plugins

← Older revision		Revision as of 18:29, 19 June 2013
Line 113:		Line 113:

	====Plugins====		====Plugins====
	# Members - A simple way to look at and create Roles and Capabilities and protect a page/post based on roles.		# '''Members''' - A simple way to look at and create Roles and Capabilities and protect a page/post based on roles.
	# Capabilities Manager Enhanced - Allows creation of Roles/Capabilities and has a nice layout for viewing this information. Does NOT provide page/post protection. This is Part of a larger system of plugins called Press Permit.		# '''Capabilities Manager Enhanced''' - Allows creation of Roles/Capabilities and has a nice layout for viewing this information. Does NOT provide page/post protection. This is Part of a larger system of plugins called Press Permit.
	# User Access Manager - adds protection for pages/posts/categories/menu listings, etc. If you need special Roles/Capabilities you'll need something to create them, i.e. Members or Capabilities Manager Enhanced.		# '''User Access Manager''' - adds protection for pages/posts/categories/menu listings, etc. If you need special Roles/Capabilities you'll need something to create them, i.e. Members or Capabilities Manager Enhanced.
	# S2 Members - Good plugin for pay subscription content protection. The Pro version has many payment gateway interfaces including Paypal Pro and Authorize.net, and the company is very active in support forums and has good customer service.		# '''S2 Members''' - Good plugin for pay subscription content protection. The Pro version has many payment gateway interfaces including Paypal Pro and Authorize.net, and the company is very active in support forums and has good customer service.
	# Role Scoper - Lots of capabilities, but a bit difficult to set up. Written by the person that wrote Press Permit. It's very powerful, but can be confusing. Be sure to reserve plenty of time to play with the various options it provides before deploying it.		# '''Role Scoper''' - Lots of capabilities, but a bit difficult to set up. Written by the person that wrote Press Permit. It's very powerful, but can be confusing. Be sure to reserve plenty of time to play with the various options it provides before deploying it.
	# Advanced Access Manager - Lots of options. All your setup is done within an AAM dashboard, so it's a little counter intuitive. Make backups before playing with it, powerful but a bit confusing.		# '''Advanced Access Manager''' - Lots of options. All your setup is done within an AAM dashboard, so it's a little counter intuitive. Make backups before playing with it, powerful but a bit confusing.
	# Press Permit - by Agapetry This is a set of plugins that will probably do everything you could want in the way of permissions. It is by the maker of Role Scoper and isn't a free solution. It is complex and there isn't much documentation at this point in time. There is a support forum and the author answers lots of questions. As with AAM, if you want something this complex please set aside some time to play with it and understand it.		# '''Press Permit''' - by Agapetry This is a set of plugins that will probably do everything you could want in the way of permissions. It is by the maker of Role Scoper and isn't a free solution. It is complex and there isn't much documentation at this point in time. There is a support forum and the author answers lots of questions. As with AAM, if you want something this complex please set aside some time to play with it and understand it.

Jamii: /* Create a Page Template */

2013-06-20T00:28:26Z

Create a Page Template

← Older revision		Revision as of 18:28, 19 June 2013
Line 111:		Line 111:
	Now you can select '''Protected Content''' as the template for a page and it will be protected.		Now you can select '''Protected Content''' as the template for a page and it will be protected.
	Note this is for pages only, not posts.		Note this is for pages only, not posts.

			====Plugins====
			# Members - A simple way to look at and create Roles and Capabilities and protect a page/post based on roles.
			# Capabilities Manager Enhanced - Allows creation of Roles/Capabilities and has a nice layout for viewing this information. Does NOT provide page/post protection. This is Part of a larger system of plugins called Press Permit.
			# User Access Manager - adds protection for pages/posts/categories/menu listings, etc. If you need special Roles/Capabilities you'll need something to create them, i.e. Members or Capabilities Manager Enhanced.
			# S2 Members - Good plugin for pay subscription content protection. The Pro version has many payment gateway interfaces including Paypal Pro and Authorize.net, and the company is very active in support forums and has good customer service.
			# Role Scoper - Lots of capabilities, but a bit difficult to set up. Written by the person that wrote Press Permit. It's very powerful, but can be confusing. Be sure to reserve plenty of time to play with the various options it provides before deploying it.
			# Advanced Access Manager - Lots of options. All your setup is done within an AAM dashboard, so it's a little counter intuitive. Make backups before playing with it, powerful but a bit confusing.
			# Press Permit - by Agapetry This is a set of plugins that will probably do everything you could want in the way of permissions. It is by the maker of Role Scoper and isn't a free solution. It is complex and there isn't much documentation at this point in time. There is a support forum and the author answers lots of questions. As with AAM, if you want something this complex please set aside some time to play with it and understand it.

Jamii at 00:14, 20 June 2013

2013-06-20T00:14:15Z

← Older revision		Revision as of 18:14, 19 June 2013
Line 82:		Line 82:

	You can find more information on the meanings of each capability in the Codex at		You can find more information on the meanings of each capability in the Codex at
	[http://codex.wordpress.org/Roles_and_Capabilities Codex Roles & Capabilites]		[http://codex.wordpress.org/Roles_and_Capabilities Codex Roles & Capabilites]

			===Restricting Access to Pages and Posts===
			# You can password protect a Post or Page
			# You can create a Page Template that checks to see if the user is logged in
			# You can use a Plugin

			====Password protecting a page====
			Open a post/page for editing, you'll find '''Visibility''' under the '''Publish''' box.
			This contains an option to specify '''Password Protect'''.

			====Create a Page Template====
			Copy the index.php file to index-protected.php
			Then add a template header, like below:
			<?php
			/*
			Template Name: Protected Content
			*/
			?>
			Then, after the wp_header, and before the wp_footer where everything is being displayed, i.e. before the loop, add the following:
			<?php
			if (! is_user_logged_in()) {
			print "Sorry this is protected content\n";
			} else {
			/* the loop */
			}

			Now you can select '''Protected Content''' as the template for a page and it will be protected.
			Note this is for pages only, not posts.

Jamii at 00:05, 20 June 2013

2013-06-20T00:05:07Z

← Older revision		Revision as of 18:05, 19 June 2013
Line 80:		Line 80:
	\| '''X''' \|\| '''X''' \|\| '''X''' \|\| '''X''' \|\| '''X'''		\| '''X''' \|\| '''X''' \|\| '''X''' \|\| '''X''' \|\| '''X'''
	\|}		\|}

			You can find more information on the meanings of each capability in the Codex at
			[http://codex.wordpress.org/Roles_and_Capabilities Codex Roles & Capabilites]

Jamii at 00:03, 20 June 2013

2013-06-20T00:03:50Z

← Older revision		Revision as of 18:03, 19 June 2013
Line 3:		Line 3:
	WordPress does this with a system that is actually quite generic. From a standard installation		WordPress does this with a system that is actually quite generic. From a standard installation
	you get these roles:		you get these roles:
	'''Admin		'''Admin'''
	Editor		'''Editor'''
	Author		'''Author'''
	Contributor		'''Contributor'''
	Subscriber		'''Subscriber'''
	and of course non-logged in consumers of your website.'''		and of course '''non-logged in consumers of your website.'''

	This system can be extended to many other authorization schemes, such as a Members Only		This system can be extended to many other authorization schemes, such as a Members Only