The Field Permissions module allows site administrators to set field-level
permissions for fields that are attached to any kind of entity (such as nodes
or users).
Permissions can be set for editing or viewing the field (either in all
contexts, or only when it is attached to an entity owned by the current user).
Permissions can also be set for editing the field while creating a new entity.
Permissions for each field are not created by default. Instead, administrators
can enable these permissions explicitly for the fields where this feature is
needed.
Usage
Once Field Permissions module is installed, you need to edit the field settings
form to enable permissions for each field where you need this feature. You can
choose from three options:
- Public (author and administrators can edit, everyone can view)
- Private (only author and administrators can edit and view)
- Custom permissions
The default value ("Public") does not impose any field-level access control,
meaning that permissions are inherited from the entity view or edit
permissions. For example, users who are allowed to view a particular node that
the field is attached to will also be able to view the field.
"Private" provides quick and easy access to a commonly used form of field
access control.
Finally, if "Custom permissions" is chosen, a standard permissions matrix will
be revealed allowing you full flexibility to assign the following permissions
to any role on your site:
- Create own value for field FIELD
- Edit own value for field FIELD
- Edit anyone's value for field FIELD
- View own value for field FIELD
- View anyone's value for field FIELD
These permissions will also be available on the standard permissions page at
Administer > Configuration > User accounts > Permissions (path admin/config/people/permissions).
Installation
-
Copy all contents of this package to your modules directory (or modules/contrib, if you are using a contrib subdirectory), preserving the subdirectory structure.
-
Go to Administer > Functionality to enable the module. If the (Backdrop core) Field UI
module is not enabled, enable it. -
Review the settings of your fields. You will find a new option labeled
"Field visibility and permissions" that allows you to control access to the
field. -
If you chose the setting labeled "Custom permissions", you will be able to
set this field's permissions for any role on your site directly from the
field edit form, or later on by going to the Administer > Configuration > User accounts > Permissions page. -
Get an overview of the Field Permissions at Administer > Reports > Fields > Permissions (path admin/reports/fields/permissions).
Related Modules
The Field Readonly module adds the additional ability to display a field but not allow editing on edit forms.
Issues
Bugs and feature requests should be reported in the Issue Queue.
Current Maintainers
Credits
Original author: markus_petrux
License
This project is GPL v2 software. See the LICENSE.txt file in this directory for
complete text.