Bridge
This plugin was built to provide a bridge between WordPress and Minnie. It modifies the results of some WP API requests., (*1)
Requirements
- WordPress 4.5
- WP API 2.0-beta13
More bridges:
Endpoints
Info
Endpoint: /wp-json/bridge/v1/info, (*2)
{
"url": "https://kucrut.org/wp",
"home": "https://kucrut.org",
"name": "Dzikri Aziz",
"description": "WordPress Developer, Traveler.",
"lang": "en-US",
"html_dir": "ltr",
"settings": {
"archive": {
"per_page": 11
},
"comments": {
"per_page": 50,
"threads": true,
"threads_depth": 3
}
}
}
Results Modifications
To get a modified result, a "Client ID" must be registered first:, (*3)
/**
* Register to the Bridge plugin
*
* @param array $client_ids Client IDs.
* @wp_hook filter bridge_client_ids
* @return array
*/
function minnie_register_to_bridge( $client_ids ) {
$client_ids[] = 'minnie';
return $client_ids;
}
add_filter( 'bridge_client_ids', 'minnie_register_to_bridge' );
Then, every API request must include an X-Requested-With header and the value set to the registered Client ID, in this case minnie., (*4)
Terms
Home URL is stripped from term links., (*5)
Original Result
[
{
"id": 3,
"count": 0,
"description": "",
"link": "http://example.org/blog/type/aside/",
"name": "Aside",
"slug": "post-format-aside",
"taxonomy": "post_format"
}
]
Modified Result
[
{
"id": 3,
"count": 0,
"description": "",
"link": "/blog/type/aside/",
"name": "Aside",
"slug": "post-format-aside",
"taxonomy": "post_format"
}
]
Posts
The result of requests to posts endpoints will have these modifications:
* Home URL is stripped from link, content.rendered.
* title gets a new item: from_content. It's generated from post content and is useful in case the post doesn't have a title and you still want to display a generated title on the client app.
* date_formatted and modified_formatted are added, so you don't need to format the post dates in the client app.
* The value of categories, tags and formats is converted to WP_Term objects.
* When post preview is requested (by setting the preview parameter to 1), the title and content will be replaced with the ones from the post's latest revision., (*6)
Original Result
{
"id": 1,
"date": "2016-02-20T02:09:47",
"date_gmt": "2016-02-20T02:09:47",
"guid": {
"rendered": "http://src.wordpress-develop.dev/?p=1"
},
"modified": "2016-05-24T11:34:19",
"modified_gmt": "2016-05-24T11:34:19",
"slug": "hello-world",
"type": "post",
"link": "http://src.wordpress-develop.dev/blog/2016/02/20/hello-world/",
"title": {
"rendered": "Hello world!"
},
"content": {
"rendered": "<p>Welcome to WordPress. This is your first post. Edit or delete it, then start writing!</p>\n"
},
"excerpt": {
"rendered": "<p>Welcome to WordPress. This is your first post. Edit or delete it, then start writing!</p>\n"
},
"author": 1,
"featured_media": 0,
"comment_status": "open",
"ping_status": "open",
"sticky": false,
"format": "aside",
"categories": [
1
],
"tags": [
5
],
"formats": [
3
]
}
Modified Result
{
"id": 1,
"date": "2016-02-20T02:09:47",
"date_gmt": "2016-02-20T02:09:47",
"guid": {
"rendered": "http://src.wordpress-develop.dev/?p=1"
},
"modified": "2016-05-24T11:34:19",
"modified_gmt": "2016-05-24T11:34:19",
"slug": "hello-world",
"type": "post",
"link": "/blog/2016/02/20/hello-world/",
"title": {
"rendered": "Hello world!",
"from_content": "Welcome to WordPress. This is your first pos…"
},
"content": {
"rendered": "<p>Welcome to WordPress. This is your first post. Edit or delete it, then start writing!</p>\n"
},
"excerpt": {
"rendered": "<p>Welcome to WordPress. This is your first post. Edit or delete it, then start writing!</p>\n"
},
"author": 1,
"featured_media": 0,
"comment_status": "open",
"ping_status": "open",
"sticky": false,
"format": "aside",
"categories": [
{
"id": 1,
"name": "Uncategorized",
"slug": "uncategorized",
"description": "",
"link": "/blog/category/uncategorized/"
}
],
"tags": [
{
"id": 5,
"name": "misc",
"slug": "misc",
"description": "",
"link": "/blog/tag/misc/"
}
],
"formats": [
{
"id": 3,
"name": "Aside",
"slug": "post-format-aside",
"description": "",
"link": "/blog/type/aside/"
}
],
"date_formatted": "February 20, 2016",
"modified_formatted": "May 24, 2016",
}
Attachments
In additions to the modifications above, the result of requests to attachments/media will have these modifications:
* parent_post is added., (*7)
Modified Result
{
"parent_post": {
"id": 1,
"link": "/blog/2016/02/20/hello-world/",
"title": {
"rendered": "Hello world!"
}
}
}
Original Result
{
"id": 1,
"post": 1,
"parent": 0,
"author": 0,
"author_name": "Mr WordPress",
"author_url": "https://wordpress.org/",
"date": "2016-02-20T02:09:47",
"date_gmt": "2016-02-20T02:09:47",
"content": {
"rendered": "<p>Hi, this is a comment.<br />\nTo delete a comment, just log in and view the post's comments. There you will have the option to edit or delete them.</p>\n"
},
"link": "http://src.wordpress-develop.dev/blog/2016/02/20/hello-world/#comment-1",
"status": "approved",
"type": "comment",
"author_avatar_urls": {
"24": "http://1.gravatar.com/avatar/?s=24&d=mm&r=g",
"48": "http://1.gravatar.com/avatar/?s=48&d=mm&r=g",
"96": "http://2.gravatar.com/avatar/?s=96&d=mm&r=g"
},
"_links": {
"self": [
{
"href": "http://src.wordpress-develop.dev/wp-json/wp/v2/comments/1"
}
],
"collection": [
{
"href": "http://src.wordpress-develop.dev/wp-json/wp/v2/comments"
}
],
"up": [
{
"embeddable": true,
"post_type": "post",
"href": "http://src.wordpress-develop.dev/wp-json/wp/v2/posts/1"
}
]
}
}
Modified Result
{
"id": 1,
"post": 1,
"parent": 0,
"author": 0,
"author_name": "Mr WordPress",
"author_url": "https://wordpress.org/",
"date": "2016-02-20T02:09:47",
"date_gmt": "2016-02-20T02:09:47",
"content": {
"rendered": "<p>Hi, this is a comment.<br />\nTo delete a comment, just log in and view the post's comments. There you will have the option to edit or delete them.</p>\n"
},
"link": "/blog/2016/02/20/hello-world/#comment-1",
"status": "approved",
"type": "comment",
"author_avatar_urls": {
"24": "http://2.gravatar.com/avatar/?s=24&d=mm&r=g",
"48": "http://1.gravatar.com/avatar/?s=48&d=mm&r=g",
"96": "http://0.gravatar.com/avatar/?s=96&d=mm&r=g"
},
"children_count": 0,
"date_formatted": "February 20, 2016 at 2:09 am",
"_links": {
"self": [
{
"href": "http://src.wordpress-develop.dev/wp-json/wp/v2/comments/1"
}
],
"collection": [
{
"href": "http://src.wordpress-develop.dev/wp-json/wp/v2/comments"
}
],
"up": [
{
"embeddable": true,
"post_type": "post",
"href": "http://src.wordpress-develop.dev/wp-json/wp/v2/posts/1"
}
]
}
}
Changelog
0.8.0
- Fix compatibility with WordPress 4.7
0.7.0
- Support custom taxonomies
0.6.0
0.5.0
0.4.0
0.3.0
- Strip
home_url() from menu items' url.
0.2.1
- Add
lang and html_dir to index's response
0.2.0
- Remove Menus & Post Formats (now as standalone plugins)
0.1.0
Wallogit.com
