下面是我正在使用的常规代码设置...
表单(/views/admin.php):
<div class="wrap">
<h2><?php echo esc_html( get_admin_page_title() ); ?></h2>
<form action="options.php" method="post">
<?php
settings_fields( $this->plugin_slug );
do_settings_sections( $this->plugin_slug );
submit_button( 'Save Settings' );
?>
</form>
</div>
对于以下代码,假定add_settings_field()的所有回调和存在add_settings_section(),但“ option_list_selection”除外。
插件管理类(/{plugin_name}-class-admin.php):
namespace wp_plugin_name;
class Plugin_Name_Admin
{
/**
* Note: Some portions of the class code and method functions are missing for brevity
* Let me know if you need more information...
*/
private function __construct()
{
$plugin = Plugin_Name::get_instance();
$this->plugin_slug = $plugin->get_plugin_slug();
$this->friendly_name = $plugin->get_name(); // Get "Human Friendly" presentable name
// Adds all of the options for the administrative settings
add_action( 'admin_init', array( $this, 'plugin_options_init' ) );
// Add the options page and menu item
add_action( 'admin_menu', array( $this, 'add_plugin_admin_menu' ) );
}
public function add_plugin_admin_menu()
{
// Add an Options Page
$this->plugin_screen_hook_suffix =
add_options_page(
__( $this->friendly_name . " Options", $this->plugin_slug ),
__( $this->friendly_name, $this->plugin_slug ),
"manage_options",
$this->plugin_slug,
array( $this, "display_plugin_admin_page" )
);
}
public function display_plugin_admin_page()
{
include_once( 'views/admin.php' );
}
public function plugin_options_init()
{
// Update Settings
add_settings_section(
'maintenance',
'Maintenance',
array( $this, 'maintenance_section' ),
$this->plugin_slug
);
// Check Updates Option
register_setting(
'maintenance',
'plugin-name_check_updates',
'wp_plugin_name\validate_bool'
);
add_settings_field(
'check_updates',
'Should ' . $this->friendly_name . ' Check For Updates?',
array( $this, 'check_updates_field' ),
$this->plugin_slug,
'maintenance'
);
// Update Period Option
register_setting(
'maintenance',
'plugin-name_update_period',
'wp_plugin_name\validate_int'
);
add_settings_field(
'update_frequency',
'How Often Should ' . $this->friendly_name . ' Check for Updates?',
array( $this, 'update_frequency_field' ),
$this->plugin_slug,
'maintenance'
);
// Plugin Option Configurations
add_settings_section(
'category-option-list', 'Widget Options List',
array( $this, 'option_list_section' ),
$this->plugin_slug
);
}
}
某些请求的更新:
将action属性更改为:
<form action="../../options.php" method="post">
...仅导致404错误。以下是Apache日志的摘录。请注意,默认的WordPress脚本和CSS队列已删除:
# Changed to ../../options.php
127.0.0.1 - - [01/Apr/2014:15:59:43 -0400] "GET /wp-admin/options-general.php?page=pluginname-widget HTTP/1.1" 200 18525
127.0.0.1 - - [01/Apr/2014:15:59:43 -0400] "GET /wp-content/plugins/PluginName/admin/assets/css/admin.css?ver=0.1.1 HTTP/1.1" 304 -
127.0.0.1 - - [01/Apr/2014:15:59:43 -0400] "GET /wp-content/plugins/PluginName/admin/assets/js/admin.js?ver=0.1.1 HTTP/1.1" 304 -
127.0.0.1 - - [01/Apr/2014:15:59:52 -0400] "POST /options.php HTTP/1.1" 404 1305
127.0.0.1 - - [01/Apr/2014:16:00:32 -0400] "POST /options.php HTTP/1.1" 404 1305
#Changed to options.php
127.0.0.1 - - [01/Apr/2014:16:00:35 -0400] "GET /wp-admin/options-general.php?page=pluginname-widget HTTP/1.1" 200 18519
127.0.0.1 - - [01/Apr/2014:16:00:35 -0400] "GET /wp-content/plugins/PluginName/admin/assets/css/admin.css?ver=0.1.1 HTTP/1.1" 304 -
127.0.0.1 - - [01/Apr/2014:16:00:35 -0400] "GET /wp-content/plugins/PluginName/admin/assets/js/admin.js?ver=0.1.1 HTTP/1.1" 304 -
127.0.0.1 - - [01/Apr/2014:16:00:38 -0400] "POST /wp-admin/options.php HTTP/1.1" 500 2958
插件类(/{plugin-name}-class.php)
namespace wp_plugin_name;
class Plugin_Name
{
const VERSION = '1.1.2';
const TABLE_VERSION = 1;
const CHECK_UPDATE_DEFAULT = 1;
const UPDATE_PERIOD_DEFAULT = 604800;
protected $plugin_slug = 'pluginname-widget';
protected $friendly_name = 'PluginName Widget';
protected static $instance = null;
private function __construct()
{
// Load plugin text domain
add_action( 'init',
array(
$this,
'load_plugin_textdomain' ) );
// Activate plugin when new blog is added
add_action( 'wpmu_new_blog',
array(
$this,
'activate_new_site' ) );
// Load public-facing style sheet and JavaScript.
add_action( 'wp_enqueue_scripts',
array(
$this,
'enqueue_styles' ) );
add_action( 'wp_enqueue_scripts',
array(
$this,
'enqueue_scripts' ) );
/* Define custom functionality.
* Refer To http://codex.wordpress.org/Plugin_API#Hooks.2C_Actions_and_Filters
*/
}
public function get_plugin_slug()
{
return $this->plugin_slug;
}
public function get_name()
{
return $this->friendly_name;
}
public static function get_instance()
{
// If the single instance hasn't been set, set it now.
if ( null == self::$instance )
{
self::$instance = new self;
}
return self::$instance;
}
/**
* The member functions activate(), deactivate(), and update() are very similar.
* See the Boilerplate plugin for more details...
*
*/
private static function single_activate()
{
if ( !current_user_can( 'activate_plugins' ) )
return;
$plugin_request = isset( $_REQUEST['plugin'] ) ? $_REQUEST['plugin'] : '';
check_admin_referer( "activate-plugin_$plugin_request" );
/**
* Test to see if this is a fresh installation
*/
if ( get_option( 'plugin-name_version' ) === false )
{
// Get the time as a Unix Timestamp, and add one week
$unix_time_utc = time() + Plugin_Name::UPDATE_PERIOD_DEFAULT;
add_option( 'plugin-name_version', Plugin_Name::VERSION );
add_option( 'plugin-name_check_updates',
Plugin_Name::CHECK_UPDATE_DEFAULT );
add_option( 'plugin-name_update_frequency',
Plugin_Name::UPDATE_PERIOD_DEFAULT );
add_option( 'plugin-name_next_check', $unix_time_utc );
// Create options table
table_update();
// Let user know PluginName was installed successfully
is_admin() && add_filter( 'gettext', 'finalization_message', 99, 3 );
}
else
{
// Let user know PluginName was activated successfully
is_admin() && add_filter( 'gettext', 'activate_message', 99, 3 );
}
}
private static function single_update()
{
if ( !current_user_can( 'activate_plugins' ) )
return;
$plugin = isset( $_REQUEST['plugin'] ) ? $_REQUEST['plugin'] : '';
check_admin_referer( "activate-plugin_{$plugin}" );
$cache_plugin_version = get_option( 'plugin-name_version' );
$cache_table_version = get_option( 'plugin-name_table_version' );
$cache_deferred_admin_notices = get_option( 'plugin-name_admin_messages',
array() );
/**
* Find out what version of our plugin we're running and compare it to our
* defined version here
*/
if ( $cache_plugin_version > self::VERSION )
{
$cache_deferred_admin_notices[] = array(
'error',
"You seem to be attempting to revert to an older version of " . $this->get_name() . ". Reverting via the update feature is not supported."
);
}
else if ( $cache_plugin_version === self::VERSION )
{
$cache_deferred_admin_notices[] = array(
'updated',
"You're already using the latest version of " . $this->get_name() . "!"
);
return;
}
/**
* If we can't determine what version the table is at, update it...
*/
if ( !is_int( $cache_table_version ) )
{
update_option( 'plugin-name_table_version', TABLE_VERSION );
table_update();
}
/**
* Otherwise, we'll just check if there's a needed update
*/
else if ( $cache_table_version < TABLE_VERSION )
{
table_update();
}
/**
* The table didn't need updating.
* Note we cannot update any other options because we cannot assume they are still
* the defaults for our plugin... ( unless we stored them in the db )
*/
}
private static function single_deactivate()
{
// Determine if the current user has the proper permissions
if ( !current_user_can( 'activate_plugins' ) )
return;
// Is there any request data?
$plugin = isset( $_REQUEST['plugin'] ) ? $_REQUEST['plugin'] : '';
// Check if the nonce was valid
check_admin_referer( "deactivate-plugin_{$plugin}" );
// We'll, technically the plugin isn't included when deactivated so...
// Do nothing
}
public function load_plugin_textdomain()
{
$domain = $this->plugin_slug;
$locale = apply_filters( 'plugin_locale', get_locale(), $domain );
load_textdomain( $domain,
trailingslashit( WP_LANG_DIR ) . $domain . '/' . $domain . '-' . $locale . '.mo' );
load_plugin_textdomain( $domain, FALSE,
basename( plugin_dir_path( dirname( __FILE__ ) ) ) . '/languages/' );
}
public function activate_message( $translated_text, $untranslated_text,
$domain )
{
$old = "Plugin <strong>activated</strong>.";
$new = FRIENDLY_NAME . " was <strong>successfully activated</strong> ";
if ( $untranslated_text === $old )
$translated_text = $new;
return $translated_text;
}
public function finalization_message( $translated_text, $untranslated_text,
$domain )
{
$old = "Plugin <strong>activated</strong>.";
$new = "Captain, The Core is stable and PluginName was <strong>successfully installed</strong> and ready for Warp speed";
if ( $untranslated_text === $old )
$translated_text = $new;
return $translated_text;
}
}
参考文献:
设置API
add_settings_section()
add_settings_field()
register_setting()
创建选项页面
#1 楼
“错误:未找到选项页”错误这是WP Settings API中的一个已知问题。几年前有一张票被打开,被标记为已解决-但该错误仍然存在于最新版本的WordPress中。这是(现在已删除的)Codex页面关于此内容的内容:
“错误:找不到选项页面”。问题(包括解决方案和说明):
问题是,“ whitelist_options”过滤器
没有为您的数据提供正确的索引。它适用于
options.php#98(WP 3.4)。
register_settings()
将数据添加到$new_whitelist_options。然后,将其与
$whitelist_options
(分别为option_update_filter()
)回调内的全局add_option_whitelist()
合并。这些回调以$new_whitelist_options
作为索引将您的数据添加到全局$option_group
。当您遇到“错误:找不到选项页面”时。这表示您的
索引未被识别。令人误解的是,当实际签入options.php#112发生在
$options_group
(即$options_page
)上时,第一个参数用作索引并名为
$hook_suffix
。 br /> 简而言之,一个简单的解决方案是使
add_submenu_page()
与$option_group
相匹配。导致此错误的另一个原因是调用$option_name
或$page
时add_settings_section( $id, $title, $callback, $page )
参数的值无效。提示:
add_settings_field( $id, $title, $callback, $page, $section, $args )
应该与功能参考/添加主题页中的$page
相匹配。简单修复
使用自定义页面名称(在您的情况下为
$menu_slug
)作为您的部分ID可以解决此问题。但是,所有选项都必须包含在一个部分中。解决方案
要获得更强大的解决方案,请对您的
$this->plugin_slug
类进行以下更改:添加到构造函数:
// Tracks new sections for whitelist_custom_options_page()
$this->page_sections = array();
// Must run after wp's `option_update_filter()`, so priority > 10
add_action( 'whitelist_options', array( $this, 'whitelist_custom_options_page' ),11 );
添加以下方法:
// White-lists options on custom pages.
// Workaround for second issue: http://j.mp/Pk3UCF
public function whitelist_custom_options_page( $whitelist_options ){
// Custom options are mapped by section id; Re-map by page slug.
foreach($this->page_sections as $page => $sections ){
$whitelist_options[$page] = array();
foreach( $sections as $section )
if( !empty( $whitelist_options[$section] ) )
foreach( $whitelist_options[$section] as $option )
$whitelist_options[$page][] = $option;
}
return $whitelist_options;
}
// Wrapper for wp's `add_settings_section()` that tracks custom sections
private function add_settings_section( $id, $title, $cb, $page ){
add_settings_section( $id, $title, $cb, $page );
if( $id != $page ){
if( !isset($this->page_sections[$page]))
$this->page_sections[$page] = array();
$this->page_sections[$page][$id] = $id;
}
}
并更改
Plugin_Name_Admin
调用至:add_settings_section()
。代码上的其他说明
您的表单代码正确。您的表单必须提交给@Chris_O向我指出以及WP设置API文档中所指示的options.php。
名称间隔具有其优点,但它可以使调试更加复杂并降低代码的兼容性(需要PHP> = 5.3,使用自动加载器的其他插件/主题,等等)。因此,如果没有充分的理由为文件命名空间,请不要。您已经通过将代码包装在一个类中来避免命名冲突。使您的类名称更具体,并将您的
$this->add_settings_section()
回调作为公共方法带入该类。 。甚至文件名和路径也不同。您可以将插件迁移到最新版本,但是请注意,此插件样板可能不适合您的需求。它使用通常不鼓励使用的单例。在某些情况下,单例模式是明智的,但这应该是有意识的决定,而不是goto解决方案。评论
很高兴知道api中存在错误。我总是尝试浏览我编写的代码以查找可能会引入的错误。当然,这假设我知道一两件事。
–gate_engineer
2014年4月2日在21:23
对于遇到此问题的任何人:请看一下法典中的OOP示例:codex.wordpress.org/Creating_Options_Pages#Example_.232
–maysi
19年1月30日在22:34
#2 楼
我在寻找同一问题时才发现这篇文章。该解决方案比它看起来的简单得多,因为该文档具有误导性:在register_setting()中,名为$option_group
的第一个参数是您的页面头文件,而不是您要在其中显示设置的部分。上面的代码应使用
// Update Settings
add_settings_section(
'maintenance', // section slug
'Maintenance', // section title
array( $this, 'maintenance_section' ), // section display callback
$this->plugin_slug // page slug
);
// Check Updates Option
register_setting(
$this->plugin_slug, // page slug, not the section slug
'plugin-name_check_updates', // setting slug
'wp_plugin_name\validate_bool' // invalid, should be an array of options, see doc for more info
);
add_settings_field(
'plugin-name_check_updates', // setting slug
'Should ' . $this->friendly_name . ' Check For Updates?', // setting title
array( $this, 'check_updates_field' ), //setting display callback
$this->plugin_slug, // page slug
'maintenance' // section slug
);
评论
这是不正确的。请查看此工作示例(不是我的示例)-gist.github.com/annalinneajohansson/5290405
– Xdg
18年9月3日在18:32
#3 楼
在使用以下选项注册选项页面时:add_submenu_page( string $parent_slug, string $page_title, string $menu_title, string $capability, string $menu_slug, callable $function = '' )
,并在
中注册设置
$option_group
#4 楼
我遇到了相同的错误,但是用不同的方式得到了它:register_setting
的回调// no actual code
// this failed
add_settings_field('id','title', /*callback*/ function($arguments) {
// echo $htmlcode;
register_setting('option_group', 'option_name');
}), 'page', 'section');
我希望这会有所帮助
#5 楼
我几天来也一直在面对这个问题,当我在以下行中添加注释时,此错误已停止:// settings_fields($this->plugin_slug);
.php,但我还不能解决
setting_fields
的问题。评论
我从验证功能中修复了它! ;)
– G.Karles
19年2月15日在12:30
评论
赏金描述报告:“请提供有关最佳做法的一些信息”。在私有构造函数中使用单例并在其中进行一系列操作:不好的做法和难以测试的方法,但这不是您的错。在测试代码后使用../../options.php。
您能显示get_plugin_slug()吗?
@vancoder我已经用相关信息编辑了上面的帖子...
为什么在register_settings中的清理回调中存在反斜杠?我认为那不行。