get_permalink( int|WP_Post $post, bool $leavename = false )

Retrieves the full permalink for the current post or post ID.

Contents

Description Description

Parameters Parameters

$post

(int|WP_Post) (Optional) Post ID or post object. Default is the global $post.

$leavename

(bool) (Optional) Whether to keep post name or page name.

Default value: false

Top ↑

Return Return

(string|false) The permalink URL or false if post does not exist.

Top ↑

Source Source

File: wp-includes/link-template.php

119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
function get_permalink( $post = 0, $leavename = false ) {
    $rewritecode = array(
        '%year%',
        '%monthnum%',
        '%day%',
        '%hour%',
        '%minute%',
        '%second%',
        $leavename ? '' : '%postname%',
        '%post_id%',
        '%category%',
        '%author%',
        $leavename ? '' : '%pagename%',
    );
 
    if ( is_object( $post ) && isset( $post->filter ) && 'sample' == $post->filter ) {
        $sample = true;
    } else {
        $post   = get_post( $post );
        $sample = false;
    }
 
    if ( empty( $post->ID ) ) {
        return false;
    }
 
    if ( $post->post_type == 'page' ) {
        return get_page_link( $post, $leavename, $sample );
    } elseif ( $post->post_type == 'attachment' ) {
        return get_attachment_link( $post, $leavename );
    } elseif ( in_array( $post->post_type, get_post_types( array( '_builtin' => false ) ) ) ) {
        return get_post_permalink( $post, $leavename, $sample );
    }
 
    $permalink = get_option( 'permalink_structure' );
 
    /**
     * Filters the permalink structure for a post before token replacement occurs.
     *
     * Only applies to posts with post_type of 'post'.
     *
     * @since 3.0.0
     *
     * @param string  $permalink The site's permalink structure.
     * @param WP_Post $post      The post in question.
     * @param bool    $leavename Whether to keep the post name.
     */
    $permalink = apply_filters( 'pre_post_link', $permalink, $post, $leavename );
 
    if ( '' != $permalink && ! in_array( $post->post_status, array( 'draft', 'pending', 'auto-draft', 'future' ) ) ) {
        $unixtime = strtotime( $post->post_date );
 
        $category = '';
        if ( strpos( $permalink, '%category%' ) !== false ) {
            $cats = get_the_category( $post->ID );
            if ( $cats ) {
                $cats = wp_list_sort(
                    $cats,
                    array(
                        'term_id' => 'ASC',
                    )
                );
 
                /**
                 * Filters the category that gets used in the %category% permalink token.
                 *
                 * @since 3.5.0
                 *
                 * @param WP_Term  $cat  The category to use in the permalink.
                 * @param array    $cats Array of all categories (WP_Term objects) associated with the post.
                 * @param WP_Post  $post The post in question.
                 */
                $category_object = apply_filters( 'post_link_category', $cats[0], $cats, $post );
 
                $category_object = get_term( $category_object, 'category' );
                $category        = $category_object->slug;
                if ( $category_object->parent ) {
                    $category = get_category_parents( $category_object->parent, false, '/', true ) . $category;
                }
            }
            // show default category in permalinks, without
            // having to assign it explicitly
            if ( empty( $category ) ) {
                $default_category = get_term( get_option( 'default_category' ), 'category' );
                if ( $default_category && ! is_wp_error( $default_category ) ) {
                    $category = $default_category->slug;
                }
            }
        }
 
        $author = '';
        if ( strpos( $permalink, '%author%' ) !== false ) {
            $authordata = get_userdata( $post->post_author );
            $author     = $authordata->user_nicename;
        }
 
        $date           = explode( ' ', date( 'Y m d H i s', $unixtime ) );
        $rewritereplace =
        array(
            $date[0],
            $date[1],
            $date[2],
            $date[3],
            $date[4],
            $date[5],
            $post->post_name,
            $post->ID,
            $category,
            $author,
            $post->post_name,
        );
        $permalink      = home_url( str_replace( $rewritecode, $rewritereplace, $permalink ) );
        $permalink      = user_trailingslashit( $permalink, 'single' );
    } else { // if they're not using the fancy permalink option
        $permalink = home_url( '?p=' . $post->ID );
    }
 
    /**
     * Filters the permalink for a post.
     *
     * Only applies to posts with post_type of 'post'.
     *
     * @since 1.5.0
     *
     * @param string  $permalink The post's permalink.
     * @param WP_Post $post      The post in question.
     * @param bool    $leavename Whether to keep the post name.
     */
    return apply_filters( 'post_link', $permalink, $post, $leavename );
}

Expand full source code Collapse full source code View on Trac

Top ↑

Changelog Changelog

Changelog
Version Description
1.0.0 Introduced.

Top ↑

More Information More Information

In a Plugin or Theme, it can be used as early as the setup_theme Action. Any earlier usage, including plugins_loaded, generates a Fatal Error.

Note that when used outside The Loop on a posts page (index, archive, etc.) without the ID parameter, it will return the URL of the last post in The Loop, not the permalink for the current page.

Top ↑

Top ↑

Uses Uses

Uses
Uses Description
wp-includes/functions.php: wp_list_sort()

Sorts a list of objects, based on one or more orderby arguments.
wp-includes/category-template.php: get_the_category()

Retrieve post categories.
wp-includes/category-template.php: get_category_parents()

Retrieve category parents with separator.
wp-includes/pluggable.php: get_userdata()

Retrieve user info by user ID.
wp-includes/taxonomy.php: get_term()

Get all Term data from database by Term ID.
wp-includes/link-template.php: home_url()

Retrieves the URL for the current site where the front end is accessible.
wp-includes/link-template.php: get_page_link()

Retrieves the permalink for the current page or page ID.
wp-includes/link-template.php: get_attachment_link()

Retrieves the permalink for an attachment.
wp-includes/link-template.php: get_post_permalink()

Retrieves the permalink for a post of a custom post type.
wp-includes/link-template.php: pre_post_link

Filters the permalink structure for a post before token replacement occurs.
wp-includes/link-template.php: post_link_category

Filters the category that gets used in the %category% permalink token.
wp-includes/link-template.php: post_link

Filters the permalink for a post.
wp-includes/link-template.php: user_trailingslashit()

Retrieves a trailing-slashed string if the site is set for adding trailing slashes.
wp-includes/plugin.php: apply_filters()

Call the functions added to a filter hook.
wp-includes/option.php: get_option()

Retrieves an option value based on an option name.
wp-includes/post.php: get_post()

Retrieves post data given a post ID or post object.
wp-includes/post.php: get_post_types()

Get a list of all registered post type objects.
wp-includes/load.php: is_wp_error()

Check whether variable is a WordPress Error.
Show 13 more uses Hide more uses

Top ↑

Used By Used By

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

Prepares the search result for a given ID.
wp-includes/blocks/latest-posts.php: render_block_core_latest_posts()

Renders the core/latest-posts block on server.
wp-includes/link-template.php: get_privacy_policy_url()

Retrieves the URL to the privacy policy page.
wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php: WP_REST_Posts_Controller::prepare_item_for_response()

Prepares a single post output for response.
wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php: WP_REST_Posts_Controller::get_item()

Retrieves a single post.
wp-includes/class-wp-customize-nav-menus.php: WP_Customize_Nav_Menus::ajax_insert_auto_draft_post()

Ajax handler for adding a new auto-draft post.
wp-includes/link-template.php: wp_get_canonical_url()

Returns the canonical URL for a post.
wp-includes/embed.php: wp_embed_excerpt_more()

Filters the string in the ‘more’ link displayed after a trimmed excerpt.
wp-includes/embed.php: wp_oembed_add_discovery_links()

Adds oEmbed discovery links in the website .
wp-includes/embed.php: get_post_embed_url()

Retrieves the URL to embed a specific post in an iframe.
wp-includes/embed.php: get_post_embed_html()

Retrieves the embed code for a specific post.
wp-includes/link-template.php: get_preview_post_link()

Retrieves the URL used for the post preview.
wp-includes/customize/class-wp-customize-nav-menu-item-setting.php: WP_Customize_Nav_Menu_Item_Setting::value_as_wp_post_nav_menu_item()

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

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

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

Generates and displays row action links.
wp-admin/includes/upgrade.php: wp_install_maybe_enable_pretty_permalinks()

Maybe enable pretty permalinks on installation.
wp-admin/includes/dashboard.php: wp_dashboard_recent_posts()

Generates Publishing Soon and Recently Published sections.
wp-admin/includes/media.php: get_media_item()

Retrieve HTML form for modifying the image attachment.
wp-admin/includes/post.php: get_sample_permalink_html()

Returns the HTML of the sample permalink slug editor.
wp-admin/includes/post.php: get_sample_permalink()

Get a sample permalink based off of the post name.
wp-admin/includes/class-wp-media-list-table.php: WP_Media_List_Table::_get_row_actions()
wp-admin/includes/class-wp-comments-list-table.php: WP_Comments_List_Table::column_response()
wp-includes/category-template.php: wp_list_categories()

Display or retrieve the HTML list of categories.
wp-includes/pluggable.php: wp_notify_postauthor()

Notify an author (and/or others) of a comment/trackback/pingback on a post.
wp-includes/pluggable.php: wp_notify_moderator()

Notifies the moderator of the site about a new comment that is awaiting approval.
wp-includes/general-template.php: wp_get_archives()

Display archive links based on type and format.
wp-includes/deprecated.php: get_boundary_post_rel_link()

Get boundary post relational link.
wp-includes/deprecated.php: get_parent_post_rel_link()

Get parent post relational link.
wp-includes/deprecated.php: previous_post()

Prints a link to the previous post.
wp-includes/deprecated.php: next_post()

Prints link to the next post.
wp-includes/query.php: wp_old_slug_redirect()

Redirect old slugs to the correct permalink.
wp-includes/link-template.php: get_comments_pagenum_link()

Retrieves the comments page number link.
wp-includes/link-template.php: paginate_comments_links()

Displays or retrieves pagination links for the comments on the current post.
wp-includes/link-template.php: get_adjacent_post_link()

Retrieves the adjacent post link.
wp-includes/link-template.php: get_adjacent_post_rel_link()

Retrieves the adjacent post relational link.
wp-includes/link-template.php: get_post_type_archive_link()

Retrieves the permalink for a post type archive.
wp-includes/link-template.php: get_post_comments_feed_link()

Retrieves the permalink for the post comments feed.
wp-includes/link-template.php: get_the_permalink()

Retrieves the full permalink for the current post or post ID.
wp-includes/link-template.php: get_attachment_link()

Retrieves the permalink for an attachment.
wp-includes/deprecated.php: post_permalink()

Retrieve permalink from post ID.
wp-includes/link-template.php: the_permalink()

Displays the permalink for the current post.
wp-includes/admin-bar.php: wp_admin_bar_edit_menu()

Provide an edit link for posts and terms.
wp-includes/feed.php: the_permalink_rss()

Display the permalink to the post for use in feeds.
wp-includes/class-walker-page.php: Walker_Page::start_el()

Outputs the beginning of the current element in the tree.
wp-includes/post-template.php: _wp_link_page()

Helper function for wp_link_pages().
wp-includes/post-template.php: get_the_content()

Retrieve the post content.
wp-includes/post.php: _transition_post_status()

Hook for managing future post transitions to published.
wp-includes/post.php: wp_insert_post()

Insert or update a post.
wp-includes/canonical.php: redirect_guess_404_permalink()

Attempts to guess the correct URL based on query vars
wp-includes/canonical.php: redirect_canonical()

Redirects incoming links to the proper URL based on the site url.
wp-includes/ms-functions.php: get_blog_permalink()

Get the permalink for a post on another blog.
wp-includes/nav-menu.php: wp_setup_nav_menu_item()

Decorates a menu item object with the shared navigation menu item properties.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::mw_getPost()

Retrieve post.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::mw_getRecentPosts()

Retrieve list of recent posts.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::_prepare_page()

Prepares page data for return in an XML-RPC object.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::_prepare_post()

Prepares post data for return in an XML-RPC object.
wp-includes/comment-template.php: get_post_reply_link()

Retrieve HTML content for reply to post link.
wp-includes/comment-template.php: comment_form()

Outputs a complete commenting form for use within a template.
wp-includes/comment-template.php: get_trackback_url()

Retrieve The current post’s trackback URL.
wp-includes/comment-template.php: comments_popup_link()

Displays the link to the comments for the current post ID.
wp-includes/comment-template.php: get_comment_reply_link()

Retrieve HTML content for reply to comment link.
wp-includes/comment-template.php: get_comment_link()

Retrieve the link to a given comment.
wp-includes/comment-template.php: get_comments_link()

Retrieves the link to the current post comments.
wp-includes/comment.php: trackback()

Send a Trackback.
wp-includes/comment.php: pingback()

Pings back the links found in a post.
wp-includes/class-wp-editor.php: _WP_Editors::wp_link_query()

Performs post queries for internal linking.
Show 62 more used by Hide more used by

Top ↑

User Contributed Notes 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: 7You must log in to vote on the helpfulness of this note
    Contributed by Codex —

    Pass in a post object instead of an ID
    This shows how you can you can get the permalink with the page title instead of the ID.

    1
    <a href="<?php echo esc_url( get_permalink( get_page_by_title( 'Monthly Events' ) ) ); ?>"><?php esc_html_e( 'Monthly Events', 'textdomain' ); ?></a>
  2. Skip to note 2 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 3You must log in to vote on the helpfulness of this note
    Contributed by stratboy —

    Get post or page (or whatever) permalink by slug:

    1
    2
    3
    4
    function get_link_by_slug($slug, $type = 'post'){
      $post = get_page_by_path($slug, OBJECT, $type);
      return get_permalink($post->ID);
    }

    If you are using polylang (like I usually do), you can get the permalink starting from whichever language slug (I generally start from my language, usually the websites’s default):

    1
    2
    3
    4
    5
    function get_link_by_slug($slug, $lang_slug = null, $type = 'post'){
      $post = get_page_by_path($slug, OBJECT, $type);
      $id = ($lang_slug) ? pll_get_post($post->ID, $lang_slug) : $post->ID;
      return get_permalink($id);
    }
  4. Skip to note 4 content
    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
    Contributed by Codex —

    Link to Specific Post
    Returns the permalinks of two specific posts (post IDs 1 and 10) as hypertext links within an informational list.

    1
    2
    3
    4
    5
    6
    7
    8
    <ul>
        <li><?php esc_html_e( 'MyBlog info:', 'textdomain' ); ?>
            <ul>
                <li><a href="<?php echo esc_url( get_permalink(1) ); ?>"><?php esc_html_e( 'About MyBlog', 'textdomain' ); ?></a></li>
                <li><a href="<?php echo esc_url( get_permalink(10) ); ?>"><?php esc_html_e( 'About the owner', 'textdomain' ); ?></a></li>
            </ul>
        </li>
    </ul>

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