get_rest_url

Retrieves the URL to a REST endpoint on a site.

Description

(string) get_rest_url( (constant) $blog_id = null, (string) $path = '/', (string) $scheme = 'rest' ); 

Note: The returned URL is NOT escaped.

Returns (string)

Full URL to the endpoint.

Parameters (3)

0. $blog_id — Optional. (constant) => null
Blog ID. Default of null returns URL for current blog.
1. $path — Optional. (string) => '/'
REST route. Default /..
2. $scheme — Optional. (string) => 'rest'
Sanitization scheme. Default rest..

Usage

  1. if ( !function_exists( 'get_rest_url' ) ) { 
  2.     require_once ABSPATH . WPINC . '/rest-api.php'; 
  3. } 
  4.   
  5. // Optional. Blog ID. Default of null returns URL for current blog. 
  6. $blog_id = null; 
  7.   
  8. // Optional. REST route. Default '/'. 
  9. $path = '/'; 
  10.   
  11. // Optional. Sanitization scheme. Default 'rest'. 
  12. $scheme = 'rest'; 
  13.   
  14. // NOTICE! Understand what this does before running. 
  15. $result = get_rest_url($blog_id, $path, $scheme); 
  16.     

Defined (1)

The function is defined in the following location(s).

/wp-includes/rest-api.php  
  1. function get_rest_url( $blog_id = null, $path = '/', $scheme = 'rest' ) { 
  2.     if ( empty( $path ) ) { 
  3.         $path = '/'; 
  4.     } 
  5.  
  6.     if ( is_multisite() && get_blog_option( $blog_id, 'permalink_structure' ) || get_option( 'permalink_structure' ) ) { 
  7.         global $wp_rewrite; 
  8.  
  9.         if ( $wp_rewrite->using_index_permalinks() ) { 
  10.             $url = get_home_url( $blog_id, $wp_rewrite->index . '/' . rest_get_url_prefix(), $scheme ); 
  11.         } else { 
  12.             $url = get_home_url( $blog_id, rest_get_url_prefix(), $scheme ); 
  13.         } 
  14.  
  15.         $url .= '/' . ltrim( $path, '/' ); 
  16.     } else { 
  17.         $url = trailingslashit( get_home_url( $blog_id, '', $scheme ) ); 
  18.  
  19.         $path = '/' . ltrim( $path, '/' ); 
  20.  
  21.         $url = add_query_arg( 'rest_route', $path, $url ); 
  22.     } 
  23.  
  24.     if ( is_ssl() ) { 
  25.         // If the current host is the same as the REST URL host, force the REST URL scheme to HTTPS. 
  26.         if ( $_SERVER['SERVER_NAME'] === parse_url( get_home_url( $blog_id ), PHP_URL_HOST ) ) { 
  27.             $url = set_url_scheme( $url, 'https' ); 
  28.         } 
  29.     } 
  30.  
  31.     /** 
  32.      * Filters the REST URL. 
  33.      * 
  34.      * Use this filter to adjust the url returned by the get_rest_url() function. 
  35.      * 
  36.      * @since 4.4.0 
  37.      * 
  38.      * @param string $url     REST URL. 
  39.      * @param string $path    REST route. 
  40.      * @param int    $blog_id Blog ID. 
  41.      * @param string $scheme  Sanitization scheme. 
  42.      */ 
  43.     return apply_filters( 'rest_url', $url, $path, $blog_id, $scheme ); 
  44. }