wp.media.view.ImageDetails - Salvar configurações como dados HTML5 - * atributos para a imagem

19

O que finalmente desejo alcançar são configurações extras adicionadas à caixa Detalhes da imagem, que serão armazenadas na <img>tag da imagem como data-*atributos

Exemplo: <img src="..." data-my_setting="...">


MEU CÓDIGO

Estou criando um plug-in e preciso criar mais configurações para quando você editar imagens. Até agora, tenho o seguinte código:

jQuery(function($) {

    var imageDetails = wp.media.view.ImageDetails

    wp.media.view.ImageDetails = wp.media.view.ImageDetails.extend({
        // Initialize - Call function to add settings when rendered
        initialize: function() {
            this.on('post-render', this.add_settings);
        },
        // To add the Settings
        add_settings: function() {
            $('.advanced-section').prepend('\
                <h2>My Settings</h2>\
                <input type="text" class="my_setting">\
            ');

            // Set Options
            this.controller.image.set({"data-settings": 'setting-value-here'})
        }
    });

}) // End of jQuery(function($))

Criei uma nova postagem e adicionei uma imagem, cliquei nela e pressionei Editar (o ícone de lápis na barra de ferramentas que apareceu). Acabei na página de detalhes da imagem, e era assim:

insira a descrição da imagem aqui

Por enquanto, tudo bem. Nesta linha:

this.controller.image.set({"data-settings": 'setting-value-here'})

Normalmente, eu usaria o jQuery para obter o valor da entrada, mas, para fins de teste, mudei para um valor estático 'setting-value-here'. Pressionei 'Atualizar' no canto inferior direito da caixa Detalhes da imagem.


O PROBLEMA

No editor de texto, ele mostra o código HTML como este:

insira a descrição da imagem aqui

Isso não tem um data-settings="setting-value-here", como é que é?

Se eu substituir a linha por esta:

 this.controller.image.set({alt: 'setting-value-here'})

Ele faz mudar o ALT tag para alt="setting-value-here". Então, o que estou fazendo de errado ao tentar definir o atributo data- *?


A SOLUÇÃO

Graças a @bonger (que recebeu a recompensa total de 50 Reputação), tenho o seguinte código:

PHP:

function add_my_settings() {
    ob_start();
    wp_print_media_templates();
    $tpl = ob_get_clean();
    if ( ( $idx = strpos( $tpl, 'tmpl-image-details' ) ) !== false
            && ( $before_idx = strpos( $tpl, '<div class="advanced-section">', $idx ) ) !== false ) {
        ob_start();
        ?>
        <div class="my_setting-section">
            <h2><?php _e( 'My Settings' ); ?></h2>
            <div class="my_setting">
                <label class="setting my_setting">
                    <span><?php _e( 'My Setting' ); ?></span>
                        <input type="text" data-setting="my_setting" value="{{ data.model.my_setting }}" />
                    </label>
                </div>
            </div>
        <?php
        $my_section = ob_get_clean();
        $tpl = substr_replace( $tpl, $my_section, $before_idx, 0 );
    }
    echo $tpl;
};

// Hack the output of wp_print_media_templates()
add_action('wp_enqueue_media', $func =
    function() {
        remove_action('admin_footer', 'wp_print_media_templates');
        add_action('admin_footer',  'add_my_settings');
    }
);

JavaScript: (precisa ser enfileirado usando wp_enqueue_script())

// When Image is Edited
wp.media.events.on('editor:image-edit', function(data) {
    data.metadata.my_setting = data.editor.dom.getAttrib( data.image, 'data-my_setting' );
});

// When Image is Updated
wp.media.events.on('editor:image-update', function(data) {
    data.editor.dom.setAttrib( data.image, 'data-my_setting', data.metadata.my_setting );
});
Kaspar Lee
fonte
3
Eu gostaria de poder +2 - eloquente, conciso, bem pesquisado, por isso no tópico dói. Perguntas como estas são uma raça rara.
TheDeadMedic
2
Obrigado! Eu sempre tento pesquisar (e depurar extensivamente) meus problemas o máximo que posso antes de perguntar. (Eu odeio quando você encontrar uma pergunta muito simples eo OP nem sequer tentou pesquisando)
Kaspar Lee

Respostas:

14

Uma maneira de fazer isso é usar os eventos (muito convenientes) editor:image-edite editor:image-updateacionados pelo wpeditimageplug-in tinymce para obter / definir o dom diretamente ( atualizado para envolver em wp_enqueue_mediaação):

add_action( 'wp_enqueue_media', function () {
    add_action( 'admin_footer', function () {
        ?>
        <script type="text/javascript">
        jQuery(function ($) {
            if (wp && wp.media && wp.media.events) {
                wp.media.events.on( 'editor:image-edit', function (data) {
                    data.metadata.my_setting = data.editor.dom.getAttrib( data.image, 'data-my_setting' );
                } );
                wp.media.events.on( 'editor:image-update', function (data) {
                    data.editor.dom.setAttrib( data.image, 'data-my_setting', data.metadata.my_setting );
                } );
            }
        });
        </script>
        <?php
    }, 11 );
} );

Para adicionar e preencher o campo de configurações, talvez seja mais interessante hackear a saída em wp_print_media_templates()vez de substituir ImageDetails.initialize()( atualizado para quebrar em wp_enqueue_mediaação):

add_action( 'wp_enqueue_media', function () {
    remove_action( 'admin_footer', 'wp_print_media_templates' );
    add_action( 'admin_footer', $func = function () {
        ob_start();
        wp_print_media_templates();
        $tpl = ob_get_clean();
        // To future-proof a bit, search first for the template and then for the section.
        if ( ( $idx = strpos( $tpl, 'tmpl-image-details' ) ) !== false
                && ( $before_idx = strpos( $tpl, '<div class="advanced-section">', $idx ) ) !== false ) {
            ob_start();
            ?>
    <div class="my_setting-section">
        <h2><?php _e( 'My Settings' ); ?></h2>
        <div class="my_setting">
            <label class="setting my_setting">
                <span><?php _e( 'My Setting' ); ?></span>
                <input type="text" data-setting="my_setting" value="{{ data.model.my_setting }}" />
            </label>
        </div>
    </div>
            <?php
            $my_section = ob_get_clean();
            $tpl = substr_replace( $tpl, $my_section, $before_idx, 0 );
        }
        echo $tpl;
    } );
} );
bonger
fonte
2
Muito obrigado! Isso é muito útil (embora demore alguns minutos para entender). Eu vou aceitar a resposta e atribuir a recompensa para você apenas antes de terminar (alguém da minha chegar a uma resposta melhor / mais simples)
Kaspar Lee
Hmm, isso vai acontecer se for executado antes wp_enqueue_media(). Talvez uma maneira mais agradável é usar a wp_enqueue_mediaação que é disparado no final wp_enqueue_media(), ou seja, envolver todo o código em umadd_action( 'wp_enqueue_media', function () { /*the code*/ } );
Bonger
Não, vice-versa!
Bonger
Eu vou atualizar a resposta ...
Bonger
1
É override de coisas modelo de sublinhado de WP underscorejs.org/#template (veja wp.templateem "wp-includes / js / wp-util.js") .... eu acho
Bonger