Changeset 35274

Timestamp:

10/19/2015 10:38:03 PM (9 years ago)

Author:

DrewAPicture

Message:

Docs: Update the default scheme for get_rest_url() from 'json' to 'rest'.

Also adds 'rest' to the documented list of schemes for home_url(), get_home_url(), set_url_scheme(), and the home_url and set_url_scheme hooks.

Props rachelbaker.
Fixes #34300.

Location:

trunk/src/wp-includes

Files:

• link-template.php (modified) (5 diffs)
• rest-api/rest-functions.php (modified) (1 diff)

trunk/src/wp-includes/link-template.php

@@ -2921 +2921 @@
  * @since 3.0.0
  *
- * @param  string $path   Optional. Path relative to the home url. Default empty.
- * @param  string $scheme Optional. Scheme to give the home url context. Accepts
- *                        'http', 'https', or 'relative'. Default null.
+ * @param  string      $path   Optional. Path relative to the home url. Default empty.
+ * @param  string|null $scheme Optional. Scheme to give the home url context. Accepts
+ *                             'http', 'https', 'relative', 'rest', or null. Default null.
  * @return string Home url link with optional path appended.
 */
@@ -2945 +2945 @@
  * @param  string      $path        Optional. Path relative to the home URL. Default empty.
  * @param  string|null $orig_scheme Optional. Scheme to give the home URL context. Accepts
- *                                  'http', 'https', 'relative', or null. Default null.
+ *                                  'http', 'https', 'relative', 'rest', or null. Default null.
  * @return string Home URL link with optional path appended.
 */
@@ -2980 +2980 @@
      * @param string      $url         The complete home URL including scheme and path.
      * @param string      $path        Path relative to the home URL. Blank string if no path is specified.
-     * @param string|null $orig_scheme Scheme to give the home URL context. Accepts 'http', 'https', 'relative' or null.
+     * @param string|null $orig_scheme Scheme to give the home URL context. Accepts 'http', 'https',
+     *                                 'relative', 'rest', or null.
      * @param int|null    $blog_id     Blog ID, or null for the current blog.
      */
@@ -3357 +3358 @@
 
 /**
- * Set the scheme for a URL
+ * Sets the scheme for a URL.
  *
  * @since 3.4.0
- *
- * @param string $url    Absolute url that includes a scheme
- * @param string $scheme Optional. Scheme to give $url. Currently 'http', 'https', 'login', 'login_post', 'admin', or 'relative'.
+ * @since 4.4.0 The 'rest' scheme was added.
+ *
+ * @param string      $url    Absolute url that includes a scheme
+ * @param string|null $scheme Optional. Scheme to give $url. Currently 'http', 'https', 'login',
+ *                            'login_post', 'admin', 'relative', 'rest', 'rpc', or null. Default null.
  * @return string $url URL with chosen scheme.
  */
@@ -3393 +3396 @@
      * @since 3.4.0
      *
-     * @param string $url         The complete URL including scheme and path.
-     * @param string $scheme      Scheme applied to the URL. One of 'http', 'https', or 'relative'.
-     * @param string $orig_scheme Scheme requested for the URL. One of 'http', 'https', 'login',
-     *                            'login_post', 'admin', 'rpc', or 'relative'.
+     * @param string      $url         The complete URL including scheme and path.
+     * @param string      $scheme      Scheme applied to the URL. One of 'http', 'https', or 'relative'.
+     * @param string|null $orig_scheme Scheme requested for the URL. One of 'http', 'https', 'login',
+     *                                 'login_post', 'admin', 'relative', 'rest', 'rpc', or null.
      */
     return apply_filters( 'set_url_scheme', $url, $scheme, $orig_scheme );

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

@@ -236 +236 @@
  * @param int    $blog_id Optional. Blog ID. Default of null returns URL for current blog.
  * @param string $path    Optional. REST route. Default '/'.
- * @param string $scheme  Optional. Sanitization scheme. Default 'json'.
+ * @param string $scheme  Optional. Sanitization scheme. Default 'rest'.
  * @return string Full URL to the endpoint.
  */
-function get_rest_url( $blog_id = null, $path = '/', $scheme = 'json' ) {
+function get_rest_url( $blog_id = null, $path = '/', $scheme = 'rest' ) {
     if ( empty( $path ) ) {
         $path = '/';