Need help with wordpress-settings-api-class?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

tareq1988
424 Stars 176 Forks 141 Commits 22 Opened issues

Description

A PHP class abstraction that removes all the headaches of the WordPress settings API under the hood and builds a nice options panel on the fly.

Services available

!
?

Need anything else?

Contributors list

# 79,494
PHP
WordPre...
Less
hr
56 commits
# 107,963
Arduino
infrare...
arduino...
Objecti...
15 commits
# 293,442
PHP
WordPre...
Vagrant
HTML
15 commits
# 160,395
PHP
CSS
3 commits
# 477,494
PHP
3 commits
# 141,634
WordPre...
HTML
Less
account...
1 commit
# 62,730
React
Atom
atom-ed...
Swift
1 commit
# 203,597
PHP
WordPre...
Shell
gatsby
1 commit
# 398,040
PHP
CSS
theme-d...
wordpre...
1 commit
# 176,513
WordPre...
PHP
wordpre...
Shell
1 commit
# 453,726
PHP
HTML
1 commit
# 488,351
PHP
nginx
Gulp
Sass
1 commit
# 558,120
PHP
1 commit
# 154,485
PHP
woocomm...
JavaScr...
Symfony
1 commit

What is this?

It's a PHP class wrapper for handling WordPress Settings API. Gives a very handy way to build theme or plugins option panel.

Package Installation (via Composer)

To install this package, edit your

composer.json
file:
{
    "require": {
        "tareq1988/wordpress-settings-api-class": "dev-master"
    }
}

Now run:

$ composer install

Usage Example

Checkout the examples folder for OOP and procedural example. They were called in plugin.php file.

A detailed tutorial can be found here.

Retrieving saved options

/**
 * Get the value of a settings field
 *
 * @param string $option settings field name
 * @param string $section the section name this field belongs to
 * @param string $default default text if it's not found
 *
 * @return mixed
 */
function prefix_get_option( $option, $section, $default = '' ) {

$options = get_option( $section );

if ( isset( $options[$option] ) ) {
    return $options[$option];
}

return $default;

}

Screenshot

Option Panel

Frequently Asked Questions

What this plugin for?

It's mainly a plugin that demonstrates the Settings API PHP class

Whats the facility?

A plugin or theme developer can build their options panel with Settings API easily

What is Settings API ?

Settings API is a functionality from WordPress that helps developers to save their options data very easily and securely. More about Settings API.

Changelog:

v1.3 (27 September, 2016)
------------------------
- [new] Placeholder support for text and textarea input
- [new] min, max and step support for number field
- [fix] Empty multicheck saving warning
- [improved] Don't show the navigation if only one section exists

v1.1 (23 April, 2015)

  • [new] Folder structure updated
  • [new] composer support added
  • [new] Number field added
  • [new] URL field added
  • [improved] wysiwyg field responsive support. Allow to pass options to wp_editor
  • [new] WP Media uploader added

v1.0 (16 July, 2014)

  • [new] color, password and wysiwyg example added on plugin settings
  • [new] Color Picker added
  • [improved] Allow to set description for section
  • Some other old fixes ;)

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.