user_admin_url

Retrieves the URL to the admin area for the current user.

Description

(string) user_admin_url( (string) $path = '', (string) $scheme = 'admin' ); 

Returns (string)

Admin URL link with optional path appended.

Parameters (2)

0. $path — Optional. (string) => ''
Path relative to the admin URL. Default empty.
1. $scheme — Optional. (string) => 'admin'
The scheme to use. Default is admin,, which obeys force_ssl_admin(…) and is_ssl(…). http or https can be passed to force those schemes.

Usage

  1. if ( !function_exists( 'user_admin_url' ) ) { 
  2.     require_once ABSPATH . WPINC . '/link-template.php'; 
  3. } 
  4.   
  5. // Optional. Path relative to the admin URL. Default empty. 
  6. $path = ''; 
  7.   
  8. // Optional. The scheme to use. Default is 'admin', which obeys force_ssl_admin() 
  9. // and is_ssl(). 'http' or 'https' can be passed to force those schemes. 
  10. $scheme = 'admin'; 
  11.   
  12. // NOTICE! Understand what this does before running. 
  13. $result = user_admin_url($path, $scheme); 
  14.     

Defined (1)

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

/wp-includes/link-template.php  
  1. function user_admin_url( $path = '', $scheme = 'admin' ) { 
  2.     $url = network_site_url('wp-admin/user/', $scheme); 
  3.  
  4.     if ( $path && is_string( $path ) ) 
  5.         $url .= ltrim($path, '/'); 
  6.  
  7.     /** 
  8.      * Filters the user admin URL for the current user. 
  9.      * 
  10.      * @since 3.1.0 
  11.      * 
  12.      * @param string $url  The complete URL including scheme and path. 
  13.      * @param string $path Path relative to the URL. Blank string if 
  14.      *                     no path is specified. 
  15.      */ 
  16.     return apply_filters( 'user_admin_url', $url, $path ); 
  17. }