'Codestar Framework by Codestar', 'framework_class' => '', // menu settings 'menu_title' => '', 'menu_slug' => '', 'menu_type' => 'menu', 'menu_capability' => 'manage_options', 'menu_icon' => null, 'menu_position' => null, 'menu_hidden' => false, 'menu_parent' => '', // menu extras 'show_bar_menu' => true, 'show_sub_menu' => true, 'show_network_menu' => true, 'show_in_customizer' => false, 'show_search' => true, 'show_reset_all' => true, 'show_reset_section' => true, 'show_footer' => true, 'show_all_options' => true, 'show_form_warning' => true, 'sticky_header' => true, 'save_defaults' => true, 'ajax_save' => true, // admin bar menu settings 'admin_bar_menu_icon' => '', 'admin_bar_menu_priority' => 80, // footer 'footer_text' => '', 'footer_after' => '', 'footer_credit' => '', // database model 'database' => '', // options, transient, theme_mod, network 'transient_time' => 0, // contextual help 'contextual_help' => array(), 'contextual_help_sidebar' => '', // typography options 'enqueue_webfont' => true, 'async_webfont' => false, // others 'output_css' => true, // theme 'theme' => 'dark', 'class' => '', // external default values 'defaults' => array(), ); // run framework construct public function __construct( $key, $params = array() ) { $this->unique = $key; $this->args = apply_filters( "csf_{$this->unique}_args", wp_parse_args( $params['args'], $this->args ), $this ); $this->sections = apply_filters( "csf_{$this->unique}_sections", $params['sections'], $this ); // run only is admin panel options, avoid performance loss $this->pre_tabs = $this->pre_tabs( $this->sections ); $this->pre_fields = $this->pre_fields( $this->sections ); $this->pre_sections = $this->pre_sections( $this->sections ); $this->get_options(); $this->set_options(); $this->save_defaults(); add_action( 'admin_menu', array( &$this, 'add_admin_menu' ) ); add_action( 'admin_bar_menu', array( &$this, 'add_admin_bar_menu' ), $this->args['admin_bar_menu_priority'] ); add_action( 'wp_ajax_csf_'. $this->unique .'_ajax_save', array( &$this, 'ajax_save' ) ); if( ! empty( $this->args['show_network_menu'] ) ) { add_action( 'network_admin_menu', array( &$this, 'add_admin_menu' ) ); } // wp enqeueu for typography and output css parent::__construct(); } // instance public static function instance( $key, $params = array() ) { return new self( $key, $params ); } public function pre_tabs( $sections ) { $result = array(); $parents = array(); $count = 100; foreach( $sections as $key => $section ) { if( ! empty( $section['parent'] ) ) { $section['priority'] = ( isset( $section['priority'] ) ) ? $section['priority'] : $count; $parents[$section['parent']][] = $section; unset( $sections[$key] ); } $count++; } foreach( $sections as $key => $section ) { $section['priority'] = ( isset( $section['priority'] ) ) ? $section['priority'] : $count; if( ! empty( $section['id'] ) && ! empty( $parents[$section['id']] ) ) { $section['subs'] = wp_list_sort( $parents[$section['id']], array( 'priority' => 'ASC' ), 'ASC', true ); } $result[] = $section; $count++; } return wp_list_sort( $result, array( 'priority' => 'ASC' ), 'ASC', true ); } public function pre_fields( $sections ) { $result = array(); foreach( $sections as $key => $section ) { if( ! empty( $section['fields'] ) ) { foreach( $section['fields'] as $field ) { $result[] = $field; } } } return $result; } public function pre_sections( $sections ) { $result = array(); foreach( $this->pre_tabs as $tab ) { if( ! empty( $tab['subs'] ) ) { foreach( $tab['subs'] as $sub ) { $result[] = $sub; } } if( empty( $tab['subs'] ) ) { $result[] = $tab; } } return $result; } // add admin bar menu public function add_admin_bar_menu( $wp_admin_bar ) { if( ! empty( $this->args['show_bar_menu'] ) && empty( $this->args['menu_hidden'] ) ) { global $submenu; $menu_slug = $this->args['menu_slug']; $menu_icon = ( ! empty( $this->args['admin_bar_menu_icon'] ) ) ? '' : ''; $wp_admin_bar->add_node( array( 'id' => $menu_slug, 'title' => $menu_icon . $this->args['menu_title'], 'href' => ( is_network_admin() ) ? network_admin_url( 'admin.php?page='. $menu_slug ) : admin_url( 'admin.php?page='. $menu_slug ), ) ); if( ! empty( $submenu[$menu_slug] ) ) { foreach( $submenu[$menu_slug] as $key => $menu ) { $wp_admin_bar->add_node( array( 'parent' => $menu_slug, 'id' => $menu_slug .'-'. $key, 'title' => $menu[0], 'href' => ( is_network_admin() ) ? network_admin_url( 'admin.php?page='. $menu[2] ) : admin_url( 'admin.php?page='. $menu[2] ), ) ); } } if( ! empty( $this->args['show_network_menu'] ) ) { $wp_admin_bar->add_node( array( 'parent' => 'network-admin', 'id' => $menu_slug .'-network-admin', 'title' => $menu_icon . $this->args['menu_title'], 'href' => network_admin_url( 'admin.php?page='. $menu_slug ), ) ); } } } public function ajax_save() { if( ! empty( $_POST['data'] ) ) { $_POST = json_decode( stripslashes( $_POST['data'] ), true ); if( wp_verify_nonce( csf_get_var( 'csf_options_nonce'. $this->unique ), 'csf_options_nonce' ) ) { $this->set_options(); wp_send_json_success( array( 'success' => true, 'notice' => $this->notice, 'errors' => $this->errors ) ); } } wp_send_json_error( array( 'success' => false, 'error' => esc_html__( 'Error while saving.', 'bittumb' ) ) ); } // get default value public function get_default( $field, $options = array() ) { $default = ( isset( $this->args['defaults'][$field['id']] ) ) ? $this->args['defaults'][$field['id']] : ''; $default = ( isset( $field['default'] ) ) ? $field['default'] : $default; $default = ( isset( $options[$field['id']] ) ) ? $options[$field['id']] : $default; return $default; } // save defaults and set new fields value to main options public function save_defaults() { $tmp_options = $this->options; foreach( $this->pre_fields as $field ) { if( ! empty( $field['id'] ) ) { $this->options[$field['id']] = $this->get_default( $field, $this->options ); } } if( $this->args['save_defaults'] && empty( $tmp_options ) ) { $this->save_options( $this->options ); } } // set options public function set_options() { if( wp_verify_nonce( csf_get_var( 'csf_options_nonce'. $this->unique ), 'csf_options_nonce' ) ) { $request = csf_get_var( $this->unique, array() ); $transient = csf_get_var( 'csf_transient' ); $section_id = ( ! empty( $transient['section'] ) ) ? $transient['section'] : ''; // import data if( ! empty( $transient['csf_import_data'] ) ) { $import_data = json_decode( stripslashes( trim( $transient['csf_import_data'] ) ), true ); $request = ( is_array( $import_data ) ) ? $import_data : array(); $this->notice = esc_html__( 'Success. Imported backup options.', 'bittumb' ); } else if( ! empty( $transient['reset'] ) ) { foreach( $this->pre_fields as $field ) { if( ! empty( $field['id'] ) ) { $request[$field['id']] = $this->get_default( $field ); } } $this->notice = esc_html__( 'Default options restored.', 'bittumb' ); } else if( ! empty( $transient['reset_section'] ) && ! empty( $section_id ) ) { if( ! empty( $this->pre_sections[$section_id-1]['fields'] ) ) { foreach( $this->pre_sections[$section_id-1]['fields'] as $field ) { if( ! empty( $field['id'] ) ) { $request[$field['id']] = $this->get_default( $field ); } } } $this->notice = esc_html__( 'Default options restored for only this section.', 'bittumb' ); } else { // sanitize and validate foreach( $this->pre_fields as $field ) { if( ! empty( $field['id'] ) ) { // sanitize if( ! empty( $field['sanitize'] ) ) { $sanitize = $field['sanitize']; $value_sanitize = isset( $request[$field['id']] ) ? $request[$field['id']] : ''; $request[$field['id']] = call_user_func( $sanitize, $value_sanitize ); } // validate if( ! empty( $field['validate'] ) ) { $value_validate = isset( $request[$field['id']] ) ? $request[$field['id']] : ''; $has_validated = call_user_func( $field['validate'], $value_validate ); if( ! empty( $has_validated ) ) { $request[$field['id']] = ( isset( $this->options[$field['id']] ) ) ? $this->options[$field['id']] : ''; $this->errors[$field['id']] = $has_validated; } } // auto sanitize if( ! isset( $request[$field['id']] ) || is_null( $request[$field['id']] ) ) { $request[$field['id']] = ''; } } } } // ignore nonce requests if( isset( $request['_nonce'] ) ) { unset( $request['_nonce'] ); } $request = wp_unslash( $request ); $request = apply_filters( "csf_{$this->unique}_save", $request, $this ); do_action( "csf_{$this->unique}_save_before", $request, $this ); $this->options = $request; $this->save_options( $request ); do_action( "csf_{$this->unique}_save_after", $request, $this ); if( empty( $this->notice ) ) { $this->notice = esc_html__( 'Settings saved.', 'bittumb' ); } } return true; } // save options database public function save_options( $request ) { if( $this->args['database'] === 'transient' ) { set_transient( $this->unique, $request, $this->args['transient_time'] ); } else if( $this->args['database'] === 'theme_mod' ) { set_theme_mod( $this->unique, $request ); } else if( $this->args['database'] === 'network' ) { update_site_option( $this->unique, $request ); } else { update_option( $this->unique, $request ); } do_action( "csf_{$this->unique}_saved", $request, $this ); } // get options from database public function get_options() { if( $this->args['database'] === 'transient' ) { $this->options = get_transient( $this->unique ); } else if( $this->args['database'] === 'theme_mod' ) { $this->options = get_theme_mod( $this->unique ); } else if( $this->args['database'] === 'network' ) { $this->options = get_site_option( $this->unique ); } else { $this->options = get_option( $this->unique ); } if( empty( $this->options ) ) { $this->options = array(); } return $this->options; } // wp api: admin menu public function add_admin_menu() { extract( $this->args ); if( $menu_type === 'submenu' ) { $menu_page = call_user_func( 'add_submenu_page', $menu_parent, $menu_title, $menu_title, $menu_capability, $menu_slug, array( &$this, 'add_options_html' ) ); } else { $menu_page = call_user_func( 'add_menu_page', $menu_title, $menu_title, $menu_capability, $menu_slug, array( &$this, 'add_options_html' ), $menu_icon, $menu_position ); if( ! empty( $this->args['show_sub_menu'] ) && count( $this->pre_tabs ) > 1 ) { // create submenus $tab_key = 1; foreach ( $this->pre_tabs as $section ) { call_user_func( 'add_submenu_page', $menu_slug, $section['title'], $section['title'], $menu_capability, $menu_slug .'#tab='. $tab_key, '__return_null' ); if( ! empty( $section['subs'] ) ) { $tab_key += ( count( $section['subs'] )-1 ); } $tab_key++; } remove_submenu_page( $menu_slug, $menu_slug ); } if( ! empty( $menu_hidden ) ) { remove_menu_page( $menu_slug ); } } add_action( 'load-'. $menu_page, array( &$this, 'add_page_on_load' ) ); } public function add_page_on_load() { if( ! empty( $this->args['contextual_help'] ) ) { $screen = get_current_screen(); foreach( $this->args['contextual_help'] as $tab ) { $screen->add_help_tab( $tab ); } if( ! empty( $this->args['contextual_help_sidebar'] ) ) { $screen->set_help_sidebar( $this->args['contextual_help_sidebar'] ); } } add_filter( 'admin_footer_text', array( &$this, 'add_admin_footer_text' ) ); } public function add_admin_footer_text() { $default = 'Thank you for creating with Codestar Framework'; echo ( ! empty( $this->args['footer_credit'] ) ) ? $this->args['footer_credit'] : $default; } public function error_check( $sections, $err = '' ) { if( ! $this->args['ajax_save'] ) { if( ! empty( $sections['fields'] ) ) { foreach( $sections['fields'] as $field ) { if( ! empty( $field['id'] ) ) { if( array_key_exists( $field['id'], $this->errors ) ) { $err = '!'; } } } } if( ! empty( $sections['subs'] ) ) { foreach( $sections['subs'] as $sub ) { $err = $this->error_check( $sub, $err ); } } if( ! empty( $sections['id'] ) && array_key_exists( $sections['id'], $this->errors ) ) { $err = $this->errors[$sections['id']]; } } return $err; } // option page html output public function add_options_html() { $has_nav = ( count( $this->pre_tabs ) > 1 ) ? true : false; $show_all = ( ! $has_nav ) ? ' csf-show-all' : ''; $ajax_class = ( $this->args['ajax_save'] ) ? ' csf-save-ajax' : ''; $sticky_class = ( $this->args['sticky_header'] ) ? ' csf-sticky-header' : ''; $wrapper_class = ( $this->args['framework_class'] ) ? ' '. $this->args['framework_class'] : ''; $theme = ( $this->args['theme'] ) ? ' csf-theme-'. $this->args['theme'] : ''; $class = ( $this->args['class'] ) ? ' '. $this->args['class'] : ''; do_action( 'csf_options_before' ); echo '
'; echo '
'; echo '
'; echo ''; wp_nonce_field( 'csf_options_nonce', 'csf_options_nonce'. $this->unique ); echo '
'; echo '
'; echo '
'; echo '

'. $this->args['framework_title'] .'

'; echo '
'; echo '
'; $notice_class = ( ! empty( $this->notice ) ) ? ' csf-form-show' : ''; $notice_text = ( ! empty( $this->notice ) ) ? $this->notice : ''; echo '
'. $notice_text .'
'; echo ( $this->args['show_form_warning'] ) ? '
'. esc_html__( 'Settings have changed, you should save them!', 'bittumb' ) .'
' : ''; echo ( $has_nav && $this->args['show_all_options'] ) ? '
' : ''; echo ( $this->args['show_search'] ) ? '
' : ''; echo '
'; echo ''; echo ( $this->args['show_reset_section'] ) ? '' : ''; echo ( $this->args['show_reset_all'] ) ? '' : ''; echo '
'; echo '
'; echo '
'; echo '
'; echo '
'; echo '
'; if( $has_nav ) { echo '
'; echo ''; echo '
'; } echo '
'; echo '
'; $section_key = 1; foreach( $this->pre_sections as $section ) { $onload = ( ! $has_nav ) ? ' csf-onload' : ''; $section_icon = ( ! empty( $section['icon'] ) ) ? '' : ''; echo '
'; echo ( $has_nav ) ? '

'. $section_icon . $section['title'] .'

' : ''; echo ( ! empty( $section['description'] ) ) ? '
'. $section['description'] .'
' : ''; if( ! empty( $section['fields'] ) ) { foreach( $section['fields'] as $field ) { $is_field_error = $this->error_check( $field ); if( ! empty( $is_field_error ) ) { $field['_error'] = $is_field_error; } $value = ( ! empty( $field['id'] ) && isset( $this->options[$field['id']] ) ) ? $this->options[$field['id']] : ''; CSF::field( $field, $value, $this->unique, 'options' ); } } else { echo '
'. esc_html__( 'No option provided by developer.', 'bittumb' ) .'
'; } echo '
'; $section_key++; } echo '
'; echo '
'; echo '
'; echo '
'; echo '
'; if( ! empty( $this->args['show_footer'] ) ) { echo '
'; echo '
'; echo ''; echo ( $this->args['show_reset_section'] ) ? '' : ''; echo ( $this->args['show_reset_all'] ) ? '' : ''; echo '
'; echo ( ! empty( $this->args['footer_text'] ) ) ? '
'. $this->args['footer_text'] .'
' : ''; echo '
'; echo '
'; } echo '
'; echo '
'; echo '
'; echo ( ! empty( $this->args['footer_after'] ) ) ? $this->args['footer_after'] : ''; echo '
'; do_action( 'csf_options_after' ); } } }