wp.media.view.ImageDetails - Сохранить настройки как данные HTML5- * атрибуты для изображения

19

В конечном итоге я хочу добавить дополнительные параметры в поле «Детали изображения», которые будут сохранены в <img>теге изображения в качестве data-*атрибутов.

Пример: <img src="..." data-my_setting="...">


МОЙ КОД

Я создаю плагин, и мне нужно создать больше настроек для редактирования изображений. Пока у меня есть следующий код:

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

Я создал новый пост и добавил одно изображение, затем щелкнул по нему и нажал «Изменить» (значок карандаша на всплывающей панели инструментов). Я попал на страницу с информацией об изображении, и вот как это выглядело:

введите описание изображения здесь

Все идет нормально. На этой линии:

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

Я бы обычно использовал jQuery для получения значения ввода, но для целей тестирования я изменил его на статическое значение 'setting-value-here'. Я нажал «Обновить» в правом нижнем углу окна «Детали изображения».


ПРОБЛЕМА

В текстовом редакторе он показывает HTML-код следующим образом:

введите описание изображения здесь

Это не имеет data-settings="setting-value-here", как получилось?

Если я заменю строку с этим:

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

Это действительно изменить тег ALT на alt="setting-value-here". Так что же я делаю неправильно, пытаясь установить атрибут data- *?


РЕШЕНИЕ

Благодаря @bonger (который получил полную награду 50 репутации), у меня есть следующий код:

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: (необходимо поставить в очередь с помощью 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 );
});
Каспар Ли
источник
3
Хотел бы я +2 - красноречиво, кратко, хорошо проработано, поэтому по теме это больно. Подобные вопросы - редкая порода.
TheDeadMedic
2
Благодарность! Я всегда стараюсь и исследую (и тщательно отлаживаю) свои проблемы столько, сколько могу, прежде чем спрашиваю. (Я ненавижу, когда ты находишь действительно простой вопрос, а ОП даже не пробовал гуглить)
Каспар Ли

Ответы:

14

Один из способов сделать это - использовать (очень удобно) editor:image-editи editor:image-updateсобытия, запускаемые wpeditimageплагином tinymce, чтобы напрямую получить / установить dom ( обновленный для включения в wp_enqueue_mediaдействие):

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

Чтобы добавить и заполнить поле настроек, возможно, лучше взломать вывод wp_print_media_templates()вместо переопределения ImageDetails.initialize()( обновлено, чтобы включить в wp_enqueue_mediaдействие):

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;
    } );
} );
Бонгер
источник
2
Спасибо огромное! Это очень полезно (хотя требуется несколько минут, чтобы разобраться). Я приму ответ и передам вам награду как раз перед тем, как она закончится (кто-то может придумать лучший / более простой ответ)
Каспар Ли,
Хм, это случится, если запустить его раньше wp_enqueue_media(). Может быть, лучше всего использовать в wp_enqueue_mediaдействие, запускаемое в конце wp_enqueue_media(), т.е. обернуть весь код в качествеadd_action( 'wp_enqueue_media', function () { /*the code*/ } );
Бонгер
Нет, наоборот!
Бонг
Я
обновлю
1
Это переопределение WP в шаблон вещи Underscore в underscorejs.org/#template (см wp.templateв «сор-включает / JS / WP-util.js») .... я думаю
Бонгер