get_post_type_archive_link() – Function

Retrieves the permalink for a post type archive.

Parameters

$post_typestringrequired: Post type.

Return

string|false The post type archive permalink. False if the post type does not exist or does not have an archive.

Source

function get_post_type_archive_link( $post_type ) {
	global $wp_rewrite;

	$post_type_obj = get_post_type_object( $post_type );

	if ( ! $post_type_obj ) {
		return false;
	}

	if ( 'post' === $post_type ) {
		$show_on_front  = get_option( 'show_on_front' );
		$page_for_posts = get_option( 'page_for_posts' );

		if ( 'page' === $show_on_front && $page_for_posts ) {
			$link = get_permalink( $page_for_posts );
		} else {
			$link = get_home_url();
		}
		/** This filter is documented in wp-includes/link-template.php */
		return apply_filters( 'post_type_archive_link', $link, $post_type );
	}

	if ( ! $post_type_obj->has_archive ) {
		return false;
	}

	if ( get_option( 'permalink_structure' ) && is_array( $post_type_obj->rewrite ) ) {
		$struct = ( true === $post_type_obj->has_archive ) ? $post_type_obj->rewrite['slug'] : $post_type_obj->has_archive;
		if ( $post_type_obj->rewrite['with_front'] ) {
			$struct = $wp_rewrite->front . $struct;
		} else {
			$struct = $wp_rewrite->root . $struct;
		}
		$link = home_url( user_trailingslashit( $struct, 'post_type_archive' ) );
	} else {
		$link = home_url( '?post_type=' . $post_type );
	}

	/**
	 * Filters the post type archive permalink.
	 *
	 * @since 3.1.0
	 *
	 * @param string $link      The post type archive permalink.
	 * @param string $post_type Post type name.
	 */
	return apply_filters( 'post_type_archive_link', $link, $post_type );
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘post_type_archive_link’, string $link, string $post_type ): Filters the post type archive permalink.

Uses	Description
get_home_url()`wp-includes/link-template.php`	Retrieves the URL for a given site where the front end is accessible.
user_trailingslashit()`wp-includes/link-template.php`	Retrieves a trailing-slashed string if the site is set for adding trailing slashes.
home_url()`wp-includes/link-template.php`	Retrieves the URL for the current site where the front end is accessible.
get_permalink()`wp-includes/link-template.php`	Retrieves the full permalink for the current post or post ID.
apply_filters()`wp-includes/plugin.php`	Calls the callback functions that have been added to a filter hook.
get_option()`wp-includes/option.php`	Retrieves an option value based on an option name.
get_post_type_object()`wp-includes/post.php`	Retrieves a post type object by name.

Show 5 more Show less

Used by	Description
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::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_nav_menu_item_post_type_meta_box()`wp-admin/includes/nav-menu.php`	Displays a meta box for a post type menu item.
wp_list_categories()`wp-includes/category-template.php`	Displays or retrieves the HTML list of categories.
get_post_type_archive_feed_link()`wp-includes/link-template.php`	Retrieves the permalink for a post type archive feed.
wp_admin_bar_edit_menu()`wp-includes/admin-bar.php`	Provides an edit link for posts and terms.
wp_setup_nav_menu_item()`wp-includes/nav-menu.php`	Decorates a menu item object with the shared navigation menu item properties.

Show 2 more Show less

Changelog

Version	Description
4.5.0	Support for posts was added.
3.1.0	Introduced.

User Contributed Notes

Skip to note 4 content

nilshenrikj 4 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 8You must log in to vote on the helpfulness of this note

In the event that get_post_type_archive_link() does not work or returns false, double check if you have included the argument has_archive => true when registering your post type.

Log in to add feedback
Skip to note 5 content

Codex 9 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 4You must log in to vote on the helpfulness of this note
Example
```
<a href="<?php echo get_post_type_archive_link( 'movies' ); ?>">Movies Archive</a>
```
Log in to add feedback
Skip to note 6 content

Darshit Rajyaguru 9 months ago

You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note
This is the example for WordPress function that returns the URL of the archive page for a specific post type. It is used to retrieve the permalink for the post type’s archive. (For example, get the archive link for post type is “Book”)
```
$archive_link = get_post_type_archive_link( 'book' );

if ( $archive_link ) {
    echo 'Archive Link: <a href="' . esc_url( $archive_link ) . '" rel="nofollow ugc">Books Archive</a>';
} else {
    echo 'The "book" post type does not have an archive.';
}
```
Log in to add feedback

get_post_type_archive_link( string $post_type ): string|false

In this article

Parameters

Return

Source

Hooks

Changelog

User Contributed Notes

get_post_type_archive_link( string $post_type ): string|false

In this article

Parameters

Return

Source

Hooks

Related

Changelog

User Contributed Notes