百科.dev
全部条目在线工具AI 编程趋势榜开源项目技术资讯提交条目
登录
< 返回工具列表
W

WordPress-Settings-Framework

> 编程语言
开源

一个用于 WordPress 设置 API 的设置框架

337 stars0 点赞0 次浏览
访问官网GitHub

工具介绍

一个用于 WordPress 设置 API 的设置框架

WordPress Settings Framework

The WordPress Settings Framework aims to take the pain out of creating settings pages for your WordPress plugins by effectively creating a wrapper around the WordPress settings API and making it super simple to create and maintain settings pages.

This repo is actually a working plugin which demonstrates how to implement WPSF in your plugins. See wpsf-test.php for details.

Setting Up Your Plugin

  1. Create a folder "wp-settings-framework" in the root of your plugin folder, containing wp-settings-framework.php and the "assets" folder.
  2. Create a "settings" folder in your plugin root.
  3. Create a settings file in your new "settings" folder (e.g. settings-general.php)

Now you can set up your plugin like:

…

Your settings values can be accessed like so:

php
// Get settings
$this->wpsf->get_settings();

This will get either the saved setting values, or the default values that you set in your settings file.

Or by getting individual settings:

php
// Get individual setting
$setting = wpsf_get_setting( 'prefix_settings_general', 'general', 'text' );

The Settings Files

The settings files work by filling the global $wpsf_settings array with data in the following format:

…

Valid fields values are:

  • id - Field ID
  • title - Field title
  • desc - Field description
  • conditional_desc - Array of conditional field value descriptions (for select)
  • placeholder - Field placeholder
  • type - Field type (text/password/textarea/select/radio/checkbox/checkboxes/color/file/editor/code_editor)
  • default - Default value (or selected option)
  • choices - Array of options (for select/radio/checkboxes)
  • mimetype - Any valid mime type accepted by Code Mirror for syntax highlighting (for code_editor)

See settings/example-settings.php for an example of possible values.

API Details

new WordPressSettingsFramework( string $settings_file [, string $option_group = ''] )

Creates a new settings option_group based on a setttings file.

  • $settings_file - path to the settings file
  • $option_group - optional "option_group" override (by default this will be set to the basename of the settings file)

wpsf_get_setting( $option_group, $section_id, $field_id )

Get a setting from an option group

  • $option_group - option group id.
  • $section_id - section id (change to [{$tab_id}_{$section_id}] when using tabs.
  • $field_id - field id.

wpsf_delete_settings( $option_group )

Delete all the saved settings from a option group

  • $option_group - option group id

Actions & Filters

Filters

  • wpsf_register_settings_[option_group] - The filter used to register your settings. See settings/example-settings.php for an example.
  • [option_group]_settings_validate - Basically the $sanitize_callback from register_setting. Use $wpsf->get_option_group() to get the option group id.
  • wpsf_defaults_[option_group] - Default args for a settings field

Actions

  • wpsf_before_field_[option_group] - Before a field HTML is output
  • wpsf_before_field_[option_group]_[field_id] - Before a field HTML is output
  • wpsf_after_field_[option_group] - After a field HTML is output
  • wpsf_after_field_[option_group]_[field_id] - After a field HTML is output
  • wpsf_before_settings_[option_group] - Before settings form HTML is output
  • wpsf_after_settings_[option_group] - After settings form HTML is output
  • wpsf_before_settings_fields_[option_group] - Before settings form fields HTML is output (inside the ``)
  • wpsf_do_settings_sections_[option_group] - Settings form fields HTMLoutput (inside the ``)
  • wpsf_do_settings_sections_[option_group] - Settings form fields HTMLoutput (inside the ``)
  • wpsf_before_tab_links_[option_group] - Before tabs HTML is output
  • wpsf_after_tab_links_[option_group] - After tabs HTML is output

Credits

The WordPress Settings Framework was created by Gilbert Pellegrom from Dev7studios and maintained by James Kemp from Iconic

Please contribute by reporting bugs and submitting pull requests.

Want to say thanks? Consider tipping me.

Issues· 0 开放

查看全部 Issues在 GitHub 打开

暂无开放 Issues,或尚未同步最近议题。

> 标签

PHP

暂无评论,来聊聊你的看法吧

> 工具信息

发布日期2026年8月1日
最后更新2026年9月18日
分类编程语言
定价开源

> 相关工具

T
TypeScript
JavaScript 的超集,为前端与全栈提供静态类型
P
Python
通用编程语言,广泛用于 Web、数据与 AI
G
Go
Google 推出的简洁高效系统语言