WordPress Style Guide: A Reference For Admin UI Components

style-guideWordPress is getting its own style guide. Helen Hou-Sandí is working on a new plugin called WordPress Style Guide to serve as a reference for building WordPress admin UI components. This is very much a work in progress and its purpose will evolve, as Helen notes on the plugin’s github page: “This plugin is not planned to be distributed through the WordPress.org repository, as its anticipated final form will take over a site completely.” The end result will be a guide similar to what you see with front end development frameworks such as Twitter Bootstrap or Zurb Foundation.

So far the plugin includes three sections:

  • jQuery UI Components
  • Forms
  • Helper Classes

These appear in the form of HTML pages within the admin and contain a few rough style examples:

color-helper-classes

This style guide has the potential to greatly improve the way plugin and theme developers create UI components that fit into the WordPress admin. It will also help to speed up that process when developers can quickly get the appropriate styles from the reference.

Custom admin UI done wrong can be a scary thing. How many times have you seen a plugin with visually jarring alerts and mismatched styles in the admin? That Sore Thumb plugin is a hazard to the eyes. If only there was a guide to help put them on the right path. That’s where this project can benefit the community.

Contribution to the WordPress Style Guide is open to all. If you’d like to help build it, feel free to send a pull request and/or leave feedback in the issues queue.

12 Comments


  1. This looks like a great resource. I hope developers will decide to use this instead of recreating the wheel with UI elements that are usually worse than the ones built into WordPress.

    Report


  2. I’ve seen some attempts at something like this previously but honestly other than tearing down some other plugins and seeing how they did the settings page UI… there really hasn’t been a good way for us plugin devs to really know what to do.

    I LOVE that this is happening and that she’s heading it up. If I ever get time away from clients I’m going to look into this plugin to help update my settings page(s).

    Win!

    Report


  3. I’m glad to see the UI documentation getting handled so capably.

    The biggest question I have, as a plugin developer, will be how to integrate custom post/page icons into the admin menu. Right now the actions have an option to add an icon, but I imagine that using fonts will make it a bit more challenging.

    Report


  4. Great idea, some parts of wp-admin HTML are really complex and it takes time to extract them and reuse in plugin, this should save developers a lot of time.

    Report



  5. @Frank – Agree. Style guides should be generic like how you have it in your plugin, not “mp6” prefixed. The prefix will simply become another layer to remove once mp6 is polished. If MP6 gets rolled into core, it will no longer be mp6. Why keep the prefix around?

    Report



Comments are closed.