get_term_link( WP_Term|int|string $term, string $taxonomy = '' ): string|WP_Error

Generates a permalink for a taxonomy term archive.

Contents

Parameters

$term WP_Term|int|string Required
The term object, ID, or slug whose link will be retrieved.
$taxonomy string Optional
Taxonomy.

Default: ''

Top ↑

Return

string|WP_Error URL of the taxonomy term archive on success, WP_Error if term does not exist.

Top ↑

More Information

  • Since the term can be an object, integer, or string, make sure that any numbers you pass in are explicitly converted to an integer (example: (int) $term_id). Otherwise the function will assume that $term is a slug instead of a term ID.
  • PHP may halt if you attempt to print an error result ("Catchable fatal error: Object of class WP_Error could not be converted to string"). You should always use is_wp_error() to check the result of this function, in case the term does not exist.

 

Top ↑

Source

File: wp-includes/taxonomy.php. View all references 

function get_term_link( $term, $taxonomy = '' ) {
	global $wp_rewrite;

	if ( ! is_object( $term ) ) {
		if ( is_int( $term ) ) {
			$term = get_term( $term, $taxonomy );
		} else {
			$term = get_term_by( 'slug', $term, $taxonomy );
		}
	}

	if ( ! is_object( $term ) ) {
		$term = new WP_Error( 'invalid_term', __( 'Empty Term.' ) );
	}

	if ( is_wp_error( $term ) ) {
		return $term;
	}

	$taxonomy = $term->taxonomy;

	$termlink = $wp_rewrite->get_extra_permastruct( $taxonomy );

	/**
	 * Filters the permalink structure for a term before token replacement occurs.
	 *
	 * @since 4.9.0
	 *
	 * @param string  $termlink The permalink structure for the term's taxonomy.
	 * @param WP_Term $term     The term object.
	 */
	$termlink = apply_filters( 'pre_term_link', $termlink, $term );

	$slug = $term->slug;
	$t    = get_taxonomy( $taxonomy );

	if ( empty( $termlink ) ) {
		if ( 'category' === $taxonomy ) {
			$termlink = '?cat=' . $term->term_id;
		} elseif ( $t->query_var ) {
			$termlink = "?$t->query_var=$slug";
		} else {
			$termlink = "?taxonomy=$taxonomy&term=$slug";
		}
		$termlink = home_url( $termlink );
	} else {
		if ( ! empty( $t->rewrite['hierarchical'] ) ) {
			$hierarchical_slugs = array();
			$ancestors          = get_ancestors( $term->term_id, $taxonomy, 'taxonomy' );
			foreach ( (array) $ancestors as $ancestor ) {
				$ancestor_term        = get_term( $ancestor, $taxonomy );
				$hierarchical_slugs[] = $ancestor_term->slug;
			}
			$hierarchical_slugs   = array_reverse( $hierarchical_slugs );
			$hierarchical_slugs[] = $slug;
			$termlink             = str_replace( "%$taxonomy%", implode( '/', $hierarchical_slugs ), $termlink );
		} else {
			$termlink = str_replace( "%$taxonomy%", $slug, $termlink );
		}
		$termlink = home_url( user_trailingslashit( $termlink, 'category' ) );
	}

	// Back compat filters.
	if ( 'post_tag' === $taxonomy ) {

		/**
		 * Filters the tag link.
		 *
		 * @since 2.3.0
		 * @since 2.5.0 Deprecated in favor of {@see 'term_link'} filter.
		 * @since 5.4.1 Restored (un-deprecated).
		 *
		 * @param string $termlink Tag link URL.
		 * @param int    $term_id  Term ID.
		 */
		$termlink = apply_filters( 'tag_link', $termlink, $term->term_id );
	} elseif ( 'category' === $taxonomy ) {

		/**
		 * Filters the category link.
		 *
		 * @since 1.5.0
		 * @since 2.5.0 Deprecated in favor of {@see 'term_link'} filter.
		 * @since 5.4.1 Restored (un-deprecated).
		 *
		 * @param string $termlink Category link URL.
		 * @param int    $term_id  Term ID.
		 */
		$termlink = apply_filters( 'category_link', $termlink, $term->term_id );
	}

	/**
	 * Filters the term link.
	 *
	 * @since 2.5.0
	 *
	 * @param string  $termlink Term link URL.
	 * @param WP_Term $term     Term object.
	 * @param string  $taxonomy Taxonomy slug.
	 */
	return apply_filters( 'term_link', $termlink, $term, $taxonomy );
}

View on Trac View on GitHub

Top ↑

Hooks

Top ↑

Top ↑

Uses

Uses
Uses Description
get_ancestors() wp-includes/taxonomy.php

Gets an array of ancestor IDs for a given object.
get_term_by() wp-includes/taxonomy.php

Gets all term data from database by term field and data.
user_trailingslashit() wp-includes/link-template.php

Retrieves a trailing-slashed string if the site is set for adding trailing slashes.
WP_Rewrite::get_extra_permastruct() wp-includes/class-wp-rewrite.php

Retrieves an extra permalink structure by name.
__() wp-includes/l10n.php

Retrieves the translation of $text.
get_term() wp-includes/taxonomy.php

Gets all term data from database by term ID.
get_taxonomy() wp-includes/taxonomy.php

Retrieves the taxonomy object of $taxonomy.
home_url() wp-includes/link-template.php

Retrieves the URL for the current site where the front end is accessible.
apply_filters() wp-includes/plugin.php

Calls the callback functions that have been added to a filter hook.
is_wp_error() wp-includes/load.php

Checks whether the given variable is a WordPress Error.
WP_Error::__construct() wp-includes/class-wp-error.php

Initializes the error.
Show 7 more uses Hide more uses

Top ↑

Used By

Used By
Used By Description
WP_REST_Term_Search_Handler::prepare_item() wp-includes/rest-api/search/class-wp-rest-term-search-handler.php

Prepares the search result for a given ID.
WP_Sitemaps_Taxonomies::get_url_list() wp-includes/sitemaps/providers/class-wp-sitemaps-taxonomies.php

Gets a URL list for a taxonomy sitemap.
get_term_parents_list() wp-includes/category-template.php

Retrieves term parents with separator.
WP_REST_Terms_Controller::prepare_item_for_response() wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php

Prepares a single term output for response.
WP_Customize_Nav_Menu_Item_Setting::value_as_wp_post_nav_menu_item() wp-includes/customize/class-wp-customize-nav-menu-item-setting.php

Get the value emulated into a WP_Post and set up as a nav_menu_item.
WP_Customize_Nav_Menus::search_available_items_query() wp-includes/class-wp-customize-nav-menus.php

Performs post queries for available-item searching.
WP_Customize_Nav_Menus::load_available_items_query() wp-includes/class-wp-customize-nav-menus.php

Performs the post_type and taxonomy queries for loading available menu items.
WP_Terms_List_Table::handle_row_actions() wp-admin/includes/class-wp-terms-list-table.php

Generates and displays row action links.
Walker_Category::start_el() wp-includes/class-walker-category.php

Starts the element output.
get_the_term_list() wp-includes/category-template.php

Retrieves a post’s terms as a list with specified format.
wp_tag_cloud() wp-includes/category-template.php

Displays a tag cloud.
get_category_link() wp-includes/category-template.php

Retrieves category link URL.
get_the_taxonomies() wp-includes/taxonomy.php

Retrieves all taxonomies associated with a post.
get_term_feed_link() wp-includes/link-template.php

Retrieves the feed link for a term.
wp_admin_bar_edit_menu() wp-includes/admin-bar.php

Provides an edit link for posts and terms.
redirect_canonical() wp-includes/canonical.php

Redirects incoming links to the proper URL based on the site url.
get_post_format_link() wp-includes/post-formats.php

Returns a link to a post format index.
wp_setup_nav_menu_item() wp-includes/nav-menu.php

Decorates a menu item object with the shared navigation menu item properties.
Show 13 more used by Hide more used by

Top ↑

Changelog

Changelog
Version Description
2.5.0 Introduced.

Top ↑

User Contributed Notes

  1. Skip to note 1 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 10You must log in to vote on the helpfulness of this note
    Contributed by Codex — 
    $terms = get_terms( 'species' );

echo '<ul>';

foreach ( $terms as $term ) {

    // The $term is an object, so we don't need to specify the $taxonomy.
    $term_link = get_term_link( $term );
   
    // If there was an error, continue to the next term.
    if ( is_wp_error( $term_link ) ) {
        continue;
    }

    // We successfully got a link. Print it out.
    echo '<li><a href="' . esc_url( $term_link ) . '">' . $term->name . '</a></li>';
}

echo '</ul>';
  2. Skip to note 2 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
    Contributed by Ravi Khadka —

    /* check term and error */

    $dr_terms = get_terms( 'your_term_name' );
if ( ! is_wp_error( $dr_terms ) && ! empty( $dr_terms ) ) {
    echo '<ul class="your-class-name">';
    foreach ( $dr_terms as $dr_term ) {
        echo '<li><a href="' . get_term_link( $dr_term->slug, 'your_term_name' ) . '">' . __( $term->name ) . '</a></li>';
    }
    echo '</ul>';
}

You must log in before being able to contribute a note or feedback.