Jacob Guite-St-Pierre

<p>Allows you to create custom options that you can easily update via the <code>Options</code> administration panel and also allows you to use mentioned options in your theme using a simple PHP function:</p>
<pre><code>get_custom_option ( $slug [, $default_value, $field ] )
</code></pre>
<p>By default, only Administrators can change Custom Options, however you can use the filter <code>gsp_custom_options_capability</code> to change that. For example, if you wish to allow Editors to use Custom Options you can add this to your functions.php file:</p>
<pre><code>function custom_options_capability ($capability) {
    return 'publish_pages';
}
add_filter ( 'gsp_custom_options_capability', 'custom_options_capability' );
</code></pre>
<p>Very simple, yet efficient.</p>


Custom Options

Quickly create, manage and use custom options in your themes!

miunosoft

Michael Uno

pcraig3

<h4>Reduce the Time Spent for Plugin and Theme Development</h4>
<p>One of the time-consuming part of developing WordPress plugins and themes is creating setting pages. As you more and more write plugins and themes, you will soon realize major part of code can be reused. Admin Page Framework aims to provide reusable code that eliminates the necessity of writing repeated code over and over again.</p>
<p>You will have more organized means of building option pages with the framework. Extend the library class and pass your arrays defining the form elements to the predefined class methods. The library handles all the complex coding behind the scene and creates the pages and the forms for you.</p>
<h4>Create Essential Page and Form Components for Your Users</h4>
<ul>
<li><strong>Top-level Page, Sub Pages, and In-page Tabs</strong> – where your users will access to operate your plugin or theme.</li>
<li><strong>Forms</strong> – to let your users store their options.</li>
<li><strong>Custom Post Types</strong> – and the custom columns in the post listing table.</li>
<li><strong>Custom Taxonomies and Fields</strong> – store options associated with a taxonomy in the taxonomy definition page.</li>
<li><strong>Meta Boxes and Fields</strong> – store meta data associated with posts of set post types. Also meta boxes can be added to the pages created with the framework.</li>
<li><strong>Widgets and Fields</strong> – display modular outputs based on the user’s settings in the front end.</li>
<li><strong>Network Admin Pages and Forms</strong> – create admin pages in the newtork admin area of WordPress multi-sites.</li>
</ul>
<h4>Construct Simple Yet Complex Setting Forms</h4>
<ul>
<li><strong>Section Tabs</strong> – form sections can be displayed in a tabbed box.</li>
<li><strong>Collapsible Sections</strong> – form sections can be collapsed and expanded.</li>
<li><strong>Repeatable Sections and Fields</strong> – dynamically add/remove form sections and fields.</li>
<li><strong>Sortable Sections and Fields</strong> – drag and drop form sections and fields to change the order.</li>
<li><strong>Nested Sections and Fields</strong> – nest sections and fields to construct complex forms.</li>
<li><strong>Import and Export Options</strong> – buttons that the user can import and export settings by uploading and downloading text files.</li>
<li><strong>Reset Button</strong> – let your users to initialize the saved options.</li>
<li><strong>Validation and Error Messages</strong> – with the pre-defined validation callbacks, the user’s submitting form data can be verified. Furthermore, by setting the error array, you can display the error message to the user.</li>
<li><strong>Contextual Help Pane</strong> – help information can be added to the contextual help pane that appears at the top right of each screen.</li>
<li><strong>Custom Field Types</strong> – your own field type can be registered. This allows you to design own fields such as a combination of a checkbox with a text field.</li>
<li><strong>Contact Form</strong> – receive emails of user feedback and issue reports sent via the contact form embedded in an admin page.</li>
<li><strong>Tooltips</strong> – add a small pop-up box beside section and field title for the users to read about the option.</li>
</ul>
<h4>Produce a Series of Products with the Framework Extensibility</h4>
<p>If you are planning to create a product possibly extended with an unlimited number of add-ons, take advantage of the framework’s native extensibility. The created admin pages and forms will become highly extensible with the automatically created hooks. In other words, it empowers other developers to customize your plugin or theme. That will result on making your projects grow.</p>
<p>Also, use the framework as a library and your plugin or theme does not have to require an extra dependency to be installed. Therefore, your product will be perfectly portable.</p>
<h4>Built-in Field Types</h4>
<ul>
<li><code>text</code> – a normal field to enter text input.</li>
<li><code>password</code> – a masked text input field.</li>
<li><code>textarea</code> – a text input field with multiple lines. It supports TinyMCE rich text editor.</li>
<li><code>radio</code> – a set of radio buttons that lets the user pick an option.</li>
<li><code>checkbox</code> – a check box that lets the user enable/disable an item.</li>
<li><code>select</code> – a drop-down list that lest the user pick one or more item(s) from a list.</li>
<li><code>hidden</code> – a hidden field that will be useful to insert invisible values.</li>
<li><code>file</code> – a file uploader that lets the user upload files.</li>
<li><code>image</code> – a custom text field with the image uploader script that lets the user set an image URL.</li>
<li><code>media</code> – a custom text field with the media uploader script that lets the user set a file URL.</li>
<li><code>color</code> – a custom text field with the color picker script.</li>
<li><code>submit</code> – a submit button that lets the user send the form.</li>
<li><code>export</code> – a custom submit field that lets the user export the stored data.</li>
<li><code>import</code> – a custom combination field of the file and the submit fields that let the user import data.</li>
<li><code>posttype</code> – a set of check-lists of taxonomies enabled on the site in a tabbed box.</li>
<li><code>taxonomy</code> – check-lists of taxonomies enabled on the site in a tabbed box.</li>
<li><code>size</code> – a combination field of the text and the select fields that let the user set sizes with a selectable unit.</li>
<li><code>section_title</code> – a text field placed in the section title to let the user name the section.</li>
<li><code>system</code> – displays the site system information.</li>
<li><code>inline_mixed</code> – consists of inline elements of fields with different field types.</li>
</ul>
<h4>Bundled Custom Field Types</h4>
<p>With custom field types, you can create more detailed customized field outputs. The demo component includes the following example custom field types.</p>
<ul>
<li><code>sample</code> – a sample custom field type with a JavaScript script.</li>
<li><code>github</code> – displays GitHub buttons.</li>
<li><code>path</code> – lets the user select file paths on the server.</li>
<li><code>toggle</code> – lets the user toggle a switch button.</li>
<li><code>no_ui_slider</code> – lets the user set values between ranges with a slider.</li>
<li><code>select2</code> – lets the user select items from a predefined list which cam be populated with AJAX.</li>
<li><code>post_type_taxonomy</code> – lets the user select taxonomy terms of selected post types.</li>
</ul>
<p>If you want a field type that are not listed here, you can check the <a href="http://admin-page-framework.michaeluno.jp/add-ons/field-type-pack/" rel="nofollow ugc">field type pack</a> or request a new one in the <a href="https://wordpress.org/support/plugin/admin-page-framework" rel="ugc">forum</a>.</p>
<h4>Getting Started</h4>
<p>To get started, go to <strong>Dashboard</strong> -> <strong>Admin Page Framework</strong> -> <strong>About</strong> -> <strong>Getting Started</strong>.</p>
<h4>Demo</h4>
<p>Activate the demo pages to see the possible features of the framework. To activate it, go to <strong>Dashboard</strong> -> <strong>Admin Page Framework</strong> -> <strong>Add Ons</strong> -> <strong>Demo</strong>.</p>
<h4>Documentation</h4>
<ul>
<li><a href="http://admin-page-framework.michaeluno.jp/en/v3/package-AdminPageFramework.AdminPage.html" rel="nofollow ugc">Online Documentation</a></li>
<li><a href="http://admin-page-framework.michaeluno.jp/tutorials/" rel="nofollow ugc">Tutorials</a></li>
</ul>
<p><strong>Notes:</strong> this framework does not do anything by itself. If you are not a developer, you do not need this.</p>
<h4>Use Unique Page Slug</h4>
<p>The framework internally uses the <code>add_submenu_page()</code> function to register sub menu pages. When the same page slug is registered for multiple root pages, only the last registered callback gets triggered. The other ones will be ignored.</p>
<p>This means if you choose a very simple page slug such as <code>about</code> for your plugin/theme’s information page and then if there is another plugin using the same page slug, your users will get either of your page or the other.</p>
<p>To avoid this, make sure to use a unique page slug. One way to do that is to add a prefix like <code>apf_about</code>.</p>
<h4>Use the files generated with the component generator</h4>
<p>There is one thing you need to be careful when you include the framework: the framework version conflicts. Imagine you publish a plugin using the framework v3.4.6 and your plugin user installs a plugin using the framework v3.0.0 which is below your framework version. If the other plugin loads earlier than yours, your plugin may not work properly and vice versa.</p>
<p>There is a way to avoid such a conflict: change the PHP class names of the framework you include. All the class names have the prefix <code>AdminPageFramework</code> so just change it to something like <code>MyPlugin_AdminPageFramework</code>.</p>
<p>Go to <strong>Dashboard</strong> -> <strong>Admin Page Framework</strong> -> <strong>Tools</strong> -> <strong>Generator</strong>. Set the prefix in the option field and download the files.</p>
<p>If you do not modify the framework class names, you are supposed to extend the <code>AdminPageFramework</code> factory class.</p>
<pre><code>class MyAdminPage extends AdminPageFramework {
    ...
}
</code></pre>
<p>When you modify the framework class names, make sure you extend the class with the modified name.</p>
<pre><code>class MyAdminPage extends MyPlugin_AdminPageFramework {
    ...
}
</code></pre>
<p>For more detailed instruction, go to <strong>Dashboard</strong> -> <strong>Admin Page Framework</strong> -> <strong>About</strong> -> <strong>Getting Started</strong>.</p>
<p>By the time WordPress’s minimum required PHP version becomes 5.3 or higher, we can use name spaces then this problem will be solved.</p>
<h4>Change Framework’s System Messages</h4>
<p>The default messages defined by the framework can be changed. For example, when you import a setting with the framework, the setting notice “The options have been updated.” will be displayed.</p>
<p>If you want to change it to something else, modify the <code>oMsg</code> object. It has the <code>aMessages</code> public property array holding all the messages that the framework uses.</p>
<h4>Get comfortable with the ‘attributes’ array argument</h4>
<p>In each field definition array, you can set the <code>attributes</code> arguments which defines the HTML attributes of the field so that you can modify the output of the field by passing attribute values.</p>
<p>The argument accepts the values as an array. Each element represents the attribute’s name and value. The array key corresponds to the name of the attribute and the value to the attribute value.</p>
<p>For example,</p>
<pre><code>array(
    'field_id'      => 'interval',
    'title'         => __( 'Interval', 'task-scheduler' ),
    'type'          => 'number',
    'attributes'    => array(
        'min'   => 0,
        'step'  => 1,
        'max'   => 24,
    ),
),
</code></pre>
<p>In addition, you can change the attributes of the following container elements by setting their key and passing a nested attribute array.</p>
<ul>
<li><code>fieldrow</code> – the <code>td</code> tag element containing the field output.</li>
<li><code>fieldset</code> – the <code>fieldset</code> tag element containing the field output.</li>
<li><code>fields</code> – the <code>div</code> tag element containing the sub-fields and the main field.</li>
<li><code>field</code> – the <code>div</code> tag element containing each field.</li>
</ul>
<p>This submit button will float right.</p>
<pre><code>array(
    'field_id'          => 'submit',
    'type'              => 'submit',
    'save'              => false,
    'value'             => __( 'Save', 'task-scheduler' ),
    'label_min_width'   => 0,
    'attributes'        => array(
        'field' => array(
            'style' => 'float:right; clear:none; display: inline;',
        ),
    ),
)
</code></pre>
<p>For meta box and widget form fields (as they have slightly different styling than generic admin pages),</p>
<pre><code>array(
    'field_id'          => 'submit_in_meta_box',
    'type'              => 'submit',
    'save'              => false,
    'show_title_column' => false,
    'label_min_width'   => 0,
    'attributes'        => array(
        'field' => array(
            'style' => 'float:right; width:auto;',
        ),
    ),
),
</code></pre>
<h4>Change Preview Image Size of the ‘image’ Field Type</h4>
<p>To specify a custom size to the preview element of the <code>image</code> field type, set an attribute array like the below, where 300px is the max width.</p>
<pre><code>array(
    'field_id'      => 'my_image_field_id',
    'title'         => __( 'Image', 'admin-page-framework-demo' ),
    'type'          => 'image',
    'attributes'    => array(
        'preview' => array(
            'style' => 'max-width: 200px;',
        ),
    ),
),
</code></pre>
<h4>Display items of ‘radio’ field type one per line</h4>
<p>To display radio button items one per line, set the <code>label_min_width</code> to <code>100%</code>.</p>
<pre><code>array(
    'field_id'          => 'my_radio_field_id',
    'title'             => __( 'Radio Button', 'admin-page-framework-demo' ),
    'type'              => 'radio',
    'label_min_width'   => '100%',
    'label'             => array(
        'a' => __( 'This is a.', 'admin-page-framework-demo' ),
        'b' => __( 'This is b.', 'admin-page-framework-demo' ),
        'c' => __( 'This is a.', 'admin-page-framework-demo' )c
    ),
),
</code></pre>
<h4>Set default field value</h4>
<p>To set the initial value of a field, use the <code>default</code> argument in the field definition array.</p>
<pre><code>array(
    'field_id'  => 'my_text_field_id',
    'title'     => __( 'My Text Input Field', 'admin-page-framework-demo' ),
    'type'      => 'text',
    'default'   => 'This text will be displayed for the first time that the field is displayed and will be overridden when a user set an own value.',
),
</code></pre>
<h4>Always display a particular value in a field</h4>
<p>The <code>value</code> argument in the definition array can suppress the saved value. This is useful when you want to set a value from a different data source or create a wizard form that stores the data in a custom location.</p>
<pre><code>array(
    'field_id'  => 'my_text_field_id',
    'title'     => __( 'My Text Input Field', 'admin-page-framework-demo' ),
    'type'      => 'text',
    'value'     => 'This will be always set.',
),
</code></pre>
<p>If it is a repeatable field, set values in numerically indexed sub-elements.</p>
<pre><code>array(
    'field_id'      => 'my_text_field_id',
    'title'         => __( 'My Text Input Field', 'admin-page-framework-demo' ),
    'type'          => 'text',
    'repeatable'    => true,
    'value'         => 'the first value',
    array(
        'value' => 'the second value',
    ),
    array(
        'value' => 'the third value',
    ),
),
</code></pre>
<p>Alternately, you may use the <code>options_{instantiated class name}</code> filter to suppress the options so that setting the value argument is not necessary.<br />
See examples, https://gist.github.com/michaeluno/c30713fcfe0d9d45d89f, https://gist.github.com/michaeluno/fcfac27825aa8a35b90f,</p>


Admin Page Framework

Thanks for this awesome plugin! 

For a next release/feature it would be awesome to have the possibility to have subsections/tabs like WooCommerce settings pages for more advanced settings pages.

Love it and keep up the good work!

This is terrific topnotch stuff. Before this, every time I reinvented the wheel on options pages, I came up with a flat tire. By the time it was ready to go it had a lot of patches and spaghetti stuck to the walls.   

But this stuff just works. And my code is clear enough that I can see what I did two years from now.

Offer: If you need a collaborator to work on docs, let me know.

Where have you been all my life, O APF?

Facilitates WordPress plugin and theme development.

Custom Options vs Admin Page Framework