API index should include home URL

[iseulde]

Currently it is get_option( 'siteurl' ).

[rachelbaker]

Replying to iseulde:

Currently it is get_option( 'siteurl' ).

@iseulde where are you seeing this? get_rest_url uses get_home_url() to determine where the index and endpoints should be located.

[rmccue]

Replying to rachelbaker:

@iseulde where are you seeing this?

This is in the API index.

The use of siteurl is intentional, as it's intended to allow discovering the admin &c, but we should probably have a home value as well.

[rachelbaker]

@rmccue I don't think we should be exposing the site_url without authentication at all. That isn't public info.

In 35647.diff​ I changed the index to use home_url()

[rmccue]

Replying to rachelbaker:

That isn't public info.

I disagree; it's available through links to XML-RPC (<link rel="pingback />, <link rel="EditURI" />, <link rel="wlwmanifest" />), any bundled scripts (<script src="wp-includes/js/..." />), plus wp-content URLs if it hasn't been moved. There are ways to remove it, but you can also remove it from the index via filters.

(Also, changing it now would be a BC break.)

[Compute]

#36250 was marked as a duplicate.

[rachelbaker]

@rmccue Okay, so site_url is not blatantly obvious, but discoverable.
By using the generic url key, our only option here for adding the home_url would be to add another key to the index. Suggestions for the new key name? Just home_url?

[rachelbaker]

Add home_url key to index

[Compute]

To me it's kinda "wierd" that the "url" is siteurl. We mostly put WP in a subdirectory so that the /wp-json/ url key would be "domain.com/wp/" - a link that would just result in a 404.

But I guess that the name can't be changed now due to backwards compatibility.

[ocean90]

The version field indicates the first version in which the issue was present.

[rachelbaker]

In 37031:

REST API: Add home_url to API index to avoid confusion with site_url.

Confusion abound, the API index is the generic term url to display the site_url. New home key will display the home_url in the index as well.

Fixes #35647.