edit_term_link

Displays or retrieves the edit term link with formatting.

Description

(string|void) edit_term_link( (string) $link = '', (string) $before = '', (string) $after = '', (constant) $term = null, (bool) $echo = true ); 

Returns (string|void)

HTML content.

Parameters (5)

0. $link — Optional. (string) => ''
Anchor text. Default empty.
1. $before — Optional. (string) => ''
Display before edit link. Default empty.
2. $after — Optional. (string) => ''
Display after edit link. Default empty.
3. $term — Optional. (constant) => null
Term object. If null, the queried object will be inspected. Default null.
4. $echo — Optional. (bool) => true
Whether or not to echo the return. Default true.

Usage

  1. if ( !function_exists( 'edit_term_link' ) ) { 
  2.     require_once ABSPATH . WPINC . '/link-template.php'; 
  3. } 
  4.   
  5. // Optional. Anchor text. Default empty. 
  6. $link = ''; 
  7.   
  8. // Optional. Display before edit link. Default empty. 
  9. $before = ''; 
  10.   
  11. // Optional. Display after edit link. Default empty. 
  12. $after = ''; 
  13.   
  14. // Optional. Term object. If null, the queried object will be inspected. Default null. 
  15. $term = null; 
  16.   
  17. // Optional. Whether or not to echo the return. Default true. 
  18. $echo = true; 
  19.   
  20. // NOTICE! Understand what this does before running. 
  21. $result = edit_term_link($link, $before, $after, $term, $echo); 
  22.     

Defined (1)

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

/wp-includes/link-template.php  
  1. function edit_term_link( $link = '', $before = '', $after = '', $term = null, $echo = true ) { 
  2.     if ( is_null( $term ) ) 
  3.         $term = get_queried_object(); 
  4.  
  5.     if ( ! $term ) 
  6.         return; 
  7.  
  8.     $tax = get_taxonomy( $term->taxonomy ); 
  9.     if ( ! current_user_can( 'edit_term', $term->term_id ) ) { 
  10.         return; 
  11.     } 
  12.  
  13.     if ( empty( $link ) ) 
  14.         $link = __('Edit This'); 
  15.  
  16.     $link = '<a href="' . get_edit_term_link( $term->term_id, $term->taxonomy ) . '">' . $link . '</a>'; 
  17.  
  18.     /** 
  19.      * Filters the anchor tag for the edit link of a term. 
  20.      * 
  21.      * @since 3.1.0 
  22.      * 
  23.      * @param string $link    The anchor tag for the edit link. 
  24.      * @param int    $term_id Term ID. 
  25.      */ 
  26.     $link = $before . apply_filters( 'edit_term_link', $link, $term->term_id ) . $after; 
  27.  
  28.     if ( $echo ) 
  29.         echo $link; 
  30.     else 
  31.         return $link; 
  32. }