Permalinks: Correct the documentation for the get_sample_permalink filter, and improve the documentation for the get_sample_permalink() function.

Props sebastian.pisula for the original patch
Fixes #37682


git-svn-id: https://develop.svn.wordpress.org/trunk@38272 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
John Blackbourn 2016-08-17 18:29:47 +00:00
parent a93c94c6b2
commit e784e65d68

View File

@ -1207,9 +1207,9 @@ function postbox_classes( $id, $page ) {
* @since 2.5.0
*
* @param int $id Post ID or post object.
* @param string $title Optional. Title. Default null.
* @param string $name Optional. Name. Default null.
* @return array Array with two entries of type string.
* @param string $title Optional. Title to override the post's current title when generating the post name. Default null.
* @param string $name Optional. Name to override the post name. Default null.
* @return array Array containing the sample permalink with placeholder for the post name, and the post name.
*/
function get_sample_permalink($id, $title = null, $name = null) {
$post = get_post( $id );
@ -1270,7 +1270,7 @@ function get_sample_permalink($id, $title = null, $name = null) {
*
* @since 4.4.0
*
* @param string $permalink Sample permalink.
* @param array $permalink Array containing the sample permalink with placeholder for the post name, and the post name.
* @param int $post_id Post ID.
* @param string $title Post title.
* @param string $name Post name (slug).