From a27b379144e042d11424d12ae24080b10ae1b737 Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Wed, 25 May 2016 18:24:33 +0000 Subject: [PATCH] Docs: Update the return description for `get_preview_post_link()` to note that it can also return null. Props chris_dev, swissspidy. See #35915. git-svn-id: https://develop.svn.wordpress.org/trunk@37564 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/link-template.php | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/wp-includes/link-template.php b/src/wp-includes/link-template.php index cfb4d654ec..6ad7f058b9 100644 --- a/src/wp-includes/link-template.php +++ b/src/wp-includes/link-template.php @@ -1210,7 +1210,7 @@ function get_post_type_archive_feed_link( $post_type, $feed = '' ) { /** * Retrieves the URL used for the post preview. * - * Get the preview post URL. Allows additional query args to be appended. + * Allows additional query args to be appended. * * @since 4.4.0 * @@ -1219,7 +1219,7 @@ function get_post_type_archive_feed_link( $post_type, $feed = '' ) { * Default empty array. * @param string $preview_link Optional. Base preview link to be used if it should differ from the * post permalink. Default empty. - * @return string URL used for the post preview. + * @return string|null URL used for the post preview, or null if the post does not exist. */ function get_preview_post_link( $post = null, $query_args = array(), $preview_link = '' ) { $post = get_post( $post );