web-dev-qa-db-ja.com

ドラッグアンドドロップ後にウィジェットフォームを更新する（WP保存バグ）

私は数ヶ月前にこれについてのバグレポートを投稿しました（ WordPressのtrac（Widget Instance Form Update Bug） ）。私もこれについて書きたいと思いました。多分誰かが私よりもこの問題に対するより良い解決策を持っています。

基本的に問題は、ウィジェットをサイドバーにドロップした場合、手動で保存を押す（またはページを再読み込みする）までウィジェットフォームが更新されないことです。

これにより、ウィジェットのインスタンスIDに依存して何かを実行するform()関数のすべてのコードが（保存ボタンを押すまで）使用できなくなります。 ajaxリクエスト、colorpickersなどのjQueryなどのものは、すぐには機能しません。その機能からは、ウィジェットインスタンスはまだ初期化されていないように見えるためです。

汚い解決策は 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>

この解決策の1つの欠点は、たくさんのウィジェットが登録されていると、毎秒DOMのライブクエリチェックが変わるので、ブラウザが大量のCPUを消費することです（私は特にこれをテストしていません。

バグを修正するためのより良い方法について何か提案はありますか？

customizationplugin-developmentwidgets
14
onetrickpony

私は最近同様の状況で戦いました。ウィジェット内の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が返されます。私はこの問題を回避する他の方法を見つけることができませんでした。私が唯一の人ではないと聞いてうれしい:)

5
mfields

私は自分の質問に答えるのは好きではありませんが、これがこれまでのところ最良の解決策であると感じます。

$('#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);

  }

});

これは、ウィジェット保存要求が完了した直後にウィジェット保存ajax要求を起動します（html形式の応答がなかった場合）。

jQuery(document).ready()関数に追加する必要があります。

さて、あなたが簡単にあなたのjavascript関数をwidgetフォーム関数によって追加された新しいDOM要素に再アタッチしたいならば、それらを単に "saved_widget"イベントにバインドする：

$(document).bind('saved_widget', function(event, widget){
  // For example: $(widget).colorpicker() ....
});
7
onetrickpony

最近これに遭遇し、伝統的な "widgets.php"インターフェースでは、どんなjavascript初期化も既存のウィジェット（#widgets-right div内のもの）のために直接実行されるべきで、新しく追加されたウィジェットのためのwidget-addedイベントを通して間接的に実行されるべきです。カスタマイザの "customize.php"インタフェースでは、既存のウィジェットと新しいウィジェットのすべてのウィジェットにwidget-addedイベントが送られるので、そこで初期化するだけです。これに基づいて、次はWP_Widgetクラスの拡張で、1つの関数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' );
} );
3
bonger

私はあなたに役立つかもしれない何かがWordpress 3.9に存在すると思います。それは widget-updated callbackです。これを次のように使用します（コーヒースクリプト）。

$(document).on 'widget-updated', (event, widget) ->
    doWhatINeed() if widget[0].id.match(/my_widget_name/)
2
Tyler Collier