Changeset 34176

Timestamp:

09/15/2015 08:24:54 AM (10 years ago)

Author:

johnbillion

Message:

Improve the docblocks for the get_preview_post_link() function and the preview_post_link filter.

See #24345

File:

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

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

@@ -1160 +1160 @@
 
 /**
- * Retrieve preview post link.
- *
- * Get the preview post URL. Allow any number of query args to be appended.
+ * Retrieve URL used for the post preview.
+ *
+ * Get the preview post URL. Allows additional query args to be appended.
  *
  * @since 4.4.0
  *
- * @param int    $post         Optional. Post ID or WP_Post object. Defaults to global post.
- * @param array  $query_args   Optional. If preview query arg should be added. Or array of query args to be added.
- * @param string $preview_link Optional. If a link other than the permalink should be used. Used by _wp_link_page.
- * @return string
+ * @param int|WP_Post $post         Optional. Post ID or `WP_Post` object. Defaults to global post.
+ * @param array       $query_args   Optional. Array of additional query args to be appended to the link.
+ * @param string      $preview_link Optional. Base preview link to be used if it should differ from the post permalink.
+ * @return string URL used for the post preview.
  */
 function get_preview_post_link( $post = null, $query_args = array(), $preview_link = '' ) {
@@ -1188 +1188 @@
 
     /**
-     * Filter the URI of a post preview in the post submit box.
+     * Filter the URL used for a post preview.
      *
      * @since 2.0.5
      * @since 4.4.0 $post parameter was added.
      *
-     * @param string  $preview_link URI the user will be directed to for a post preview.
+     * @param string  $preview_link URL used for the post preview.
      * @param WP_Post $post         Post object.
      */