Options Framework Plugin

The Options Framework Plugin makes it easy to include a full featured options panel in any WordPress theme.

Although this plugin is still maintained and secure, the recommended way to add theme options for new themes is to use the Customizer.

Instructions

Download the plugin and activate it on your site.

To learn how to set up the options panel in your own themes, download the Options Check theme from GitHub and use its files as a base. It’s a blueprint for how the Options Framework works with a sample option panel with every type of option you are able to use and a demo of how to display each one on the front end.

Available Options

These are the options available:

  • text
  • textarea
  • checkbox
  • select
  • radio
  • upload (an image uploader)
  • images (use images instead of radio buttons)
  • background (a set of options to define a background)
  • multicheck
  • color (a jquery color picker)
  • typography (a set of options to define typography)
  • editor

There’s also “heading” to define the menu tabs, and “info” if you just want to add some additional information to the panel.

Returning Option Settings

If you look in index.php of the Options Check theme, you’ll see how each option is returned. It should look something like this:

of_get_option( $id,$default );

What if the Options Framework Plugin is not installed?

The neat thing about this plugin is that it isn’t required for your theme to work. Each option should have a default which will be used if the plugin isn’t installed. Take a look at Portfolio Press without the plugin activated to see how it works.

There are a couple ways to let the user know that options are available if the plugin is installed: a notice on theme activation, an auto prompt on activation, notes in the documentation, etc. I’ve left this up to the theme authors to decide how to implement.

Download the Plugin

Download from WordPress Repository
Download Development Version

Additional Tutorials

Future Development

This plugin is not actively developed. If there’s compatibility or bug fixes needed, let me know.

Exporting/Importing Options

If you are exporting SQL databases, this thread might be of interest to you. There’s also a fork of the theme version, where someone built this out: https://github.com/vauvarin/options-framework-theme

Credits

The Options Panel was originally based on the excellent work of Woo Themes and still uses some of their code.

A huge thanks to all the people who helped out on GitHub, including @mfields, @helgatheviking, @celtic7, @samargulies, @mattweibe, @Mamaduka and any others.

Also a big thanks to folks who made donations to pay for a third party code review: Jason Schuller, Mint Idea, Luke McDonald .

663 Responses

  1. aan

    Hi Devin, is this can be used to create plugin options page? I’m trying to implement it as a plugin options page but can’t figuring it out.

    sorry for my bad english.
    regards

  2. I installed this plugin with Portfolio Press, but Theme Options does not appear in the Appearance menu. I’ve tried this numerous times by activating, deactivating, logging in and out and refreshing page. What is wrong. WordPress 4.5.2, PP 2.7.2. Many thanks for any assistance.

  3. I have installed Spacious theme, but Theme Options does not appear in the Appearance menu. How do I get Theme Options into the Appearance menu? I am currently using WordPress 4.5.2. There is also no Customizer only Customize in my Appearance menu.

  4. Thanks for this support page. I am getting the message “Your current theme does not have support for the Options Framework plugin” after switching from a Genesis premium theme to a Theme Forest theme called Lush. Does that merely mean that, as you say above, your plugin is “overkill” for my set-up, please? I have set up a child theme of course. Thanks very much.

  5. Very awesome awesomeness, man. Thank you. What I’m seeing is this:
    When the `options-check` directory is included (and active) as a theme and options-framework plugin is activated, then the Demo Options are available under Appearance -> Them Options.
    When portfolio-press is activated, if options-framework plugin is activated, there is a (harmless) message that the theme does not support options-framework, HOWEVER the (portfolio press) options are available under Appearance -> Customize. For my theme I copied the `extensions` directory from portfolio-press, then added the bottom six lines of (actual) code from it’s funcions.php file to mine, and my theme can hold all the same options. Now all to be done is refine to my needs and show them in the front end. (Header-color already does!). So – you rock! Hard!

  6. When this plugin is active, my Media Files will only appear in list format, I can’t set a featured image, and there are other image problems. I can deactivate, do what I need to, and then reactivate and my changes are there. Any patch or suggestion I’m missing?

Leave a Reply