Easy-to-follow video tutorials help you learn software, creative, and business skills.Become a member

Creating a custom permission

From: Drupal 7 Custom Module Development

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.

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.

Show transcript

This video is part of

Image for Drupal 7 Custom Module Development
Drupal 7 Custom Module Development

24 video lessons · 5770 viewers

Jon Peck
Author

 

Start learning today

Get unlimited access to all courses for just $25/month.

Become a member
Sometimes @lynda teaches me how to use a program and sometimes Lynda.com changes my life forever. @JosefShutter
@lynda lynda.com is an absolute life saver when it comes to learning todays software. Definitely recommend it! #higherlearning @Michael_Caraway
@lynda The best thing online! Your database of courses is great! To the mark and very helpful. Thanks! @ru22more
Got to create something yesterday I never thought I could do. #thanks @lynda @Ngventurella
I really do love @lynda as a learning platform. Never stop learning and developing, it’s probably our greatest gift as a species! @soundslikedavid
@lynda just subscribed to lynda.com all I can say its brilliant join now trust me @ButchSamurai
@lynda is an awesome resource. The membership is priceless if you take advantage of it. @diabetic_techie
One of the best decision I made this year. Buy a 1yr subscription to @lynda @cybercaptive
guys lynda.com (@lynda) is the best. So far I’ve learned Java, principles of OO programming, and now learning about MS project @lucasmitchell
Signed back up to @lynda dot com. I’ve missed it!! Proper geeking out right now! #timetolearn #geek @JayGodbold
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.


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.

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 preferences from 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.

Learn more, save more. Upgrade today!

Get our Annual Premium Membership at our best savings yet.

Upgrade to our Annual Premium Membership today and get even more value from your lynda.com subscription:

“In a way, I feel like you are rooting for me. Like you are really invested in my experience, and want me to get as much out of these courses as possible this is the best place to start on your journey to learning new material.”— Nadine H.

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.