Codestar Framework

A Simple and Lightweight WordPress Option Framework for Themes and Plugins. Built in Object Oriented Programming paradigm with high number of custom fields and tons of options. Allows you to bring custom admin, metabox, taxonomy and customize settings to all of your pages, posts and categories. It's highly modern and advanced framework.

Contents

• Demo
• Installation
• Quick Start
• Documentation
• Free vs Premium
• Whats news?
• Support
• Release Notes
• Migrate v1.x to v2.x
• License

Demo

For usage and examples, have a look at 🚀 online demo

Installation

1. Download the installable WordPress plugin zip.
2. Upload and active plugin from WordPress → Plugins → Add New
3. After activation, next step is to configure your settings. You can do it from here ⚙️ configurations

Quick Start

Open your current theme functions.php file and paste this code.

// Check core class for avoid errors
if( class_exists( 'CSF' ) ) {

  // Set a unique slug-like ID
  $prefix = 'my_framework';

  // Create options
  CSF::createOptions( $prefix, array(
    'menu_title' => 'My Framework',
    'menu_slug'  => 'my-framework',
  ) );

  // Create a section
  CSF::createSection( $prefix, array(
    'title'  => 'Tab Title 1',
    'fields' => array(

      // A text field
      array(
        'id'    => 'opt-text',
        'type'  => 'text',
        'title' => 'Simple Text',
      ),

    )
  ) );

  // Create a section
  CSF::createSection( $prefix, array(
    'title'  => 'Tab Title 2',
    'fields' => array(

      // A textarea field
      array(
        'id'    => 'opt-textarea',
        'type'  => 'textarea',
        'title' => 'Simple Textarea',
      ),

    )
  ) );

}

How to get option value ?

$options = get_option( 'my_framework' ); // unique id of the framework

echo $options['opt-text']; // id of the field
echo $options['opt-textarea']; // id of the field

Documentation

Read the documentation for details 📕 documentation

Free vs Premium

Features	Free Version	Premium Version
Admin Option Framework	✔️	✔️
Customize Option Framework	❌	✔️
Metabox Option Framework	❌	✔️
Taxonomy Option Framework	❌	✔️
Shortcode Generate Framework	❌	✔️
Widget Option Framework	❌	✔️
All Option Fields	❌	✔️
Developer Packages	❌	✔️
Unminfy Library	❌	✔️
New Requests	❌	✔️
Autoremove Advertisements	❌	✔️
Life-time access/updates	❌	✔️
		🌟 Upgrade Premium Version

Whats news ?

General

• Added: Multiple instances support
• Added: New option fields
• Added: Filters/Actions for change to configs
• Added: Output css featue
• Added: Auto enqueue/load for google web fonts
• Added: Widget option framework
• Added: Group and Repeater fields nested usage
• Improved: Config array
• Improved: Javascripts
• Improved: PHP Functions/Classes
• Improved: Load time performance

Admin Option Framework

• Added: Framework header title change parameter
• Added: Detailed typography field
• Added: Ajax save options
• Added: Contextual helps option
• Added: Admin bar menu option
• Added: Search options feature
• Added: WPMU Network menu option
• Added: Sticky header
• Added: Save defaults
• Added: Database save data types ( for eg: option, theme_mod, transient, network )

Metabox Option Framework

• Added: Multiple post type support
• Added: Database save data types ( for eg: serialize, unserialize )
• Added: Exclude post types option
• Added: Metabox display to specific page templates. ( for eg default, sidebar-page.php, about-page.php )
• Added: Metabox display to specific post formats. ( for eg standard, aside, gallery, video )
• Added: Restore metabox option button

Customize Option Framework

• Added: Multiple post type support
• Added: Database save data types ( for eg: option, theme_mod )
• Added: Save defaults

Taxonomy Option Framework

• Added: Multiple taxonomy type support
• Added: Database save data types ( for eg: serialize, unserialize )

Shortcode Generate Framework

• Added: Gutenberg support as simply

Available Option Fields

Accordion	Color	Icon	Select	Tabbed
Background	Color Group	Image Select	Slider	Text
Backup	Date	Link Color	Sortable	Textarea
Border	Dimensions	Media	Sorter	Typography
Button Set	Fieldset	Palette	Spacing	Upload
Checkbox	Gallery	Radio	Spinner	WP Editor
Code Editor	Group	Repeater	Switcher	Others

Support

We are provide support forum for premium version users. You can join to support forum for submit any question after purchasing. Free version users support is limited on github.

Release Notes

Check out the release notes

Migrate

Check out the migrate v1.x to v2.x

License

Codestar Framework have two different version. Free version has limited features and offers only admin option panel feature. Premium version offers all extensions and more of settings for the best experience and advanced features. You can bundle the framework ( both free and premium ) in the premium theme/plugin and sell them on your own website or in marketplaces like ThemeForest. This framework is licensed 100% GPL.