get_post_permalink( int|WP_Post $id, bool $leavename = false, bool $sample = false )
Retrieves the permalink for a post of a custom post type.
Parameters
- $id
-
(Optional) Post ID or post object. Default is the global
$post
. - $leavename
-
(Optional) defaults to false. Whether to keep post name.
Default value: false
- $sample
-
(Optional) defaults to false. Is it a sample permalink.
Default value: false
Return
(string|WP_Error) The post permalink.
Source
File: 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;
$draft_or_pending = get_post_status( $post ) && in_array( get_post_status( $post ), array( 'draft', 'pending', 'auto-draft', 'future' ) );
$post_type = get_post_type_object($post->post_type);
if ( $post_type->hierarchical ) {
$slug = get_page_uri( $post );
}
if ( !empty($post_link) && ( !$draft_or_pending || $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) && !$draft_or_pending ) )
$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 WP-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 );
}
Changelog
Version | Description |
---|---|
WP-3.0.0 | Introduced. |