Share!

How To Design And Style Your WordPress Plugin Admin Panel

The great thing about WordPress is that it's highly customizable and flexible. Within a WordPress plugin, almost all of the fields could be change to your desire results. When you are building a WordPress Plugin, chances are there is a need for you to create some admin pages for the users to customize the setting they want.

WordPress admin default has their own CSS style and you can make use of it for your WordPress Plugin Admin Panel if you require one. If you require additional styling for your admin panel, you can also link in an external CSS stylesheet within your plugin.

Below, we'll show you some default WordPress CSS styling and how to link in an external CSS stylesheet.

WordPress Plugin Admin Panel

Basic WordPress Admin Panel

To get started, first you will need to have the markup for the right container, so that your WordPress Plugin admin page will sit nicely at the right side. The rest of the markup will go within the wrap class.

WordPress Div Wrap

Example

<div class='wrap'>Rest of the markup inside here</div>

WordPress Headers And Buttons

If your WordPress Plugin has an admin panel, there's bound to have the need for header and buttons. Header are quite straightforward, as for button design, by declaring a primary-button or secondary-button class you can change the design for the button and the anchor link.

WordPress Headers and Buttons

Example

//Primary Button
<input class=’button-primary’ type=‘submit’ name=‘Save’ value=’<?php _e(‘Save Options’); ?>’ id=’submitbutton’ />

// Secondary Button
<input type='submit' value='<?php _e('Search Attendees'); ?>' class='button-secondary' />

//Link Button
<a class=button-secondary’ href=’#’ title=’All Attendees’>All Attendees</a>

How To Have An Icon For The Header

Having a plain header can be boring, you might want to refer to the list of available WordPress Header Icons below when you are creating a h2 tag for your plugin.

WordPress Header Icons

Example

#1 <div id="icon-edit" class="icon32"></div>
#2 <div id="icon-upload" class="icon32"></div>
#3 <div id="icon-link-manager" class="icon32"></div>
#4 <div id="icon-edit-pages" class="icon32"></div>
#5 <div id="icon-edit-comments" class="icon32"></div>
#6 <div id="icon-themes" class="icon32"></div>
#7 <div id="icon-plugins" class="icon32"></div>
#8 <div id="icon-users" class="icon32"></div>
#9 <div id="icon-tools" class="icon32"></div>
#10 <div id="icon-options-general" class="icon32"></div>

How To Create WordPress Form Fields

Again, you will need some form element like textfield, checkbox or dropdown box, for users to change the settings for your plugin after they have installed.

All the styles for the input, select or textarea form elements are already in place, write your HTML markup and everything will be nicely in place.

WordPress Admin Panel Form

Example

<form method="POST" action="<?php echo $_SERVER['REQUEST_URI']; ?>">
	<ul>
		<li><label for="fname">Family Name (Sir Name)<span> *</span>: </label>
		<input id="fname" maxlength="45" size="10" name="fname" value="" /></li>	
			
		<li><label for="lname">Last Name<span> *</span>: </label>
		<input id="lname" maxlength="45" size="10" name="lname" value="" /></li>
    </ul>
</form

How To Create a WordPress Admin Table View

WordPress has a nice table CSS style you can use if you want to display a list of records in the admin panel.

WordPress Admin Table

Example

<table class="widefat">
<thead>
	<tr>
		<th>RegId</th>
		<th>Name</th>		
		<th>Email</th>
	</tr>
</thead>
<tfoot>
    <tr>
	<th>RegId</th>
	<th>Name</th>
	<th>Email</th>
    </tr>
</tfoot>
<tbody>
   <tr>
     <td><?php echo $regid; ?></td>
     <td><?php echo $name; ?></td>
     <td><?php echo $email; ?></td>
   </tr>
</tbody>
</table>

How To Style Admin Pagination

If you did follow How To Add Pagination Into List Of Records Or WordPress Plugin and did a pagination for your WordPress Plugin. Then it will be nicer if you can style it with the default WordPress Pagination CSS style.

WordPress Pagination Style

Example

<div class='tablenav-pages'>
    //echo out your pagination 
</div>

How To Add In New CSS Style

If the default WordPress Admin CSS is not what you are looking for, you can add in your own CSS.

  1. Create a CSS file inside the same folder of your plugin.
  2. Copy and paste the following code into your main php file of your plugin. Remember to change yourstyle.css to your own CSS file.
  3. Lastly, hook the function to the admin_head.
function admin_register_head() {
	$siteurl = get_option('siteurl');
	$url = $siteurl . '/wp-content/plugins/' . basename(dirname(__FILE__)) . '/yourstyle.css';
	echo "<link rel='stylesheet' type='text/css' href='$url' />\n";
}
add_action('admin_head', 'admin_register_head');

Conclusion

If some of the WordPress Admin default CSS you need and is not covered above, you can always try using Firebug to see the CSS style on other WordPress Admin page or you can create your own CSS for your Plugin.

Have any questions for me? I'd love to hear and learn from you! Leave a comment below.

Advertise with us

Author

Terrance is a versatile web developer and the technical editor at OXP. He enjoys creating functional websites and is particularly engrossed in all the tiny details mixed together to construct great user experiences. He always believe that every web user deserves the best!

  • http://www.magicandy28.com Andy

    Nice~ thank you for shared.

  • http://www.simonfairbairn.com Simon Fairbairn

    Thanks very much for this - real useful stuff.

  • http://sudarmuthu.com Sudar

    Hi, thanks for the great article.

    But the code given in the section "How To Create WordPress Form Fields" doesn't work.

    I checked the admin pages of 2.8.3 and I found that they still use table to structure the form elements and not the ul and li tags as you specified.

  • Sharon

    Thanks for this - it answers my questions exactly.

    The WordPress Codex says get_settings is deprecated. Does this change anything about your example for adding a CSS style?

    • Terrance

      Hi Sharon,

      No it won't change anything, you can use get_option instead of get_settings. It will still work.

      I have also replaced the get_settings. :)

  • http://www.rune-jensen.com/ Rune Jensen

    Cool post. This really helped me a lot developing the SpamTask admin panel and the chart features. Tried to make another style though, but based on the same principles. Thanks.

  • http://juarezpaf.com Juarez P. A. Filho

    Thanks a lot for this great information.

  • Volkan

    Very useful.Thanks.

  • http://think.binarylimit.com Nazmus Sakib

    Really a very nice and useful post. I google several time for this post and at last I found something which will be so helpful for me.

    • http://www.esoftarena.com shohag_aust

      me too sakib vai :D

  • IsmSal

    thanks
    really nice topic :)

    thank you again

  • http://www.nuevocontinentebajio.edu.mx Pablo Federico

    Hi, I have a big question.
    My client send me all the code to insert a plugin to the sidebar.
    I do not know how to integrate it to the theme.
    When I add any widget to the sidebar it shows with a header, a table and a nem, but with this plugin it does not shows but the buttons and images within the plguin, so, I need to show my client´s plugin like all the rest.
    ¿What is missing in the code?
    Thanks.
    <?php
    /*
    Plugin Name: Escolastica login
    Plugin URI: http://www.escolastica.com/
    Description: Login a escolastica
    Author: Alex Cortes
    Version: 1
    */

    function login_widget() {
    echo'

    Alumno
    Padre
    Docente
    Administrador

    ENTRAR

    ';

    }
    function init_login(){
    register_sidebar_widget("Login", "login_widget");
    }
    add_action("plugins_loaded", "init_login");
    ?>

  • http://www.jesseknowles.com Jesse Knowles

    Thanks for the info. One thing to note about your last point in regards to including a css file. You can actually access the directory a lot easier than you have it. Try this...

    $url = plugins_url("myPluginDirectory/admin.css");

    or even

    $url = plugins_url(basename(dirname(__FILE__))."/admin.css");

  • http://www.toptentagesgeld.de/ Tom

    Thanks for this very helpful post. I'm in the middle of creating my first widget for WordPress and had the need to do some of my own styling of the widget admin area. So that last piece of info in your post hit the spot.

  • http://www.jasonbobich.com Jason

    It's hard to find good tutorials on these kind of things... It was really laid out amazingly well with your images and code snippets.

    I'm a theme developer, and I still found it very useful for a couple of things I'm doing with theme options pages.

    The only difficulty I had was the part about adding a CSS file to the admin head. In my case I'm not developing a plugin so I want the CSS link to reflect a file within my theme.

    So, this is what I ended up doing:

    function admin_register_head() {

    echo '';

    }

    add_action('admin_head', 'admin_register_head');

    This kind of funky method was because the "get_option" attribute (as you used in your post) doesn't have a template url option that I know of? And the bloginfo() function prints out the URL. I wasn't sure how to actually retrieve the URL to the theme folder and store in a variable.

    So, if anyone knows a better way to accomplish this feel free to throw it out there, and if not, you can do it the way I did. It's not pretty, but it works :-)

    • http://www.webspin.biz R’phael Spindel

      You can use:

      get_bloginfo() will return the url while bloginfo() echo's it immediately.

      You can also use stylesheet_directory in place of template_url or if you don't want extra overhead of calling a function there should be a constant defined called TEMPLATE_DIRECTORY.

      http://codex.wordpress.org/Template_Tags/bloginfo

  • Keith

    Nice once guys!

    Quick question. How would I go about placing my plugin link in a specific area in the admin panel?

    Basically I have a plugin and add this bit of code to add it to the admin nav panel.

    add_action('admin_menu', 'mytheme_add_admin'); ?>

    If I wanted to create a standalone link menu, what code would I change?

    • http://www.onextrapixel.com Terrance

      Hi Keith,

      You can use:

      add_menu_page('Page title', 'Top-level menu title', 'administrator', 'my-top-level-handle', 'my_magic_function');

      For more detail check out: WordPress Adding Administration Menus

      ;)

  • http://www.wybierzsie.pl JaRo

    Awesome, thanks man :)

  • http://www.navapavan.com/ NavaPavan

    Thanks for sharing.. great tutorial

  • Kaiser

    Nice one! I searched for the icons, so thanks for this.

    Btw: Why not use wp_enqueue_style for the stylesheet? Much easier, no double loading, etc.

  • http://toby.gundry.com.au Toby

    Thanks for the great article. Just wondering, under the heading 'How To Create WordPress Form Fields' you show the label and input feilds being positioned to the left and right inside the li element.

    I'm just wondering if this is supposed to be part of the default WordPress admin styling or if you added a style for this yourself? It sounds like the former from what you've written, however I can't get this to work without adding the styles myself.

    • http://www.onextrapixel.com Terrance

      Hi Toby, the position of the label was floated right. The rest of the styling are default WordPress admin styles.

      • Joshua Ziering

        Hey Terrance,

        I'm floating the labels to the right and its producing weird results. Can we see your exact code for that form?

  • http://www.pclabs.com.tr Gokhan OZTURK

    In addition:

    Settings has been saved.

    Useful for an "updated" message. A yellow bar on the top.

  • http://www.pclabs.com.tr Gokhan OZTURK

    Sorry for my previous message. Forgot that HTML is not allowed

    <div id="message" class="updated">
    <p>Settings has been saved.</p>
    </div>

  • http://www.fabielrodrigues.com.br Fabiel Rodrigues

    Olá, valeu por compartilhar o seu conhecimento, excelente tutorial.

    Obrigado!!

    • http://www.inspiremonkey.com Aidan

      "Hello, thanks for sharing your knowledge, excellent tutorial. Thanks!"

      This is the translation to English.

  • http://www.blogopreneur.com Kian Ann

    Thanks for the great tips! This is awesome stuff!

    I think one of the best ways to learn is to just use firebug to dig into the existing WordPress options pages and see how they do it! :)

  • http://liguoliang.com li guoliang

    I design my pulgin opt page last week under your excellent tutorial
    Thanks very much, so cute and so usefull.

  • http://dashaluna.com Dasha

    Hello,

    I don't understand the example for changing the admin table view ... I want to customize admin table views for couple of my custom post types. Where do I specify a new table structure??

    Would really appreciate any help!
    Thanks.

  • http://www.arslania.com Arslan

    Nice tutorial..

    Thanks a lot.

  • Anthony Sessa

    Really Great article.

  • http://www.cmikavac.net pootzko

    thank you very much, just what I needed.. first I wanted to go and search for all the class and ID tags with firebug, and then thought - hey, maybe someone already documented it. will recommend this post to wp devs I know. =)

  • http://gamervoices.com/ Alan

    Just what I needed to clean up my options pages, thank you!

  • http://wpleet.com wordpress elite

    Thank you for this post i really enjoy going back here to check this post when ever i need it.

  • sabarinathan

    thanks

  • http://www.medicalassistantnow.com medical assistant

    Thanks man, Now I have nice looking admin page. I still need some assistance with my pagination but I almost used all of the formats you listed here.

  • bisong

    nice tut.. this all i need thank you for sharing

  • Adit

    Thank you! very nice article, keep posting!! :P

  • http://www.persimonkaki.com Persimón

    Thanks very useful post, but i would like to use the search field too and shortable columns in the table, you know how do that?

  • http://www.boiteaweb.fr/ BoiteaWeb

    Hi, good post BUT use wp_enqueue_style() ( http://codex.wordpress.org/Function_Reference/wp_enqueue_style ) to add your own CSS.
    Bye

  • http://bdqworks.com Allan

    Thanks for the post, exactly what I was looking for.

  • http://naves.me Daniel Naves

    Very nice my friend ! Thanks!

  • http://bilgispot.blogspot.com Bilgispot

    it's cool design. Thanks...

  • http://www.omnilogic.net/ Jon

    Very useful. Thanks for this.

  • http://taobaogogogo.net sinden

    thanks for the knowledge of friends, now my admin look more attractive.

  • http://www.phpcontext.com Mike

    <form method="POST" action="">

    this code of yours is unacceptable as it can lead to a xss attack

    • http://www.intenseblog.com Jenni

      I don't see in the code? Is there anything wrong?

  • http://www.psdtohtmlfive.com Sam Donga

    Hi,

    Thanks for the post, exactly what I was looking for.

    http://www.psdtohtmlfive.com

    thank you

  • Kuldeep Bansal

    This is one of the best articles so far I have read online. No crap, just useful information. Very well presented. Thanks for sharing with us. I have found another nice post related to this post over the internet which also explained very well, for more details of that post visit the following link....

    http://mindstick.com/Articles/99e1cb14-a0d3-40f4-b5f1-4d7ce9105d1a/?WordPress%20Admin%20Panel

    Thanks everyone for yours nice post.

  • http://www.mojowill.com MojoWill

    Just a quick update regarding adding your own styles. You should register and enqueue your style sheet rather than injecting into the admin head.

    
    
    		function custom_admin_styles() {
    			wp_register_style( 'my-admin-css', 'url_to_my_css/admin.css', null, '1.0', 'screen' );
    			wp_enqueue_style( 'my_admin-css' );
    		}
    
    add_action( 'admin_print_styles', 'custom_admin_styles' );
    
    • n4g_php

      Thanks for the tip, your aproach is better that one sugested on the article.
      Great article by the way.

  • http://vietcoding.com Việt Coding

    That's a great article for WP Admin options developing. It 's useful for me.

    Thanks so much !

  • http://www.wesg.ca Wes G

    Thank you for your tips, I've used them to great success in a number of plugins and websites.

    A tip for pagination, however. Be sure to surround the "tablenav-pages" div element with another div element of class "tablenav". It seems "tablenav-pages" alone isn't enough to style the links. This is on WP 3.3.1.

  • http://www.tech-knowledge.com.au Adam

    Hi!

    Thanks for this! Really great and useful!

    I was wondering if you knew of a list of pre-existing CSS attributes for pluign admin panels

    Like how youve got

    Thanks!

  • http://www.jotorres.com Jorge Torres

    This definately deserves a bookmark! Thanks Terrance for such a great tutorial!

  • http://localhost/wpdemo.com Pratiksha

    This is a very nice site. Good examples of admin side css classes!!!!!!!!

  • http://www.boostingyourbrand.com Jakolien

    Hi there!

    I was given your blog url when I asked my Tweeps for some help. I need to add an icon to my WordPress plugin.

    I have your blog and many others but not quite sure what to do.

    So far I (think #lol) gathered that:

    1. I need to add a custom .css file with the link to the icon file ( no clou what code to put in there though...)

    2. I need to add:

    function admin_register_head() {
    $siteurl = get_option('siteurl');
    $url = $siteurl . '/wp-content/plugins/' . basename(dirname(__FILE__)) . '/yourstyle.css';
    echo "\n";

    Could you help me out with the css for 1.?

    And if I got it right?

    Thanks in advance!!

    Cheers,
    Jakolien

  • http://vanhenkelum.com/ alexef

    Thank you, This is one of the best articles so far I have read online

  • http://progpars.com mahdi khaksar

    very nice , thank :)

  • http://www.WarMarks.com Mohsin Rasool

    Thank you very much for such nice tutorial.
    It will help us improve the admin pages of a plugin we are developing now a days.

    Thanks,
    Mohsin

  • http://www.jqui.net Val

    Excellent article, straight forward many thanks...

  • Rajendra Banker

    Very Useful Tutorial, Thanks.