Code Monkey home page Code Monkey logo

wpsf's Introduction

WPSF Framework

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

Screenshot

WPSF Framework Screenshot

Documentation

Read the documentation for details documentation

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

wpsf's People

Contributors

varunsridharan avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.