wpsf/wpsf-dev

Clone Of CodeStar but with more powerfull and reliable

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

wpsf-dev's Issues

wpsf - OR condition issue

Conditions in dependency field

 'dependency'   => array( 'footer-left-side|footer-right-side', 'OR|OR', 'custom|custom' ), 

• The above dependency condition working only in AND condition

illegal string offset

once finished configuration wpsf give issues like this

Warning: Illegal string offset 'errors' in D:\xampp\htdocs\projects\clarup\clarup-wp\wp-content\themes\clarup\inc\wpsf-framework\classes\settings.php on line 368

this issue was occured only at first time loaded

How to enable theme light color

How to enable theme light color, there is this option?

Nested Group

Nested group element value is not saved properly and at first click first accordion child group returns more then one accordion which is equal to parent accordion.

Shortcode in settings panel not work

As the title suggests, the "Add Shortcode" button in the textarea section of the "WPSF Modern" control panel does not work.

I think it would be a very useful function. Is it possible to give us an eye and maybe a fix?

A thousand thanks.

Multiple instance and visual composer support

Hi good fork !!
Does it support multiple instance and visual composer ?

taxonomy array

can't declare an array in taxonomy

Missing function

Sorry...my mistake

Select2 Issue in shortcode manager

Select2 not working in shortcode manager
Ref : http://s.svarun.in/kc

Adding wpsf_get_option and wpsf_set_options

This framework lacks two important functions.

wpsf_get_option () and wpsf_set_option ()

Here they are:

if ( ! function_exists( 'wpsf_get_option' ) ) {
	/**
	 * Get option.
	 *
	 * @param  string  $option_name
	 * @param  string  $default
	 * @return mixed|string|null
	 */
	function wpsf_get_option( $option_name = '', $default = '' ) {
		$options = apply_filters( 'wpsf_get_option', get_option( WPSF_OPTION ) );

		if ( ! empty( $option_name ) && ! empty( $options[ $option_name ] ) ) {
			return $options[ $option_name ];
		} else {
			return ( ! empty( $default ) ) ? $default : null;
		}
	}
}

if ( ! function_exists( 'wpff_set_option' ) ) {
	/**
	 * Set option.
	 *
	 * @param  string  $option_name
	 * @param  string  $new_value
	 * @return void
	 */
	function wpsf_set_option( $option_name = '', $new_value = '' )  {
		$options = get_option( WPSF_OPTION );

		if ( ! empty( $option_name ) && ! empty( $options[ $option_name ] ) ) {
			$options[ $option_name ] = $new_value;
			update_option( WPSF_OPTION, $options );
		}
	}
}

Put this function in functions/helpers.php