Atualizar formulário do widget após arrastar e soltar (bug de salvamento do WP)


15

Publiquei um relatório de bug sobre isso há alguns meses atrás ( no WordPress trac (Bug de atualização do formulário da instância de widget) ) e pensei em tentar escrever sobre isso aqui também. Talvez alguém tenha uma solução melhor para esse problema do que eu.

Basicamente, o problema é que, se você soltar um widget em uma barra lateral, o formulário não será atualizado até que você pressione manualmente salvar (ou recarregar a página).

Isso torna inutilizável todo o código da form()função que depende do ID da instância do widget para fazer alguma coisa (até você pressionar o botão Salvar). Coisas como solicitações de ajax, coisas do jQuery, como seletores de cores etc. não funcionarão imediatamente, porque a partir dessa função parece que a instância do widget ainda não foi inicializada.

Uma correção suja seria acionar o botão salvar automaticamente usando algo como livequery :

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

e adicione a .needfixclasse form()se a instância do widget não parecer inicializada:

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

Uma desvantagem desta solução é que, se você tiver muitos widgets registrados, o navegador consumirá muita CPU, porque o livequery verifica se há alterações no DOM a cada segundo (embora eu não testei isso especificamente, é apenas minha suposição :)

Alguma sugestão para uma maneira melhor de corrigir o erro?


Em vez de acionar um envio completo de salvamento, não faria mais sentido olhar para dentro do que pressionar o botão salvar dispara para fornecer o ID necessário, separar esse código e chamá-lo no final da operação de remoção?
hakre 6/02/11

Respostas:


5

Eu lutei com uma situação semelhante recentemente. Ajax em widgets não é brincadeira! É necessário escrever um código bem louco para que as coisas funcionem entre instâncias. Não estou familiarizado com a consulta ao vivo, mas se você diz que verifica o DOM a cada segundo, talvez eu tenha uma solução menos intensa para você:

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

Você pode passar para essa função um objeto seletor ou jQuery e ele retornará o ID da instância atual. Não consegui encontrar outra maneira de contornar esse problema. Fico feliz em ouvir que eu não sou o único :)


7

Não gosto de responder minha própria pergunta, mas sinto que esta é a melhor solução até agora:

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

  }

});

Isso acionará a solicitação ajax de economia de widget, logo após a conclusão de uma solicitação de economia de widget (se não houver resposta com o formulário html).

Ele precisa ser adicionado na jQuery(document).ready()função.

Agora, se você deseja reconectar facilmente suas funções javascript aos novos elementos DOM adicionados pela função de formulário do widget, basta vinculá-los ao evento "saved_widget":

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

3
Observe que, a partir do jQuery 1.8, o método .ajaxComplete () deve ser anexado apenas ao documento. - api.jquery.com/ajaxComplete Portanto, a primeira linha do seu snippet deve ser: $ (document) .ajaxComplete (function (event, XMLHttpRequest, ajaxOptions) {Pelo menos para WP 3.6+
David Laing

3

Cheguei a isso recentemente e parece que na interface tradicional "widgets.php" qualquer inicialização javascript deve ser executada diretamente para os widgets existentes (aqueles na #widgets-rightdiv) e indiretamente através do widget-addedevento para widgets adicionados recentemente; enquanto na interface "customize.php" do personalizador todos os widgets - existentes e novos - são enviados ao widget-addedevento, para que possam ser inicializados apenas lá. Com base nisso, há uma extensão da WP_Widgetclasse que facilita a adição de inicialização javascript ao formulário de um widget, substituindo uma função 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
    }
}

Um exemplo de widget de teste usando este:

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

2

Eu acho que existe algo no Wordpress 3.9 que pode ajudá-lo. É o retorno de chamada atualizado pelo widget . Use-o assim (coffeescript):

$(document).on 'widget-updated', (event, widget) ->
    doWhatINeed() if widget[0].id.match(/my_widget_name/)
Ao utilizar nosso site, você reconhece que leu e compreendeu nossa Política de Cookies e nossa Política de Privacidade.
Licensed under cc by-sa 3.0 with attribution required.