ngottlieb
commented
1 year ago From Jai Sen:
for discussion on today’s call, we’ve got the news/post [article] API set up and functioning here: https://amwwaterdev.wpengine.com/wp-json/wp/v2/posts
With the default output and 10 posts returned by default, this currently looks like this:
[
{
"id": 105,
"date": "2023-05-10T20:17:01",
"date_gmt": "2023-05-10T20:17:01",
"guid": {
"rendered": "https://amwwaterdev.wpengine.com/?p=105"
},
"modified": "2023-05-10T20:20:53",
"modified_gmt": "2023-05-10T20:20:53",
"slug": "test-article",
"status": "publish",
"type": "post",
"link": "https://amwwaterdev.wpengine.com/2023/05/10/test-article/",
"title": {
"rendered": "Test Flathead River Article"
},
"content": {
"rendered": "\n<p>Testing Web article text with an image uploaded below. </p>\n\n\n\n<figure class=\"wp-block-image size-large\"><img decoding=\"async\" loading=\"lazy\" width=\"1024\" height=\"820\" src=\"https://amwwaterdev.wpengine.com/wp-content/uploads/2023/05/Screen-Shot-2022-10-07-at-1.08.22-PM-1024x820.png\" alt=\"\" class=\"wp-image-107\" srcset=\"https://amwwaterdev.wpengine.com/wp-content/uploads/2023/05/Screen-Shot-2022-10-07-at-1.08.22-PM-1024x820.png 1024w, https://amwwaterdev.wpengine.com/wp-content/uploads/2023/05/Screen-Shot-2022-10-07-at-1.08.22-PM-980x785.png 980w, https://amwwaterdev.wpengine.com/wp-content/uploads/2023/05/Screen-Shot-2022-10-07-at-1.08.22-PM-480x384.png 480w\" sizes=\"(min-width: 0px) and (max-width: 480px) 480px, (min-width: 481px) and (max-width: 980px) 980px, (min-width: 981px) 1024px, 100vw\" /></figure>\n\n\n\n<p>And then some text below. </p>\n\n\n\n<blockquote class=\"wp-block-quote\">\n<p>“The Turbulent waters quote”</p>\n\n\n\n<figure class=\"wp-block-gallery has-nested-images columns-default is-cropped wp-block-gallery-1 is-layout-flex\"></figure>\n<cite>CSKT</cite></blockquote>\n",
"protected": false
},
"excerpt": {
"rendered": "<p>Testing Web article text with an image uploaded below. And then some text below.</p>\n",
"protected": false
},
"author": 3,
"featured_media": 0,
"comment_status": "open",
"ping_status": "open",
"sticky": false,
"template": "",
"format": "standard",
"meta": {
"_et_pb_use_builder": "off",
"_et_pb_old_content": "",
"_et_gb_content_width": ""
},
"categories": [
1
],
"tags": [
8,
9,
7
],
"ppma_author": [
6
],
"acf": [],
"featured_image_src": null,
"featured_image_src_square": null,
"author_info": {
"display_name": "Kevin Colburn",
"author_link": "https://amwwaterdev.wpengine.com/author/kevin/"
},
"authors": [
{
"term_id": 6,
"user_id": 3,
"is_guest": 0,
"slug": "kevin",
"display_name": "Kevin Colburn",
"avatar_url": {
"url": "https://amwwaterdev.wpengine.com/wp-content/uploads/2023/05/Swimmers-scaled.jpg",
"url2x": "https://amwwaterdev.wpengine.com/wp-content/uploads/2023/05/Swimmers-scaled.jpg"
},
"description": "River bio",
"first_name": "Kevin",
"last_name": "Colburn",
"user_url": "",
"user_url_2": ""
}
],
"_links": {
"self": [
{
"href": "https://amwwaterdev.wpengine.com/wp-json/wp/v2/posts/105"
}
],
"collection": [
{
"href": "https://amwwaterdev.wpengine.com/wp-json/wp/v2/posts"
}
],
"about": [
{
"href": "https://amwwaterdev.wpengine.com/wp-json/wp/v2/types/post"
}
],
"author": [
{
"embeddable": true,
"href": "https://amwwaterdev.wpengine.com/wp-json/wp/v2/users/3"
}
],
"replies": [
{
"embeddable": true,
"href": "https://amwwaterdev.wpengine.com/wp-json/wp/v2/comments?post=105"
}
],
"version-history": [
{
"count": 0,
"href": "https://amwwaterdev.wpengine.com/wp-json/wp/v2/posts/105/revisions"
}
],
"wp:attachment": [
{
"href": "https://amwwaterdev.wpengine.com/wp-json/wp/v2/media?parent=105"
}
],
"wp:term": [
{
"taxonomy": "category",
"embeddable": true,
"href": "https://amwwaterdev.wpengine.com/wp-json/wp/v2/categories?post=105"
},
{
"taxonomy": "post_tag",
"embeddable": true,
"href": "https://amwwaterdev.wpengine.com/wp-json/wp/v2/tags?post=105"
},
{
"taxonomy": "author",
"embeddable": true,
"href": "https://amwwaterdev.wpengine.com/wp-json/wp/v2/ppma_author?post=105"
}
],
"curies": [
{
"name": "wp",
"href": "[https://api.w.org/{rel}](https://api.w.org/%7Brel%7D)",
"templated": true
}
]
}
},
}
]A couple of notes:
- Like the menu API I shared last week, the posts/news one can be templated so we can extensively customize the output (what’s above is just the default)
- There are a lot of parameters we get out of the box with WP’s REST API (docs that I shared last week https://developer.wordpress.org/rest-api/ ) and we can add additional ones
- One of the ways we can extend this is adding query parameters from FacetWP, the AJAX search/sort/filter plugin, as well as from SearchWP, the search engine, so for example an API call could return results matching a search term if we will ever need anything like that
- Note that a lot of markup and HTML comes with the content, we can output plain text content and summaries/excerpts for posts (vs all that rendered content)
- Note also image handling, we can alias image references and features image thumbnails to their locations on the S3 image bucket through a different means (but the image paths output by the posts API will serve up S3 image paths in output)
- Default REST APIs are set up for projects, documents, and accidents but these will definitely need customization to provide the right output including custom fields. They also need sample content so you can see meaningful output, I provided the links as proof of concept that they’re functioning but many are blank or just have completely placeholder content. We will have sample imported content added to the dev site from import tests this week and initial templates that include custom fields up and running tomorrow
AWKevin
This is blocked until we get more information on the Wordpress API (and a test environment) from Jai
Certain reach-related objects currently displayed on the Vue app are moving to Wordpress, so we need to refactor the Vue app to query the Wordpress API for these objects and to link to their wordpress URLs for detail display.
This includes: