Оновити форму віджетів після перетягування (помилка збереження WP)


15

Я опублікував звіт про помилку про це кілька місяців тому ( на WordPress trac (Widget Instance Form Update Bug) ), і я подумав, що спробую написати про це і тут. Можливо, хтось має кращий варіант вирішення цього питання, ніж я.

В основному проблема полягає в тому, що якщо ви запустили віджет на бічну панель, форма віджетів не оновлюється, поки ви вручну не натисніть кнопку збереження (або перезавантажте сторінку).

Це робить непридатним весь код з form()функції, яка покладається на ідентифікатор екземпляра віджета, щоб щось зробити (поки не натиснеш кнопку збереження). Будь-які речі, такі як запити ajax, jQuery, такі як кольоровідбірники тощо, не працюватимуть одразу, тому що з цієї функції буде видно, що екземпляр віджетів ще не ініціалізований.

Брудним виправленням буде автоматично запускати кнопку збереження, використовуючи щось на зразок livequery :

$("#widgets-right .needfix").livequery(function(){
  var widget = $(this).closest('div.widget');
  wpWidgets.save(widget, 0, 1, 0);
  return false;
});

і додайте .needfixклас, form()якщо екземпляр віджета не виглядає ініціалізованим:

 <div <?php if(!is_numeric($this->number)): ?>class="needfix"<?php endif; ?>
   ...
 </div>

Одним із недоліків цього рішення є те, що якщо у вас зареєстровано багато віджетів, браузер з’їсть багато процесора, оскільки перевірка живого запиту на DOM змінюється щосекунди (тому я спеціально цього не перевіряв, це лише моє припущення :)

Будь-які пропозиції щодо кращого способу виправити помилку?


Замість того, щоб викликати повне подання збереження, чи не було б більше сенсу заглядати всередину того, що натискання кнопки збереження викликає необхідний ідентифікатор, відокремлює цей код і викликає його в кінці операції, що випадає?
хакре

Відповіді:


5

Я бився з подібною ситуацією недавно. 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 об'єкту, і він поверне ідентифікатор екземпляра поточного екземпляра. Я не міг знайти іншого шляху навколо цього питання. Радий почути, що я не єдиний :)


7

Мені не подобається відповідати на моє власне питання, але я вважаю, що це найкраще рішення поки що:

$('#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 до нових елементів DOM, доданих функцією віджета, просто прив’яжіть їх до події "save_widget":

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

3
Зауважте, що станом на jQuery 1.8 метод .ajaxComplete () повинен бути доданий лише до документа. - api.jquery.com/ajaxComplete Таким чином, перший рядок вашого фрагмента повинен читати: $ (document) .ajaxComplete (функція (подія, XMLHttpRequest, ajaxOptions) {Принаймні для WP 3.6+
David Laing

3

Нещодавно зіткнувся з цим, і здається, що в традиційному інтерфейсі "widgets.php" будь-яка ініціалізація JavaScript повинна запускатися безпосередньо для існуючих віджетів (тих, що знаходяться в #widgets-rightдіві), а опосередковано через widget-addedподію для нових доданих віджетів; тоді як в інтерфейсі "customize.php" в інтерфейсі "customize.php" всі віджети - існуючі та нові - надсилаються widget-addedподіями, тому їх можна просто ініціалізувати там. Виходячи з цього, далі розширення WP_Widgetкласу, що дозволяє легко додавати ініціалізацію javascript у форму віджету шляхом зміни однієї функції form_javascript_init():

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' );
} );

Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.