?
Current Path : /home1/savoy/sportsmeet.net/wp-content/themes/livesay/inc/theme-options/cs-framework/ |
Linux gator3171.hostgator.com 4.19.286-203.ELK.el7.x86_64 #1 SMP Wed Jun 14 04:33:55 CDT 2023 x86_64 |
Current File : /home1/savoy/sportsmeet.net/wp-content/themes/livesay/inc/theme-options/cs-framework/README.md |
# Codestar Framework A Lightweight and easy-to-use WordPress Options Framework. It is a free framework for building theme options. Save your time! ## Screenshot [![Codestar Framework Screenshot](http://codestarframework.com/assets/images/framework/screenshot.png)](http://codestarframework.com/assets/images/framework/screenshot-1.png) ## [Documentation](http://codestarframework.com/documentation/) Read the documentation for details [documentation](http://codestarframework.com/documentation/) ## Installation ##### A) Usage as Theme * Download zip file from github repository * Extract download zip on `themename/cs-framework` folder under your theme directory * Add framework include code on your theme `themename/functions.php` file ```php require_once dirname( __FILE__ ) .'/cs-framework/cs-framework.php'; // -(or)- require_once get_template_directory() .'/cs-framework/cs-framework.php'; ``` * Yay! Right now you are ready to configure framework, metaboxes, taxonomies, wp customize, shortcoder * Take a look for config files from `themename/cs-framework/config` folder * Read for more from [documentation](http://codestarframework.com/documentation/) ##### B) Usage as Plugin * Download zip file from github repository * **Way1** Extract download zip on `wp-content/plugins/cs-framework` folder under your plugin directory * **Way2** Upload zip file from `wordpess plugins panel -> add new -> upload plugin` * Active Codestar 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/cs-framework/config` folder also you can manage config files from theme directory. see overriding files method. * Read for more from [documentation](http://codestarframework.com/documentation/) ## Enable - Disable Mods Add define code on your `themename/functions.php` directly. ```php define( 'CS_ACTIVE_FRAMEWORK', true ); // default true define( 'CS_ACTIVE_METABOX', false ); // default true define( 'CS_ACTIVE_TAXONOMY', false ); // default true define( 'CS_ACTIVE_SHORTCODE', false ); // default true define( 'CS_ACTIVE_CUSTOMIZE', false ); // default true ``` or take a look for change define base code from `/cs-framework/cs-framework.php` directly. ## Overriding Files You can override an existing file without change `themename/cs-framework` folder. just create one `themename/cs-framework-override` folder on your theme directory. for eg: ```php themename/cs-framework-override/config/framework.config.php themename/cs-framework-override/functions/constants.php themename/cs-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 ## Donate to the Development You Guys! If you want to see more functions and features for this framework, you can buy me a coffee. I need a lot of it when I am creating new stuff for you. Thank you in advance. ## License Codestar Framework is **free** to use both personal and commercial. If you used commercial, **please credit**. Read more about GNU [license.txt](http://www.gnu.org/licenses/gpl-2.0.txt) ## Credits Thanks for guys! Please read [credits](http://codestarframework.com/credits/). If you would like to contribute please fork the project and [report bugs](https://github.com/Codestar/codestar-framework/issues) or submit [pull requests](https://github.com/Codestar/codestar-framework/pulls)</a>. ## The Latest Updates #### 1.0.1 - Added: Taxonomy options framework - Added: Taxonomy css styles and rtl support - Added: Framework title option in framework config file - Added: Show/Hide option for `Reset All Options` button in framework config file - Added: Helper function for get $_POST/$_GET variables - Added: Metaboxes array support for post_type. see [#99](https://github.com/Codestar/codestar-framework/issues/99) - Added: Fieldset new feature `un_array` option for children element getting by unique id. see [#235](https://github.com/Codestar/codestar-framework/issues/235) - Added: An action `cs_validate_save` for save framework options fields - Added: Background size option for background field - Added: Debug light option for showing element id - Added: Fallback file for avoid missing core functions - Fixed: Background field custom titles (button, dialog etc) issue - Updated: Framework documentation for taxonomy framework and fields - Updated: Font Awesome 4.5.0 icons package - Changed: Menu type names in framework config file. for eg. from `add_menu_page` to `menu` - Improved: Theme Check plugin compatibility - Improved: Dependency script for multiple checkboxes values See [changelog](CHANGELOG.md) --- ##### Using Codestar Framework Themes [![Route Responsive Multi-Purpose WordPress Theme](http://s3.codestarlive.com/route/userbox/route-preview-promo.png)](http://themeforest.net/item/route-responsive-multipurpose-wordpress-theme/8815770?ref=Codestar)