This example demonstrates how to use permissions on a Field API field.

This example is a relatively simple text field you can attach to any fieldable entity.

In this module we demonstrate how to limit access to a field. The field API gives you two operations to permit or restrict: view and edit. You can then decide who gets to see fields, who can edit them, and who can manage them.

Our field is called field_permission_example_fieldnote. It has a simple default widget of a text area, and a default formatter that applies a CSS style to make it look like a sticky note.

In addition to demonstrating how to set up permissions-based access to a field, this module also demonstrates the absolute minimum required to implement a field, since it doesn't have any field settings. The tests also have a generalized field-testing class, called FieldTestGeneric, which can be easily subclassed and reused for other fields.

To use this code as skeleton code for a field without permissions, you can simply remove field_permission_example_permission() and field_permission_field_access(). field_permission_example_menu() and _field_permission_example_page() are also vestigial to the Examples project.

How does it work?

You can install this module and go to path /examples/field_permission_example for an introduction on how to use this field. Or see the same content at _field_permission_example_page().

OK, how does the code work?

As with any permission system, we implement hook_permission() in order to define a few permissions. In our case, users will want to either view or edit fieldnote fields. Similarly to the way node permissions work, we'll also include a context of either their own content or any content. That gives us four permissions administrators can assign to various roles. See field_permission_example_permission() for the list.

With our permissions defined in hook_permission(), we can now handle requests for access. Those come in through hook_field_access(), which we've implemented as field_permission_example_field_access(). This function determines whether the user has the ability to view or edit the field in question by calling user_access(). We also give special edit access to users with the 'bypass node access' and 'administer content types' permissions defined by the Node module.

One tricky part is that our field won't always be attached to nodes. It could be attached to any type of entity. This means that there's no general way to figure out if the user "owns" the entity or not. Since this is a simple example, we'll just check for 'any' access to unknown entity types. We'll also limit our known entity types to node and user, since those are easy to demonstrate.

In a real application, we'd have use-case specific permissions which might be more complex than these, or perhaps simpler.

You can see a more complex field implementation in field_example.module.

See also

Example: Field Types API


Field Types API

Field API

Parent topics


modules/examples/field_permission_example/field_permission_example.module, line 7
Hook implementations for the Field Permission Example module.


Namesort descending Location Description
field_permission_example_field_access modules/examples/field_permission_example/field_permission_example.module Implements hook_field_access().
field_permission_example_field_formatter_info modules/examples/field_permission_example/field_permission_example.module Implements hook_field_formatter_info().
field_permission_example_field_formatter_view modules/examples/field_permission_example/field_permission_example.module Implements hook_field_formatter_view().
field_permission_example_field_info modules/examples/field_permission_example/field_permission_example.module Implements hook_field_info().
field_permission_example_field_is_empty modules/examples/field_permission_example/field_permission_example.module Implements hook_field_is_empty().
field_permission_example_field_schema modules/examples/field_permission_example/field_permission_example.install Implements hook_field_schema().
field_permission_example_field_widget_form modules/examples/field_permission_example/field_permission_example.module Implements hook_field_widget_form().
field_permission_example_field_widget_info modules/examples/field_permission_example/field_permission_example.module Implements hook_field_widget_info().
field_permission_example_menu modules/examples/field_permission_example/field_permission_example.module Implements hook_menu().
field_permission_example_permission modules/examples/field_permission_example/field_permission_example.module Implements hook_permission().
_field_permission_example_page modules/examples/field_permission_example/field_permission_example.module A simple page to explain to the developer what to do.


Namesort descending Location Description
GenericFieldTest modules/examples/field_permission_example/tests/field_permission_example.test A generic field testing class.


Namesort descending Location Description
field_permission_example.test modules/examples/field_permission_example/tests/field_permission_example.test Tests for Field Permission Example.