Changeset 51973

Timestamp:

11/02/2021 12:46:01 PM (3 years ago)

Author:

hellofromTonya

Message:

REST API: Add URL Details endpoint.

Adds a new REST API endpoint (/wp-block-editor/v1/url-details) for retrieving information from an external URL.

Information retrieved:

• Title: content of the <title> element
• Icon: favicon image link
• Description: content of the description or og:description meta element
• Image: OG image link

This endpoint is used by the block editor for link previews.

Props get_dave, aduth, andraganescu, beaulebens, hellofromTonya, kevin940726, mamaduka, marekhrabe, mnelson4, noisysocks, obenland, ocean90, retrofox, shaunandrews, spacedmonkey, swissspidy, timothyblynjacobs, xknown, youknowriad.
Fixes #54358.

Location:

trunk

Files:

• src/wp-includes/rest-api.php (modified) (1 diff)
• src/wp-includes/rest-api/endpoints/class-wp-rest-url-details-controller.php (added)
• src/wp-settings.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/wpRestUrlDetailsController.php (added)
• tests/qunit/fixtures/wp-api-generated.js (modified) (2 diffs)

trunk/src/wp-includes/rest-api.php

@@ -337 +337 @@
     $site_health = WP_Site_Health::get_instance();
     $controller  = new WP_REST_Site_Health_Controller( $site_health );
+    $controller->register_routes();
+
+    // URL Details.
+    $controller = new WP_REST_URL_Details_Controller();
     $controller->register_routes();
 }

trunk/src/wp-settings.php

@@ -277 +277 @@
 require ABSPATH . WPINC . '/rest-api/endpoints/class-wp-rest-widgets-controller.php';
 require ABSPATH . WPINC . '/rest-api/endpoints/class-wp-rest-templates-controller.php';
+require ABSPATH . WPINC . '/rest-api/endpoints/class-wp-rest-url-details-controller.php';
 require ABSPATH . WPINC . '/rest-api/fields/class-wp-rest-meta-fields.php';
 require ABSPATH . WPINC . '/rest-api/fields/class-wp-rest-comment-meta-fields.php';

trunk/tests/qunit/fixtures/wp-api-generated.js

@@ -16 +16 @@
         "oembed/1.0",
         "wp/v2",
-        "wp-site-health/v1"
+        "wp-site-health/v1",
+        "wp-block-editor/v1"
     ],
     "authentication": [],
@@ -7539 +7540 @@
                 ]
             }
+        },
+        "/wp-block-editor/v1": {
+            "namespace": "wp-block-editor/v1",
+            "methods": [
+                "GET"
+            ],
+            "endpoints": [
+                {
+                    "methods": [
+                        "GET"
+                    ],
+                    "args": {
+                        "namespace": {
+                            "default": "wp-block-editor/v1",
+                            "required": false
+                        },
+                        "context": {
+                            "default": "view",
+                            "required": false
+                        }
+                    }
+                }
+            ],
+            "_links": {
+                "self": [
+                    {
+                        "href": "http://example.org/index.php?rest_route=/wp-block-editor/v1"
+                    }
+                ]
+            }
+        },
+        "/wp-block-editor/v1/url-details": {
+            "namespace": "wp-block-editor/v1",
+            "methods": [
+                "GET"
+            ],
+            "endpoints": [
+                {
+                    "methods": [
+                        "GET"
+                    ],
+                    "args": {
+                        "url": {
+                            "description": "The URL to process.",
+                            "type": "string",
+                            "format": "uri",
+                            "required": true
+                        }
+                    }
+                }
+            ],
+            "_links": {
+                "self": [
+                    {
+                        "href": "http://example.org/index.php?rest_route=/wp-block-editor/v1/url-details"
+                    }
+                ]
+            }
         }
     },