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

Built from https://develop.svn.wordpress.org/trunk@38272


git-svn-id: http://core.svn.wordpress.org/trunk@38213 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
John Blackbourn 2016-08-17 18:30:30 +00:00
parent 14cbd0e730
commit 594b88661a
2 changed files with 5 additions and 5 deletions

View File

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

View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.7-alpha-38267'; $wp_version = '4.7-alpha-38272';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.