问题描述
几个月前我已经发布了一个 bug-report(on WordPress trac (Widget Instance Form Update Bug))，我以为我也会在这里尝试写。也许有人比我更好地解决这个问题。
基本上问题是，如果您将一个小工具放入侧栏中，则在您手动按保存 (或重新加载页面) 之前，窗口小工具表单才会更新。
这使得所有来自 form()函数的所有代码都不可用，这些函数依赖于窗口小工具实例 ID 来执行某些操作 (直到按下保存按钮) 。任何像 ajax 请求的东西，像 jQuery 这样的颜色等等都不会立即工作，因为从这个功能来看，这个 widget 实例还没有被初始化。
肮脏的修复将是使用类似 livequery 的方式自动触发保存按钮：
$("#widgets-right .needfix").livequery(function(){
var widget = $(this).closest('div.widget');
wpWidgets.save(widget, 0, 1, 0);
return false;
});
并在 form()中添加.needfix 类，如果该窗口小工具实例未初始化：
<div <?php if(!is_numeric($this->number)): ?>class="needfix"<?php endif; ?>
...
</div>
该解决方案的一个缺点是，如果您注册了很多小工具，浏览器将会吃很多 CPU，因为 DOM 的每次更新都会进行 DOM 查询检查 (我没有专门测试这个，这只是我的假设:)
任何建议，以更好的方式来修复错误？
最佳解决方案
最近我做了类似的事情的战斗。 Ajax 在小工具中不是笑话！需要编写一些非常疯狂的代码来使事情能够跨实例。我不熟悉实时查询，但如果您每秒钟检查 DOM，我可能会为您提供一个不太强烈的解决方案：
var get_widget_id = function ( selector ) {
var selector, widget_id = false;
var id_attr = $( selector ).closest( 'form' ).find( 'input[name="widget-id"]' ).val();
if ( typeof( id_attr ) != 'undefined' ) {
var parts = id_attr.split( '-' );
widget_id = parts[parts.length-1];
}
return parseInt( widget_id );
};
您可以将此函数传递给选择器或 jQuery 对象，并返回当前实例的实例 ID 。我可以找不到其他方法来解决这个问题。很高兴听到我不是唯一的一个:)
次佳解决方案
我不喜欢回答自己的问题，但我觉得这是迄今为止最好的解决方案：
$('#widgets-right').ajaxComplete(function(event, XMLHttpRequest, ajaxOptions){
// determine which ajax request is this (we're after "save-widget")
var request = {}, pairs = ajaxOptions.data.split('&'), i, split, widget;
for(i in pairs){
split = pairs[i].split('=');
request[decodeURIComponent(split[0])] = decodeURIComponent(split[1]);
}
// only proceed if this was a widget-save request
if(request.action && (request.action === 'save-widget')){
// locate the widget block
widget = $('input.widget-id[value="' + request['widget-id'] + '"]').parents('.widget');
// trigger manual save, if this was the save request
// and if we didn't get the form html response (the wp bug)
if(!XMLHttpRequest.responseText)
wpWidgets.save(widget, 0, 1, 0);
// we got an response, this could be either our request above,
// or a correct widget-save call, so fire an event on which we can hook our js
else
$(document).trigger('saved_widget', widget);
}
});
这将触发 widget-save ajax 请求，就在 widget-save 请求完成之后 (如果没有 html 格式的响应) 。
需要在 jQuery(document).ready()功能中添加。
现在，如果你想轻松地将 re-attach 的 JavaScript 函数添加到窗口小工具窗体函数添加的新 DOM 元素中，就可以将它们绑定到”saved_widget” 事件中：
$(document).bind('saved_widget', function(event, widget){
// For example: $(widget).colorpicker() ....
});
第三种解决方案
最近进入这个过程，似乎在传统的”widgets.php” 界面中，任何 javascript 初始化都应该直接运行到现有的小工具 (#widgets-right div) 中，并通过新添加的小工具的 widget-added 事件间接运行; 而在定制器”customize.php” 接口中，所有的 widget(即现有的和新的) 被发送到 widget-added 事件，所以可以在那里进行初始化。基于此，以下是 WP_Widget 类的扩展，它可以通过覆盖一个函数 form_javascript_init()来轻松地将 JavaScript 初始化添加到窗口小工具的窗体中：
class WPSE_JS_Widget extends WP_Widget { // For widgets using javascript in form().
var $js_ns = 'wpse'; // Javscript namespace.
var $js_init_func = ''; // Name of javascript init function to call. Initialized in constructor.
var $is_customizer = false; // Whether in customizer or not. Set on 'load-customize.php' action (if any).
public function __construct( $id_base, $name, $widget_options = array(), $control_options = array(), $js_ns = '' ) {
parent::__construct( $id_base, $name, $widget_options, $control_options );
if ( $js_ns ) {
$this->js_ns = $js_ns;
}
$this->js_init_func = $this->js_ns . '.' . $this->id_base . '_init';
add_action( 'load-widgets.php', array( $this, 'load_widgets_php' ) );
add_action( 'load-customize.php', array( $this, 'load_customize_php' ) );
}
// Called on 'load-widgets.php' action added in constructor.
public function load_widgets_php() {
add_action( 'in_widget_form', array( $this, 'form_maybe_call_javascript_init' ) );
add_action( 'admin_print_scripts', array( $this, 'admin_print_scripts' ), PHP_INT_MAX );
}
// Called on 'load-customize.php' action added in constructor.
public function load_customize_php() {
$this->is_customizer = true;
// Don't add 'in_widget_form' action as customizer sends 'widget-added' event to existing widgets too.
add_action( 'admin_print_scripts', array( $this, 'admin_print_scripts' ), PHP_INT_MAX );
}
// Form javascript initialization code here. "widget" and "widget_id" available.
public function form_javascript_init() {
}
// Called on 'in_widget_form' action (ie directly after form()) when in traditional widgets interface.
// Run init directly unless we're newly added.
public function form_maybe_call_javascript_init( $callee_this ) {
if ( $this === $callee_this && '__i__' !== $this->number ) {
?>
<script type="text/javascript">
jQuery(function ($) {
<?php echo $this->js_init_func; ?>(null, $('#widgets-right [id$="<?php echo $this->id; ?>"]'));
});
</script>
<?php
}
}
// Called on 'admin_print_scripts' action added in constructor.
public function admin_print_scripts() {
?>
<script type="text/javascript">
var <?php echo $this->js_ns; ?> = <?php echo $this->js_ns; ?> || {}; // Our namespace.
jQuery(function ($) {
<?php echo $this->js_init_func; ?> = function (e, widget) {
var widget_id = widget.attr('id');
if (widget_id.search(/^widget-[0-9]+_<?php echo $this->id_base; ?>-[0-9]+$/) === -1) { // Check it's our widget.
return;
}
<?php $this->form_javascript_init(); ?>
};
$(document).on('widget-added', <?php echo $this->js_init_func; ?>); // Call init on widget add.
});
</script>
<?php
}
}
使用以下示例测试小工具：
class WPSE_Test_Widget extends WPSE_JS_Widget {
var $defaults; // Form defaults. Initialized in constructor.
function __construct() {
parent::__construct( 'wpse_test_widget', __( 'WPSE: Test Widget' ), array( 'description' => __( 'Test init of javascript.' ) ) );
$this->defaults = array(
'one' => false,
'two' => false,
'color' => '#123456',
);
add_action( 'admin_enqueue_scripts', function ( $hook_suffix ) {
if ( ! in_array( $hook_suffix, array( 'widgets.php', 'customize.php' ) ) ) return;
wp_enqueue_script( 'wp-color-picker' ); wp_enqueue_style( 'wp-color-picker' );
} );
}
function widget( $args, $instance ) {
extract( $args );
extract( wp_parse_args( $instance, $this->defaults ) );
echo $before_widget, '<p style="color:', $color, ';">', $two ? 'Two' : ( $one ? 'One' : 'None' ), '</p>', $after_widget;
}
function update( $new_instance, $old_instance ) {
$new_instance['one'] = isset( $new_instance['one'] ) ? 1 : 0;
$new_instance['two'] = isset( $new_instance['two'] ) ? 1 : 0;
return $new_instance;
}
function form( $instance ) {
extract( wp_parse_args( $instance, $this->defaults ) );
?>
<div class="wpse_test">
<p class="one">
<input class="checkbox" type="checkbox" <?php checked( $one ); disabled( $two ); ?> id="<?php echo $this->get_field_id( 'one' ); ?>" name="<?php echo $this->get_field_name( 'one' ); ?>" />
<label for="<?php echo $this->get_field_id( 'one' ); ?>"><?php _e( 'One?' ); ?></label>
</p>
<p class="two">
<input class="checkbox" type="checkbox" <?php checked( $two ); disabled( $one ); ?> id="<?php echo $this->get_field_id( 'two' ); ?>" name="<?php echo $this->get_field_name( 'two' ); ?>" />
<label for="<?php echo $this->get_field_id( 'two' ); ?>"><?php _e( 'Two?' ); ?></label>
</p>
<p class="color">
<input type="text" value="<?php echo htmlspecialchars( $color ); ?>" id="<?php echo $this->get_field_id( 'color' ); ?>" name="<?php echo $this->get_field_name( 'color' ); ?>" />
</p>
</div>
<?php
}
// Form javascript initialization code here. "widget" and "widget_id" available.
function form_javascript_init() {
?>
$('.one input', widget).change(function (event) { $('.two input', widget).prop('disabled', this.checked); });
$('.two input', widget).change(function (event) { $('.one input', widget).prop('disabled', this.checked); });
$('.color input', widget).wpColorPicker({
<?php if ( $this->is_customizer ) ?> change: _.throttle( function () { $(this).trigger('change'); }, 1000, {leading: false} )
});
<?php
}
}
add_action( 'widgets_init', function () {
register_widget( 'WPSE_Test_Widget' );
} );
参考文献
注：本文内容整合自 Google/Baidu/Bing 辅助翻译的英文资料结果。如果您对结果不满意，可以加入我们改善翻译效果：薇晓朵技术论坛。