Changeset 34262

Timestamp:

09/17/2015 09:05:44 AM (10 years ago)

Author:

SergeyBiryukov

Message:

Docs: Expand the DocBlock for get_default_post_to_edit().

Props rabmalin.
Fixes #33910.

File:

• trunk/src/wp-admin/includes/post.php (modified) (2 diffs)

trunk/src/wp-admin/includes/post.php

@@ -578 +578 @@
  * @since 2.0.0
  *
- * @param string $post_type A post type string, defaults to 'post'.
+ * @param string $post_type    Optional. A post type string. Default 'post'.
+ * @param bool   $create_in_db Optional. Whether to insert the post into database. Default false.
  * @return WP_Post Post object containing all the default post data as attributes
  */
@@ -1256 +1257 @@
     unset($post->filter);
 
-    return $permalink;
+    /**
+     * Filter the sample permalink.
+     *
+     * @since 4.4.0
+     *
+     * @param string  $permalink Sample permalink.
+     * @param int     $post_id   Post ID.
+     * @param string  $title     Post title.
+     * @param string  $name      Post name (slug).
+     * @param WP_Post $post      Post object.
+     */
+    return apply_filters( 'get_sample_permalink', $permalink, $post->ID, $title, $name, $post );
 }