WP Rest API: подробиці останнього допису, включаючи представлені медіа-адреси в одному запиті?


15

Я використовую wp-rest api для отримання інформації про публікації. Я також використовую елементи фільтру wp rest api для фільтрування полів та підведення підсумків:

Коли я телефоную, http://example.com/wp-json/wp/v2/posts?items=id,title,featured_mediaвін повертає такі результати:

[

    {
        "id": 407,
        "title": {
            "rendered": "Title 1"
        },
        "featured_media": 399
    },
    {
        "id": 403,
        "title": {
            "rendered": "Title 2"
        },
        "featured_media": 401
    }

]

Питання полягає в тому, як я можу генерувати популярний URL-адресу медіа за допомогою цього ідентифікатора? За замовчуванням виклик http://example.com/wp-json/wp/v2/media/401повертає новий json, який містить усі деталі про URL різних розмірів вихідного зображення:

{

    "id": 401,
    "date": "2016-06-03T17:29:09",
    "date_gmt": "2016-06-03T17:29:09",
    "guid": {
        "rendered": "http://example.com/wp-content/uploads/my-image-name.png"
    },
    "modified": "2016-06-03T17:29:09",
    "modified_gmt": "2016-06-03T17:29:09",
    "slug": "my-image-name",
    "type": "attachment",
    "link": "http://example.com/my-post-url",
    "title": {
        "rendered": "my-image-name"
    },
    "author": 1,
    "comment_status": "open",
    "ping_status": "closed",
    "alt_text": "",
    "caption": "",
    "description": "",
    "media_type": "image",
    "mime_type": "image/png",
    "media_details": {
        "width": 550,
        "height": 250,
        "file": "my-image-name.png",
        "sizes": {
            "thumbnail": {
                "file": "my-image-name-150x150.png",
                "width": 150,
                "height": 150,
                "mime_type": "image/png",
                "source_url": "http://example.com/wp-content/uploads/my-image-name-150x150.png"
            },
            "medium": {
                "file": "my-image-name-300x136.png",
                "width": 300,
                "height": 136,
                "mime_type": "image/png",
                "source_url": "http://example.com/wp-content/uploads/my-image-name-300x136.png"
            },
            "one-paze-port-thumb": {
                "file": "my-image-name-363x250.png",
                "width": 363,
                "height": 250,
                "mime_type": "image/png",
                "source_url": "http://example.com/wp-content/uploads/my-image-name-363x250.png"
            },
            "one-paze-blog-thumb": {
                "file": "my-image-name-270x127.png",
                "width": 270,
                "height": 127,
                "mime_type": "image/png",
                "source_url": "http://example.com/wp-content/uploads/my-image-name-270x127.png"
            },
            "one-paze-team-thumb": {
                "file": "my-image-name-175x175.png",
                "width": 175,
                "height": 175,
                "mime_type": "image/png",
                "source_url": "http://example.com/wp-content/uploads/my-image-name-175x175.png"
            },
            "one-paze-testimonial-thumb": {
                "file": "my-image-name-79x79.png",
                "width": 79,
                "height": 79,
                "mime_type": "image/png",
                "source_url": "http://example.com/wp-content/uploads/my-image-name-79x79.png"
            },
            "one-paze-blog-medium-image": {
                "file": "my-image-name-380x250.png",
                "width": 380,
                "height": 250,
                "mime_type": "image/png",
                "source_url": "http://example.com/wp-content/uploads/my-image-name-380x250.png"
            },
            "full": {
                "file": "my-image-name.png",
                "width": 550,
                "height": 250,
                "mime_type": "image/png",
                "source_url": "http://example.com/wp-content/uploads/my-image-name.png"
            }
        },
        "image_meta": {
            "aperture": "0",
            "credit": "",
            "camera": "",
            "caption": "",
            "created_timestamp": "0",
            "copyright": "",
            "focal_length": "0",
            "iso": "0",
            "shutter_speed": "0",
            "title": "",
            "orientation": "0",
            "keywords": [ ]
        }
    },
    "post": 284,
    "source_url": "http://example.com/wp-content/uploads/my-image-name.png",
    "_links": {
        "self": [
            {
                "href": "http://example.com/wp-json/wp/v2/media/401"
            }
        ],
        "collection": [
            {
                "href": "http://example.com/wp-json/wp/v2/media"
            }
        ],
        "about": [
            {
                "href": "http://example.com/wp-json/wp/v2/types/attachment"
            }
        ],
        "author": [
            {
                "embeddable": true,
                "href": "http://example.com/wp-json/wp/v2/users/1"
            }
        ],
        "replies": [
            {
                "embeddable": true,
                "href": "http://example.com/wp-json/wp/v2/comments?post=401"
            }
        ]
    }

}

Але розглянемо випадок, коли я хочу отримати список публікацій та їх ескізи. Одного разу я повинен зателефонувати, http://example.com/wp-json/wp/v2/posts?items=id,title,featured_mediaтоді я повинен зателефонувати http://example.com/wp-json/wp/v2/media/id10 разів для кожного медіа-ідентифікатора, а потім проаналізувати результати та отримати остаточну URL-адресу мініатюри медіа. Тож йому потрібно 11 запитів на отримання деталей 10 публікацій (одна для списку, 10 для ескізів). Чи можливо отримати ці результати за один запит?


1
Ви зареєстрували нове поле для вашої відповіді з register_rest_field?
Беноті

@Benoti Я перевірю його документацію. Якщо було ще запитати, я повернусь до вас :)
VSB

Це правильно, ви не вказали дату зображення у запиті на публікацію, лише за замовчуванням API WP необхідний лише ідентифікатор обраного носія та новий запит.
буелге

Якщо ви додасте _embedпараметр, повернутий об’єкт публікації включає всі відомості про представлений носій інформації та всі його доступні розміри. Перевірте приклад моєї відповіді.
Jesús Franco

Відповіді:


18

Ах, я просто мав цю проблему сам! І хоча _embedце чудово, на моєму досвіді це дуже повільно, і справа JSON - бути швидким: D

У плагіна у мене є такий код (використовується для додавання користувальницьких типів публікацій), але я думаю, що ви можете помістити його у function.phpфайл своєї теми .

php

add_action( 'rest_api_init', 'add_thumbnail_to_JSON' );
function add_thumbnail_to_JSON() {
//Add featured image
register_rest_field( 
    'post', // Where to add the field (Here, blog posts. Could be an array)
    'featured_image_src', // Name of new field (You can call this anything)
    array(
        'get_callback'    => 'get_image_src',
        'update_callback' => null,
        'schema'          => null,
         )
    );
}

function get_image_src( $object, $field_name, $request ) {
  $feat_img_array = wp_get_attachment_image_src(
    $object['featured_media'], // Image attachment ID
    'thumbnail',  // Size.  Ex. "thumbnail", "large", "full", etc..
    true // Whether the image should be treated as an icon.
  );
  return $feat_img_array[0];
}

Тепер у вашій відповіді JSON ви повинні побачити нове поле, яке називається "featured_image_src":URL-адресою мініатюри.

Детальніше про зміну відповідей читайте тут:
http://v2.wp-api.org/extending/modifying/

Ось додаткова інформація про register_rest_fieldта wp_get_attachment_image_src()функції:
1.) https://developer.wordpress.org/reference/functions/register_rest_field/
2.) https://developer.wordpress.org/reference/functions/wp_get_attachment_image_src/

** Примітка. Не забувайте <?php ?>теги, якщо це новий файл php!


2
Це чудово працює і допомагає _embed не потрібно використовувати, оскільки я хочу лише зображення у повному розмірі. Мені довелося змінити його на: ($object['featured_media'], 'fullsize', false);не давати мені URL-адресу мініатюри, але відмінно працює через function.php - Дякую!
Йорданія

1
Все це жонглювання з кінцевою точкою RES API нагадує мені, чому мені подобається GraphQL, і що я повинен закінчувати обгортки REST API та нові користувацькі рішення? Мені потрібно (і саме це).
Хесус Франко

Новий плагін має, http://mahditajik.ir/wp-json/wp/v2/media/<id>але в ньому є багато додаткових даних, які роблять реакцію повільною, як я можу налаштувати REST api response dto?
Махді

1
Велике спасибі, це допомогло мені закінчити свою функцію контенту! : D
Atem18

1
Я просто хотів повідомити вам, що це скоротити 2 з мого часу завантаження! Дуже дякую вам і за ретельно підготовлену бібліографію!
GuiHarrison

7

Просто додайте _embedаргумент запиту до вашої URL-адреси із запитом публікацій, і кожен об’єкт публікації буде містити _embedded.[wp:featuredmedia]об’єкт, до якого входять усі зображення, як і /media/$idресурс. Якщо ви хочете певного розміру, просто перейдіть до нього за назвою його властивості, тобто: _embedded[wp:featuredmedia][0].media_details.sizes.full.source_urlабо за його ескізом:_embedded[wp:featuredmedia][0].media_details.sizes.thumbnail.source_url

Тобто, вбудований об’єкт wp: featuredmedia включає всі URL-адреси та деталі для кожного розміру, доступного для вашої публікації, але якщо ви хочете просто оригінальне зображене зображення, ви можете використовувати значення в цьому ключі: post._embedded["wp:featuredmedia"][0].source_url

Я використовую його на сайті з чимось подібним (звичайно використовуйте власний домен):

$.get('https://example.com/wp-json/wp/v2/posts/?categories=3&_embed', 
    function(posts) { 
        var elems = '';
        posts.forEach(function(post){ 
            var link = post.link;
            var title = post.title.rendered;
            var pic = post._embedded["wp:featuredmedia"][0].source_url);
            elems += '<div class="this_week"><a href="' + link + '" target="_blank">';
            elems += '<img src="' + pic + '" title="' + title + '"/><span class="title">';
            elems += title + '</span></a></div>';
        });
        $('#blockbusters').html(elems);
    });
});

Подивитися? Не потрібно двох запитів, просто додайте _embedяк аргумент запиту, і тоді у вас є вся інформація, необхідна для використання найкращого розміру для перегляду.

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