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

Parameters

$postint|WP_Postoptional

Post ID or post object. Default is the global $post.Default: 0

$leavenamebooloptional

Whether to keep post name or page name. Default false.Default: false

Return

string|false

The permalink URL. False if the post does not exist.

Hooks fired · 3

3 hooks fire while get_permalink() runs, in this order:

1. 1
   apply_filters( pre_post_link )filterline 217 (+47 into the body)

   Filters the permalink structure for a post before token replacement occurs.

2. 2
   apply_filters( post_link_category )filterline 244 (+74 into the body)

   Filters the category that gets used in the %category% permalink token.

3. 3
   apply_filters( post_link )filterline 308 (+138 into the body)

   Filters the permalink for a post.

Uses · 17

• get_post()Retrieves post data given a post ID or post object.
• get_page_link()Retrieves the permalink for the current page or page ID.
• get_attachment_link()Retrieves the permalink for an attachment.
• get_post_types()Gets a list of all registered post type objects.
• get_post_permalink()Retrieves the permalink for a post of a custom post type.
• get_option()Retrieves an option value based on an option name.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• wp_force_plain_post_permalink()Determine whether post should always use a plain permalink structure.
• str_contains()Polyfill for `str_contains()` function added in PHP 8.0.
• get_the_category()Retrieves post categories.
• wp_list_sort()Sorts an array of objects or arrays based on one or more orderby arguments.
• get_term()Gets all term data from database by term ID.

Used by · 50

• TwentyTwenty_Walker_Page::start_el()Outputs the beginning of the current element in the tree.
• Twenty_Eleven_Ephemera_Widget::widget()Outputs the HTML for this widget.
• Twenty_Fourteen_Ephemera_Widget::widget()Outputs the HTML for this widget.
• WP_Comments_List_Table::column_response()
• 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_Customize_Nav_Menus::ajax_insert_auto_draft_post()Ajax handler for adding a new auto-draft post.
• WP_Customize_Nav_Menus::load_available_items_query()Performs the post_type and taxonomy queries for loading available menu items.
• WP_Customize_Nav_Menus::search_available_items_query()Performs post queries for available-item searching.
• WP_Media_List_Table::_get_row_actions()
• WP_Posts_List_Table::handle_row_actions()Generates and displays row action links.
• WP_REST_Post_Search_Handler::prepare_item()Prepares the search result for a given post ID.
• WP_REST_Posts_Controller::get_item()Retrieves a single post.

Source

View on Trac ↗View on GitHub ↗

170function get_permalink( $post = 0, $leavename = false ) {171	$rewritecode = array(172		'%year%',173		'%monthnum%',174		'%day%',175		'%hour%',176		'%minute%',177		'%second%',178		$leavename ? '' : '%postname%',179		'%post_id%',180		'%category%',181		'%author%',182		$leavename ? '' : '%pagename%',183	);184 185	if ( is_object( $post ) && isset( $post->filter ) && 'sample' === $post->filter ) {186		$sample = true;187	} else {188		$post   = get_post( $post );189		$sample = false;190	}191 192	if ( empty( $post->ID ) ) {193		return false;194	}195 196	if ( 'page' === $post->post_type ) {197		return get_page_link( $post, $leavename, $sample );198	} elseif ( 'attachment' === $post->post_type ) {199		return get_attachment_link( $post, $leavename );200	} elseif ( in_array( $post->post_type, get_post_types( array( '_builtin' => false ) ), true ) ) {201		return get_post_permalink( $post, $leavename, $sample );202	}203 204	$permalink = get_option( 'permalink_structure' );205 206	/**207	 * Filters the permalink structure for a post before token replacement occurs.208	 *209	 * Only applies to posts with post_type of 'post'.210	 *211	 * @since 3.0.0212	 *213	 * @param string  $permalink The site's permalink structure.214	 * @param WP_Post $post      The post in question.215	 * @param bool    $leavename Whether to keep the post name.216	 */217	$permalink = apply_filters( 'pre_post_link', $permalink, $post, $leavename );218 219	if (220		$permalink &&221		! wp_force_plain_post_permalink( $post )222	) {223 224		$category = '';225		if ( str_contains( $permalink, '%category%' ) ) {226			$cats = get_the_category( $post->ID );227			if ( $cats ) {228				$cats = wp_list_sort(229					$cats,230					array(231						'term_id' => 'ASC',232					)233				);234 235				/**236				 * Filters the category that gets used in the %category% permalink token.237				 *238				 * @since 3.5.0239				 *240				 * @param WP_Term  $cat  The category to use in the permalink.241				 * @param array    $cats Array of all categories (WP_Term objects) associated with the post.242				 * @param WP_Post  $post The post in question.243				 */244				$category_object = apply_filters( 'post_link_category', $cats[0], $cats, $post );245 246				$category_object = get_term( $category_object, 'category' );247				$category        = $category_object->slug;248				if ( $category_object->parent ) {249					$category = get_category_parents( $category_object->parent, false, '/', true ) . $category;

History

Introduced in 1.0.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.9.7 tag, from src/wp-includes/link-template.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.