WPSF Framework

A Lightweight and easy-to-use WordPress Options Framework. It is a free framework for building theme options. Save your time!

Screenshot

Documentation

Read the documentation for details documentation

Note

The Framework still in development stage.

Documentation is still in-progress.

The Framework based on some CodeStar Framework. The fields configs desgin also based on CodeStar Framework.

Installation

A) Usage as Theme

Download zip file from github repository
Extract download zip on themename/wpsf-framework folder under your theme directory
Add framework include code on your theme themename/functions.php file

require_once dirname( __FILE__ ) .'/wpsf-framework/wpsf-framework.php';
// -(or)-
require_once get_template_directory() .'/wpsf-framework/wpsf-framework.php';

Yay! Right now you are ready to configure framework, metaboxes, taxonomies, wp customize, shortcoder
Take a look for config files from themename/wpsf-framework/config folder
Read for more from documentation

B) Usage as Plugin

Download zip file from github repository
Way1 Extract download zip on wp-content/plugins/wpsf-framework folder under your plugin directory
Way2 Upload zip file from wordpess plugins panel -> add new -> upload plugin
Active WPSF Framework plugin from wordpress plugins panel
Yay! Right now you are ready to configure framework, metaboxes, taxonomies, wp customize, shortcoder
Take a look for config files from wp-content/plugins/wpsf-framework/config folder also you can manage config files from theme directory. see overriding files method.
Read for more from documentation

Overriding Files

You can override an existing file without change themename/wpsf-framework folder. just create one themename/wpsf-framework-override folder on your theme directory. for eg:

themename/wpsf-framework-override/config/framework.config.php
themename/wpsf-framework-override/functions/constants.php
themename/wpsf-framework-override/fields/text/text.php

Features

Options Framework
Metabox Framework
Taxonomy Framework
WP Customize Framework
Shortcode Generator
Supports Child Themes
Validate Fields
Sanitize Fields
Localization
Fields Dependencies
Supports Multilangual Fields
Reset/Restore/Export/Import Options
and so much more...

Options Fields

Text
Textarea
Checkbox
Radio
Select
Number
Icons
Group
Image
Upload
Gallery
Sorter
Wysiwyg
Switcher
Background
Color Picker
Multi Checkbox
Checkbox Image Select
Radio Image Select
Typography
Backup
Heading
Sub Heading
Fieldset
Notice
and extendable fields

License

WPSF Framework is free to use both personal and commercial. If you used commercial, please credit. Read more about GNU license.txt

The Latest Updates

0.5Beta

First Version

See changelog

Contributers

@chandrika1892

CSS Libs / Framework Used

Lib/Framework	Repo Link
Animate CSS	daneden/animate.css
MagicInput	jaywcjlove/magic-input

Javascript Libs / Framework Used

Lib/Framework	Repo Link
jQuery Actual	dreamerslab/jquery.actual
Chosen Select	harvesthq/chosen
Select2	select2/select2
Selectize	selectize/selectize
FlatPickr	flatpickr
inputToArray.js	varunsridharan/jquery-inputtoarray
WP JS Hooks	carldanley/WP-JS-Hooks
#### * Note : All Bootstrap Source Taken From V3.3.7
JS Button	Bootstrap
ToolTip	Bootstrap
Popover	Bootstrap
Transition	Bootstrap

Additional Selectize Plugins

Plugin/Theme	Issue Link	Source Code
click_to_edit	Selectize Pull #946	Source Code
condensed_dropdown	Selectize Pull #944	Source Code
dark_theme	Selectize Pull #447	Source Code
bootstrap4_theme	Selectize Issue #905	Source Code

3rd Party Cloned Features

3rdParty	Link
TextLimiter	wpmetabox/text-limiter
Field Columns	Meta Box Columns

wpsf/wpsf-dev