get_permalink( int|WP_Post $post, bool $leavename = false )
Retrieves the full permalink for the current post or post ID.
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
Return Return
(string|false) The permalink URL or false if post does not exist.
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.
Source Source
File: wp-includes/link-template.php
118 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 249 250 |
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 ( 'page' === $post ->post_type ) { return get_page_link( $post , $leavename , $sample ); } elseif ( 'attachment' === $post ->post_type ) { return get_attachment_link( $post , $leavename ); } elseif ( in_array( $post ->post_type, get_post_types( array ( '_builtin' => false ) ), true ) ) { 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' ), true ) ) { $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; } // This is not an API call because the permalink is based on the stored post_date value, // which should be parsed as local time regardless of the default PHP timezone. $date = explode ( ' ' , str_replace ( array ( '-' , ':' ), ' ' , $post ->post_date ) ); $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 View on Trac
Changelog Changelog
Version | Description |
---|---|
1.0.0 | Introduced. |