Improve PHPDoc formatting for `get_the_permalink()`.

See #27700.

Built from https://develop.svn.wordpress.org/trunk@28001


git-svn-id: http://core.svn.wordpress.org/trunk@27831 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2014-04-07 20:22:15 +00:00
parent 35fb93858a
commit d568e9029d
1 changed files with 5 additions and 2 deletions

View File

@ -69,12 +69,15 @@ function permalink_anchor( $mode = 'id' ) {
}
/**
* Retrieve full permalink for current post or post ID. Alias for get_permalink().
* Retrieve full permalink for current post or post ID.
*
* This function is an alias for get_permalink().
*
* @since 3.9.0
*
* @see get_permalink()
*
* @param int|WP_Post $id Optional. Post ID or post object. Defaults current post.
* @param int|WP_Post $id Optional. Post ID or post object. Default is the current post.
* @param bool $leavename Optional. Whether to keep post name or page name. Default false.
* @return string|bool The permalink URL or false if post does not exist.
*/