clean_url

Filters a string cleaned and escaped for output as a URL.

Description

apply_filters( 'clean_url', (string) $good_protocol_url, (string) $original_url, (string) $context ); 

Parameters (3)

0. $good_protocol_url (string)
The cleaned URL to be returned.
1. $original_url (string)
The URL prior to cleaning.
2. $context (string)
If display,, replace ampersands and single quotes only.

Usage

To run the hook, copy the example below.
  1. $good_protocol_url = apply_filters( 'clean_url', $good_protocol_url, $original_url, $context ); 
  2.  
  3. if ( !empty( $good_protocol_url ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the clean_url callback 
  2. function filter_clean_url( $good_protocol_url, $original_url, $context ) { 
  3. // make filter magic happen here... 
  4. return $good_protocol_url
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'clean_url', 'filter_clean_url', 10, 3 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'clean_url', 'filter_clean_url', 10, 3 ); 

Defined (1)

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

/wp-includes/formatting.php  
  1. return apply_filters( 'clean_url', $good_protocol_url, $original_url, $_context );