forked from devinsays/options-framework-plugin
/
readme.txt
executable file
·155 lines (109 loc) · 5 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
=== Options Framework ===
Contributors: Devin Price
Tags: options, theme options
Donate link: http://bit.ly/options-donate
Requires at least: 3.3
Tested up to: 3.4
Stable tag: 1.3
License: GPLv2
== Description ==
The Options Framework Plugin makes it easy to include an options panel in any WordPress theme. It was built so developers can concentrate on making the actual theme rather than spending time creating an options panel from scratch. It's free to use in both commercial and personal projects, just like WordPress itself.
= Options Include =
* text input
* textarea
* checkbox
* select
* radio button
* upload (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
= Learn More =
Please visit [http://wptheming.com/options-framework-plugin](http://wptheming.com/options-framework-plugin) for a full description of how to define and use the theme options.
== Installation ==
If your theme already has options enabled, they will show up under the appearance menu.
If your theme doesn't have options, you can define them to options.php of your theme and they will instantly show up. For more on how to do this, visit [http://wptheming.com/options-framework-plugin](http://wptheming.com/options-framework-plugin).
== Frequently Asked Questions ==
= How do I build options for my own theme? =
Download the development version from GitHub [https://github.com/devinsays/options-framework-plugin](https://github.com/devinsays/options-framework-plugin) and copy the "options-check" folder into your themes directory.
The "Options Check" theme is a blueprint for how to work with options. It includes an example of every option available in the panel and sample output in the theme.
You can also watch the video screencast I have at [http://wptheming.com/options-framework-plugin](http://wptheming.com/options-framework-plugin).
= What options are available to use? =
* text input
* textarea
* checkbox
* select
* radio button
* upload (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)
== Screenshots ==
1. An example of the "Advanced Options" tag in the "Options Check" theme using this plugin.
== Changelog ==
= 1.3 =
* Allow options to save when set by theme customizer
* Added optionsframework_after hook
* Hungarian translations by kardiweb.org
= 1.2 =
* Fix for font_size santization
* Added internationalization support (@weslly)
* Portuguese translations (@weslly)
* Spanish translations (@sksmatt)
* Make uploader post type non-public (@samargulies)
* ID can now be passed on info option for styling purposes
= 1.1 =
* Added support for wp_editor
* Updated textarea settings to allow rows parameter
* Updated cursor:default for h3 metabox, props @yurifedorov
* Filtering of typography options (@mattwiebe)
* Updated methods for typography options
= 1.0 =
* Added filters for entire options array (props @inxilpro)
* Added a filter for options.php location (props @mattwiebe)
* Option header (h4) will not display in panel if name !isset (props @alepee)
= 0.9 =
* Load thickbox using site_url() to allow for https (props @samargulies)
* Change santization to use $allowedposttags for textarea and info
* Display notice if theme doesn't support the Options Framework
* Single checkboxes now use labels
* CSS updates for formatting long labels
* Allows dashes in the options id (props @mantone)
* Uses add_theme_page over add_submenu_page (props @enile8)
= 0.8 =
* Saves tab states using local storage
* Style updates WordPress 3.2 release
* Added sanitization filter for info (of_sanitize_allowedtags)
= 0.7 =
* Added filtering for recognized arrays (like Font Face)
* Using isset rather than !empty to return of_get_option
* Significant updates for setting and restoring defaults
* Background option outputs no-repeat rather than none
= 0.6 =
* Introduces validation filters (props @_mfields)
* Better data sanitization and escaping (props @_mfields)
* Updates labels in options-interface.php
* Changes how checkboxes saved in database ("0" or "1")
* Stores typography, backgrounds and multichecks directly as arrays
* For full description, see: http://wptheming.com/2011/05/options-framework-0-6/
= 0.5 =
* Fixed errors when more than one multicheck options is used
* Updated optionsframework_setdefaults so defaults actually save on first run
* Require that all options have lowercase alphanumeric ids
* Added link to options from the WordPress admin bar
= 0.4 =
* Updated multicheck option to save keys rather than values
* Unset default array options after each output in optionsframework_setdefaults
= 0.3 =
* White listed options for increased security
* Fixed errors with checkbox and select boxes
* Improved the multicheck option and changed format
= 0.2 =
* Uploaded to the WordPress repository
= 0.1 =
* Initial release