From 9415376529c02e84cb422bf991a33f57b3864083 Mon Sep 17 00:00:00 2001 From: DrewAPicture Date: Mon, 7 Apr 2014 20:21:02 +0000 Subject: [PATCH] Improve PHPDoc formatting for `get_the_permalink()`. See #27700. git-svn-id: https://develop.svn.wordpress.org/trunk@28001 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/link-template.php | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/src/wp-includes/link-template.php b/src/wp-includes/link-template.php index 3f17612a54..459f635c0e 100644 --- a/src/wp-includes/link-template.php +++ b/src/wp-includes/link-template.php @@ -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. */