Changeset 37564 for trunk/src/wp-includes/link-template.php

Timestamp:

05/25/2016 06:24:33 PM (8 years ago)

Author:

DrewAPicture

Message:

Docs: Update the return description for get_preview_post_link() to note that it can also return null.

Props chris_dev, swissspidy.
See #35915.

File:

• trunk/src/wp-includes/link-template.php (modified) (2 diffs)

trunk/src/wp-includes/link-template.php

@@ -1211 +1211 @@
  * 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
@@ -1220 +1220 @@
  * @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 = '' ) {