get_post_permalink() │ WP 3.0.0

Retrieves the permalink for a post of a custom post type.

Used By: get_permalink()

1 time — 0.000578 sec (slow) | 50000 times — 5 sec (fast)

Hooks from the function

post_type_link

Return

String|WP_Error. The post permalink.

Usage

get_post_permalink( $id, $leavename, $sample );

$id(int|WP_Post): Post ID or post object.
Default: global $post
$leavename(true|false): Whether to keep post name.
Default: false
$sample(true|false): Is it a sample permalink.
Default: false

Examples

#1 Display post types URLs

Let's display URLs of different post types and with different parameters.

// built-in post type
echo get_post_permalink( 1 ); // https://example.com/?post_type=post&p=1

// URL to custom post type
echo get_post_permalink( 225 ); // http://example.com/function/get_permalink

echo get_post_permalink( 225, true ); // http://example.com/function/%func%

#2 More Examples

See get_permalink() - wrapper function for this function.

Notes

Global. WP_Rewrite. $wp_rewrite WordPress rewrite component.

Changelog

Since 3.0.0

Introduced.

Code of `get_post_permalink() get post permalink` ^{WP 6.0.1}

wp-includes/link-template.php

function get_post_permalink( $id = 0, $leavename = false, $sample = false ) {
	global $wp_rewrite;

	$post = get_post( $id );

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

	$post_link = $wp_rewrite->get_extra_permastruct( $post->post_type );

	$slug = $post->post_name;

	$force_plain_link = wp_force_plain_post_permalink( $post );

	$post_type = get_post_type_object( $post->post_type );

	if ( $post_type->hierarchical ) {
		$slug = get_page_uri( $post );
	}

	if ( ! empty( $post_link ) && ( ! $force_plain_link || $sample ) ) {
		if ( ! $leavename ) {
			$post_link = str_replace( "%$post->post_type%", $slug, $post_link );
		}
		$post_link = home_url( user_trailingslashit( $post_link ) );
	} else {
		if ( $post_type->query_var && ( isset( $post->post_status ) && ! $force_plain_link ) ) {
			$post_link = add_query_arg( $post_type->query_var, $slug, '' );
		} else {
			$post_link = add_query_arg(
				array(
					'post_type' => $post->post_type,
					'p'         => $post->ID,
				),
				''
			);
		}
		$post_link = home_url( $post_link );
	}

	/**
	 * Filters the permalink for a post of a custom post type.
	 *
	 * @since 3.0.0
	 *
	 * @param string  $post_link The post's permalink.
	 * @param WP_Post $post      The post in question.
	 * @param bool    $leavename Whether to keep the post name.
	 * @param bool    $sample    Is it a sample permalink.
	 */
	return apply_filters( 'post_type_link', $post_link, $post, $leavename, $sample );
}