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

Creating an admin interface

From: WordPress: Creating Custom Widgets and Plugins with PHP

Video: Creating an admin interface

A lot of times plugins are going to require some sort of configuration options. They might require that the site administrator enters something in order that they work properly. For example, if you use some remote service like Twitter or Flicker or Rhapsody, you are going to need their authentication information to go out and get their data. If this is a case with your plugins, you're probably going to want to create an admin interface that plugs directly into WordPress's built-in admin interface. There are three basic steps to do that: The first is we are going to create a function that outputs the user interface, and the second we're going to write another function that uses one of many functions to create a link inside of the Admin menu.

Creating an admin interface

A lot of times plugins are going to require some sort of configuration options. They might require that the site administrator enters something in order that they work properly. For example, if you use some remote service like Twitter or Flicker or Rhapsody, you are going to need their authentication information to go out and get their data. If this is a case with your plugins, you're probably going to want to create an admin interface that plugs directly into WordPress's built-in admin interface. There are three basic steps to do that: The first is we are going to create a function that outputs the user interface, and the second we're going to write another function that uses one of many functions to create a link inside of the Admin menu.

The last thing is we are going to use a hook to tie this in. So let's start at the beginning and write a function that's going to output our Options page. So we'll call it cccom_option_page. I like to give a prefix like cccom whenever I am using functions to keep from collision--that is, interfering with other functions in the WordPress environment. So in here is going to be user interface. So I am going to close the PHP that's opened at the top of the page, and I am just going to open another one for the rest of the page.

That way, in between, I can just use straight HTML. So I am going to create a div first and use the wrap class, which is just a built-in style inside of WordPress. Then I am going to use the special function called screen_icon, which will output the special icon from whichever of the admin items is currently being viewed. I will create a little header, and I will create a quick description.

So I am basically going to say, "Welcome to the CC Comments plugin. Here you can edit the e-mail(s) to CC." All right, it's a dangling preposition, but we're not going to pick nits here. So that's a basic function; it outputs a really basic UI. Like I said, we'll add the input fields in the updating process later. Then we want to create another function, and this function is going to register with the Admin menu.

There are a number of different functions available, which we will explore in a later video. For this one, we are going to add it right into the Settings options. So we are going to use a special function called add_options_page, and then we are going to pass the page title. We are going to pass what we want to see in the menu. We are going to pass the capabilities. This is essentially the roles from the user information.

WordPress has a bunch of information on the Codex about the different types of capabilities there are. It lists them all, and you can see which ones apply to whom and what they mean exactly here. Let's just set it to Manage Options. Then we are going to add a special menu slug that's essentially going to be like an ID for the menu item. So we'll call it cc-comments-plugin. And the last thing we'll add is a link to the function that generates the page, which is this one here. So let's go ahead and copy it.

I often have typing problems, so I like to just copy and paste when I can. So this will register that item with an Admin menu. So the last thing we need to do is make sure that this function gets called for the right hook. So add_action-- should look familiar by now--called admin_menu, and it's going to call this function right here. So that's all it takes. We added this action, which when it generates the admin menu, WordPress will then call this function, which will add this information to the Options portion of the administrator.

When the user clicks on it, it will then call this function, which will open this and use this to generate the screen. So let's see how that looks. So here is our WordPress dashboard. Right now, I don't have any link in here, so let's go ahead and refresh it. You can see now I have the CC Comments down here. When I clicked on it, it called the CC Comments Options, and it said, "Welcome to the CC Comments plugin." Notice this is what I got from the screen icon. So you can see it adds it under the Settings menu-- that's because I use Add Options page-- and then it generated this page, and it used the screen icon to generate this.

If I were to move this to a different section, it would use the appropriate icon. That's why that's a great and helpful function. Many WordPress plugins require that the administrator does some kind of adding in order for it to work. Creating your own page in the WordPress admin is a matter of writing a function that will output the page, writing another function that's going to place a link into one of these menus, and then finally adding a hook into an admin menu.

Show transcript

This video is part of

Image for WordPress: Creating Custom Widgets and Plugins with PHP
 
Expand all | Collapse all
  1. 1m 49s
    1. Welcome
      1m 16s
    2. Using the exercise files
      33s
  2. 23m 29s
    1. WordPress overview
      2m 32s
    2. Installing WPI for Windows
      3m 42s
    3. Installing MAMP for the Mac
      3m 25s
    4. Installing and configuring WordPress
      5m 51s
    5. Comparing WordPress 3.0 with previous versions
      2m 57s
    6. Setting up a PHP/WordPress development environment
      5m 2s
  3. 14m 47s
    1. Exploring WordPress plugins
      3m 42s
    2. Administering plugins from the WordPress admin
      5m 23s
    3. Exploring where plugins reside
      2m 51s
    4. Introduction to hooks
      2m 51s
  4. 39m 28s
    1. Creating the plugin PHP file(s)
      3m 12s
    2. More on hooks: Actions and filters
      3m 15s
    3. Installation and activation
      4m 6s
    4. Writing activation code
      3m 45s
    5. Writing an action
      5m 12s
    6. Writing a filter
      4m 15s
    7. About pluggable functions
      2m 1s
    8. Writing a pluggable function
      5m 30s
    9. Using template tags
      2m 46s
    10. Introducing shortcode
      5m 26s
  5. 26m 2s
    1. Widgets and the WordPress Widgets SubPanel
      2m 54s
    2. Comparing widgets and plugins
      1m 8s
    3. Using and customizing built-in widgets
      3m 18s
    4. Creating a new widget
      7m 21s
    5. Writing the constructor and registering widgets
      5m 20s
    6. Enabling configuration of widgets
      6m 1s
  6. 44m 59s
    1. Creating an admin interface
      5m 25s
    2. Saving data to the database
      5m 39s
    3. Securing form submission with nonces
      2m 25s
    4. Options editing post-WordPress 2.7
      4m 8s
    5. Integrating with the WordPress admin menus
      3m 34s
    6. WordPress admin dashboard API
      4m 5s
    7. Using existing options and option editing pages in WordPress
      5m 19s
    8. Using jQuery and AJAX for administration
      14m 24s
  7. 27m 13s
    1. Accessing the WordPress database
      5m 45s
    2. Using the built-in schema
      2m 21s
    3. Accessing data using $wpdb
      5m 15s
    4. Creating new tables
      7m 18s
    5. Inserting data
      6m 34s
  8. 26m 27s
    1. Introducing the Loop
      6m 22s
    2. Using WP_Query()
      3m 11s
    3. Custom filtering and sticky posts
      4m 58s
    4. Using jQuery and AJAX for posts and pages
      11m 56s
  9. 12m 9s
    1. Registering and promoting plugins
      2m 28s
    2. Creating an uninstall function
      5m 53s
    3. Backward compatibility issues
      3m 48s
  10. 15m 3s
    1. Understanding security issues
      11m 20s
    2. Internationalizing your plugin
      3m 43s
  11. 18s
    1. Goodbye
      18s

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.

Join now "Already a member? Log in

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 WordPress: Creating Custom Widgets and Plugins with PHP.

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

Your file was successfully uploaded.

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.