/jkOptionsFramework

typecho 选项框架

Primary LanguageJavaScriptGNU General Public License v2.0GPL-2.0

jkOptionsFramework

jkOptions Framework

一个适用于 Typecho 的主题和插件的 轻量级 简单 选项框架~

Contents

Installation

下载最新版本

上传自插件目录,并修改目录名为 jkOptionsFramework ,然后启用插件即可。

更多请请查看文档 jkOptions Framework 在线文档

Demo

插件设置自带一个展示Demo

Quick Start

首先根据上面的内容安装插件

打开你的主题的 functions.php 然后粘贴以下代码.

注意: $prefix 必须为你的插件或者主题的目录的名字!!!

// 引入文件
if(!class_exists('CSF')){
    require_once Helper::options()->pluginDir('jkOptionsFramework').'/jkoptions-framework.php';
}

// 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',
      ),

    )
  ) );

}
function themeConfig($form)
{
    $params = [
        'args'=> [
            'framework_title' => 'xxx主题设置',
            'footer_text' => '感谢您使用xxx主题',
        ]
    ];
    CSF::setup('my_framework', $params);
    CSF::setTypechoOptionForm($form);
}

如何获取一个配置的值?

// 引入文件
if (!class_exists('jkOptions')){
    require_once \Utils\Helper::options()->pluginDir('jkOptionsFramework').'/jkOptions.php';
}
$ins = jkOptions::getInstance();
$options = $ins::get_option( 'my_framework' ); // 唯一的识别号

echo $options['opt-text']; // 选项的id
echo $options['opt-textarea']; // 选项的id

// 或者使用避免多级访问产生 warning 的方法
echo $ins::getValue($options, '一级id.二级id') 

Documentation

阅读在线文档获取详细信息: documentation

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 Others
Code Editor Group Repeater Switcher

Support

赞赏记录