New Feature: Playlist Center! Pick a topic and let our playlists guide the way.

Start learning with our library of video tutorials taught by experts. Get started

Drupal 7 Custom Module Development
Illustration by

Creating a custom permission


From:

Drupal 7 Custom Module Development

with Jon Peck

Video: Creating a custom permission

Similar to help, permissions can be created with a hook. In particular, Drupal 7 uses hook_permission which applies permissions defined in a module so they can be used from the user permissions page along with granting or restricting who can execute actions. Hook permission returns an array in a standardized format. Looking at the API documentation I can see that hook permissions takes no parameters. So the only thing I need to do is generate the array structure. Though hook_permissions array consists of a key that contains the name of the permission followed by a nested array definition that contains at the minimum two key value pairs.

Watch this entire course now—plus get access to every course in the library. Each course includes high-quality videos taught by expert instructors.

Become a member
please wait ...
Drupal 7 Custom Module Development
2h 57m Advanced Oct 16, 2012

Viewers: in countries Watching now:

Extend your Drupal 7 sites with custom modules, which allow you to create everything from admin interfaces to forms. Author Jon Peck describes how modules extend your base Drupal installation, then walks through how to write your own module with a practical example featuring geo-positioned alternative energy centers. The course also describes how to control access to site features, create new content types, build forms, understand data persistence, embrace coding standards, and much more.

Topics include:
  • Creating your first module
  • Interacting with hooks
  • Working with permissions and roles
  • Controlling access
  • Adding a menu item to an admin interface
  • Using the Form API (FAPI) to quickly create a form
  • Creating custom form validation
  • Manually creating a custom content type
  • Validating user input
  • Importing content using feeds
  • Creating a block
  • Understanding best practices and coding standards
Subjects:
Developer Web CMS Blogs Web Design Programming Languages Web Development
Software:
Drupal
Author:
Jon Peck

Creating a custom permission

Similar to help, permissions can be created with a hook. In particular, Drupal 7 uses hook_permission which applies permissions defined in a module so they can be used from the user permissions page along with granting or restricting who can execute actions. Hook permission returns an array in a standardized format. Looking at the API documentation I can see that hook permissions takes no parameters. So the only thing I need to do is generate the array structure. Though hook_permissions array consists of a key that contains the name of the permission followed by a nested array definition that contains at the minimum two key value pairs.

A title and description each passed through the t function. There are additional options, but they are used internally and rarely. Open the IDE and navigate to the windfarms.module, start with an appropriate doc block for the new hook which implements hook permission. Create a new function named windfarms permission. Hook permission takes no parameters. Next, add a return statement followed by an array definition.

The key is the name of the permission. This is commonly all lowercase with words separated by spaces. I will use administer windfarms as the key followed by a second array definition. In the sub-array I will define the title which will be properly capitalized in human readable. This is displayed in the administrative interfaces. Since this is user-facing, I will wrap the title value in the t function to facilitate translation. Finally, I will add the description.

This is usually a sentence long also wrapped in the t function, and shown in the same administrative interfaces. Perform administrative tasks on Wind Farms functionality. Save the module, return to the browser, and refresh the Permissions page. As you can see, the page does not list the new permission. The reason for this is because the permissions are cached. This is a normal issue encountered when developing in certain areas within Drupal.

A change is made but does not show up immediately. To rectify this, clear the Drupal caches, go to Configuration, and then under Development click Performance, click the button Clear All Caches. Now return to the People page. Then the Permissions tab. The Wind Farms permission will now be shown.

If you're logged in as UID 1, the root user and the first user that was created on the system, then you'll always have this permission. When a module is installed, administrators will be automatically granted the module permissions as well. Since the permission was added after the module was installed, the permission is not granted at this time. To allow other administrators to manage Wind Farms check the box under administrators for the Administer Wind Farms permission, then click Save permissions. Now that roles and permissions have been described and a new permission Administer Wind Farms has been implemented using hook permission, a protected administrative interface can be created for managing custom settings associated with custom functionality in addition to the content itself.

Find answers to the most frequently asked questions about Drupal 7 Custom Module Development.


Expand all | Collapse all
please wait ...
Q: gmap3_tools is not working the way I expected it to. What version of gmap3_tools should I be using?
A: Use the free exercise file containing the version of gmap3_tools used for recording; the published version of the module on drupal.org has changed since recording and is not backwards compatible.
Q: I attempted to run the Drupal site root from the project files, but the site isn't loading. Why not?
A: The Drupal configuration file in sites/default/settings.php contains database configuration specific to the environment used to record the movie. This may be different than your environment. Edit the file and search for "windfarms" - you may need to change the database host, username, password, db name and port to match your specific environment.
 
Share a link to this course

What are exercise files?

Exercise files are the same files the author uses in the course. Save time by downloading the author's files instead of setting up your own files, and learn by following along with the instructor.

Can I take this course without the exercise files?

Yes! If you decide you would like the exercise files later, you can upgrade to a premium account any time.

Become a member Download sample files See plans and pricing

Please wait... please wait ...
Upgrade to get access to exercise files.

Exercise files video

How to use exercise files.

Learn by watching, listening, and doing, Exercise files are the same files the author uses in the course, so you can download them and follow along Premium memberships include access to all exercise files in the library.
Upgrade now


Exercise files

Exercise files video

How to use exercise files.

For additional information on downloading and using exercise files, watch our instructional video or read the instructions in the FAQ.

This course includes free exercise files, so you can practice while you watch the course. To access all the exercise files in our library, become a Premium Member.

join now Upgrade now

Are you sure you want to mark all the videos in this course as unwatched?

This will not affect your course history, your reports, or your certificates of completion for this course.


Mark all as unwatched Cancel

Congratulations

You have completed Drupal 7 Custom Module Development.

Return to your organization's learning portal to continue training, or close this page.


OK
Become a member to add this course to a playlist

Join today and get unlimited access to the entire library of video courses—and create as many playlists as you like.

Get started

Already a member?

Become a member to like this course.

Join today and get unlimited access to the entire library of video courses.

Get started

Already a member?

Exercise files

Learn by watching, listening, and doing! Exercise files are the same files the author uses in the course, so you can download them and follow along. Exercise files are available with all Premium memberships. Learn more

Get started

Already a Premium member?

Exercise files video

How to use exercise files.

Ask a question

Thanks for contacting us.
You’ll hear from our Customer Service team within 24 hours.

Please enter the text shown below:

The classic layout automatically defaults to the latest Flash Player.

To choose a different player, hold the cursor over your name at the top right of any lynda.com page and choose Site preferencesfrom the dropdown menu.

Continue to classic layout Stay on new layout
Exercise files

Access exercise files from a button right under the course name.

Mark videos as unwatched

Remove icons showing you already watched videos if you want to start over.

Control your viewing experience

Make the video wide, narrow, full-screen, or pop the player out of the page into its own window.

Interactive transcripts

Click on text in the transcript to jump to that spot in the video. As the video plays, the relevant spot in the transcript will be highlighted.

Are you sure you want to delete this note?

No

Notes cannot be added for locked videos.

Thanks for signing up.

We’ll send you a confirmation email shortly.


Sign up and receive emails about lynda.com and our online training library:

Here’s our privacy policy with more details about how we handle your information.

Keep up with news, tips, and latest courses with emails from lynda.com.

Sign up and receive emails about lynda.com and our online training library:

Here’s our privacy policy with more details about how we handle your information.

   
submit Lightbox submit clicked
Terms and conditions of use

We've updated our terms and conditions (now called terms of service).Go
Review and accept our updated terms of service.