WP Rest API: szczegóły najnowszego postu, w tym URL polecanego multimediów w jednym żądaniu?

15

Korzystam z interfejsu API wp-rest, aby uzyskać informacje o postach. Używam również elementów filtrujących wp rest api do filtrowania pól i podsumowania wyniku:

Kiedy dzwonię http://example.com/wp-json/wp/v2/posts?items=id,title,featured_media, zwraca wyniki takie jak poniżej:

[

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

]

Pytanie brzmi: w jaki sposób mogę wygenerować polecany adres URL multimediów za pomocą tego identyfikatora? Domyślnie wywołanie http://example.com/wp-json/wp/v2/media/401zwraca nowy plik Json, który zawiera wszystkie szczegóły dotyczące adresu URL o różnych rozmiarach obrazu źródłowego:

{

    "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"
            }
        ]
    }

}

Ale rozważ przypadek, gdy chcę uzyskać listę postów i ich miniatury. Raz powinienem zadzwonić, http://example.com/wp-json/wp/v2/posts?items=id,title,featured_mediaa następnie zadzwonić http://example.com/wp-json/wp/v2/media/id10 razy dla każdego identyfikatora mediów, a następnie przeanalizować wyniki i uzyskać końcowy adres URL miniatury mediów. Potrzebuje więc 11 prośby o szczegóły 10 postów (jeden dla listy, 10 dla miniatur). Czy można uzyskać ten wynik w jednym żądaniu?

VSB
źródło
1
Czy zarejestrowałeś nowe pole swojej odpowiedzi w register_rest_field?
Benoti
@Benoti sprawdzę jego dokumentację. Gdyby było więcej pytań, wrócę do ciebie :)
VSB
To prawda, nie masz daty obrazu w żądaniu postu, wystarczy identyfikator wyróżnionego nośnika i nowe żądanie jest wymagane w domyślnym interfejsie WP API.
bueltge
Jeśli dodasz _embedparametr, zwrócony obiekt post zawiera wszystkie szczegóły dotyczące wyróżnionego nośnika i wszystkich dostępnych rozmiarów. Sprawdź moją odpowiedź na przykład.
Jesús Franco

Odpowiedzi:

18

Ach, właśnie miałem ten problem! I chociaż _embedjest świetny, z mojego doświadczenia wynika, że ​​jest bardzo powolny, a JSON ma być szybki: D

Mam następujący kod we wtyczce (używany do dodawania niestandardowych typów postów), ale wyobrażam sobie, że możesz umieścić go w function.phppliku motywu .

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

Teraz w odpowiedzi JSON powinieneś zobaczyć nowe pole o nazwie "featured_image_src":zawierające adres URL miniatury.

Przeczytaj więcej o modyfikowaniu odpowiedzi tutaj:
http://v2.wp-api.org/extending/modifying/

A oto więcej informacji na temat register_rest_fieldi wp_get_attachment_image_src()funkcji:
1.) https://developer.wordpress.org/reference/functions/register_rest_field/
2.) https://developer.wordpress.org/reference/functions/wp_get_attachment_image_src/

** Uwaga: Nie zapomnij o <?php ?>tagach, jeśli jest to nowy plik php!

StephanieQ
źródło
2
Działa to świetnie i pomaga, że ​​_embed nie musi być używany, ponieważ chcę tylko polecany obraz w pełnym rozmiarze. Musiałem zmienić to na: ($object['featured_media'], 'fullsize', false);aby nie podawać mi adresu URL miniatury, ale działa idealnie za pośrednictwem functions.php - dzięki!
Jordan
1
Całe to żonglowanie punktem końcowym interfejsu API RES przypomina mi, dlaczego lubię GraphQL i że powinienem zakończyć owijanie interfejsu API REST i nowych niestandardowych programów tłumaczących ;-) W każdym razie jest to sprytne rozwiązanie i faktycznie używam niestandardowych punktów końcowych w produkcji, aby uzyskać dane Potrzebuję (i tylko to).
Jesús Franco,
Nowa wtyczka ma, http://mahditajik.ir/wp-json/wp/v2/media/<id>ale ma wiele dodatkowych danych, które spowalniają reakcję, więc jak mogę dostosować interfejs API REST do odpowiedzi?
Mahdi
1
Wielkie dzięki, pomogło mi to dokończyć funkcję polecanej zawartości! : D
Atem18
1
Chciałem tylko poinformować, że to zmniejszyło mój czas ładowania o 2 sekundy! Dziękuję bardzo i za starannie opracowaną bibliografię!
GuiHarrison
7

Wystarczy dodać _embedargument zapytania do adresu URL, prosząc o posty, a każdy obiekt postu będzie zawierał _embedded.[wp:featuredmedia]obiekt, który zawiera wszystkie obrazy, podobnie jak /media/$idzasób. Jeśli chcesz mieć określony rozmiar, po prostu uzyskaj do niego dostęp według jego właściwości, tj .: _embedded[wp:featuredmedia][0].media_details.sizes.full.source_urllub dla jego miniatury:_embedded[wp:featuredmedia][0].media_details.sizes.thumbnail.source_url

Oznacza to, że obiekt osadzony wp: featuredmedia zawiera wszystkie adresy URL i szczegóły dla każdego rozmiaru dostępnego dla twojego postu, ale jeśli chcesz tylko oryginalny obraz z polecanym, możesz użyć wartości w tym kluczu: post._embedded["wp:featuredmedia"][0].source_url

Używam go w witrynie z czymś takim (oczywiście używaj własnej domeny):

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

Widzieć? Nie potrzebujesz dwóch zapytań, po prostu dodaj _embedjako argument zapytania, a następnie masz wszystkie informacje potrzebne do użycia najlepszego rozmiaru dla twojego widoku.

Jesús Franco
źródło