wp.media.view.ImageDetails - Zapisz ustawienia jako atrybuty danych HTML5 - * dla obrazu

19

W końcu chcę osiągnąć dodatkowe ustawienia dodane do pola Szczegóły obrazu, które zostaną zapisane w <img>tagu obrazu jako data-*atrybuty

Przykład: <img src="..." data-my_setting="...">


MÓJ KOD

Tworzę wtyczkę i muszę utworzyć więcej ustawień do edycji zdjęć. Do tej pory mam następujący kod:

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($))

Utworzyłem nowy post i dodałem jedno zdjęcie, a następnie kliknąłem go i wcisnąłem Edytuj (ikona ołówka na pasku narzędzi, który się pojawił). Skończyło się na stronie ze szczegółami obrazu i tak to wyglądało:

wprowadź opis zdjęcia tutaj

Jak na razie dobrze. Na tej linii:

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

Normalnie użyłbym jQuery, aby uzyskać wartość wejściową, ale dla celów testowych zmieniłem ją na wartość statyczną 'setting-value-here'. Nacisnąłem „Aktualizuj” w prawym dolnym rogu pola Szczegóły obrazu.


PROBLEM

W edytorze tekstu pokazuje kod HTML w następujący sposób:

wprowadź opis zdjęcia tutaj

To nie ma data-settings="setting-value-here", dlaczego?

Jeśli zastąpię wiersz tym:

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

To nie zmienia ALT tag do alt="setting-value-here". Więc co robię źle, próbując ustawić atrybut data- *?


ROZWIĄZANIE

Dzięki @bonger (który otrzymał pełną nagrodę 50 Reputacji), mam następujący kod:

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: (wymaga kolejkowania za pomocą 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
źródło
3
Chciałbym móc +2 - elokwentny, zwięzły, dobrze zbadany, więc na temat boli. Takie pytania to rzadka rasa.
TheDeadMedic
2
Dzięki! Zawsze staram się badać (i intensywnie debugować) moje problemy na tyle, na ile mogę, zanim o to poproszę. (Nienawidzę tego, gdy znajdziesz naprawdę proste pytanie, a OP nawet nie próbował Googlinga)
Kaspar Lee

Odpowiedzi:

14

Sposobem na to jest użycie (bardzo wygodnego) editor:image-editi editor:image-updatezdarzeń wyzwalanych przez wpeditimagewtyczkę tinymce, aby uzyskać / ustawić dom bezpośrednio ( zaktualizowany do zawijania w wp_enqueue_mediaakcji):

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

Aby dodać i wypełnić pole ustawień, być może bardziej odpowiednie jest zhakowanie danych wyjściowych wp_print_media_templates()niż zastąpienie ImageDetails.initialize()( zaktualizowane, aby zawijać w wp_enqueue_mediaakcji):

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
źródło
2
Dziękuję bardzo! Jest to bardzo przydatne (choć zajmuje kilka minut, aby się rozejrzeć). Przyjmuję odpowiedź i przyznam nagrodę tuż przed jej zakończeniem (ktoś wymyślił lepszą / prostszą odpowiedź)
Kaspar Lee
Hmm, stanie się tak, jeśli zostanie uruchomiony wcześniej wp_enqueue_media(). Być może lepszym sposobem jest użycie wp_enqueue_mediaakcji, która jest uruchamiana na końcu wp_enqueue_media(), tj. add_action( 'wp_enqueue_media', function () { /*the code*/ } );
Zawinięcie
Nie, odwrotnie!
bonger
Zaktualizuję odpowiedź ...
bonger
1
Jest to zastąpienie WP przez szablon underscorejs.org/#template (patrz wp.templatew „wp-obejmuje / js / wp-util.js”) .... myślę
bonger