admin_url

Filters the admin area URL.

Description

apply_filters( 'admin_url', (string) $url, (string) $path, (int|null) $blog_id ); 

Parameters (3)

0. $url (string)

The complete admin area URL including scheme and path.

1. $path (string)

Path relative to the admin area URL. Blank string if no path is specified.

2. $blog_id (int|null)

Site ID, or null for the current site.

Usage

To run the hook, copy the example below.

$url = apply_filters( 'admin_url', $url, $path, $blog_id ); 
                         
if ( !empty( $url ) ) { 
                         
   // everything has led up to this point... 
                         
} 
  

The following example is for adding a hook callback.

// define the admin_url callback 
function filter_admin_url( $url, $path, $blog_id ) { 
    // make filter magic happen here... 
    return $url; 
}; 
         
// add the filter 
add_filter( 'admin_url', 'filter_admin_url', 10, 3 ); 

To remove a hook callback, use the example below.

// remove the filter 
remove_filter( 'admin_url', 'filter_admin_url', 10, 3 );