get_post_type_archive_link() │ WP 3.1.0

Returns the URL (permalink) to the archive page of a custom post type.

For more details on which pages relate to "post_type_archive," see the description of the function is_post_type_archive()

If the function does not work or returns false, check if the argument has_archive => true is enabled when registering the post type.

Uses: get_post_type_object()
Hooks from the function

Returns

String|false. String: a link (URL) to the archive page of the specified post type. Will return false if the specified post type does not exist or if the has_archive parameter is not set for it.

If post is specified, it will return a link to the site's homepage or to the page specified in the admin as the "Posts page."

Usage

get_post_type_archive_link( $post_type );
$post_type(string) (required)
The name of the custom post type.

Examples

0

#1 Link to the archive page of the custom post type

Let's say we created a post type book with register_post_type(). Let's display a link to an archive page of this type (page with all posts of this type):

<a href="<?php echo get_post_type_archive_link('book'); ?>">Books</a>

Notes

  • Global. WP_Rewrite. $wp_rewrite WordPress rewrite component.

Changelog

Since 3.1.0 Introduced.
Since 4.5.0 Support for posts was added.

get_post_type_archive_link() code WP 7.0

wp-includes/link-template.php 
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 );
}

Archives (of posts)

Link (URL)

Custom Types