IntenseWebs/WordPress
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Docs: Improve documentation for optional parameters per the documentation standards.

Browse Source 
See #49572.
Built from https://develop.svn.wordpress.org/trunk@48197


git-svn-id: http://core.svn.wordpress.org/trunk@47966 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Sergey Biryukov
2020-06-28 11:49:02 +00:00
parent ee8e9905c4
commit 58ad216087
15 changed files with 84 additions and 76 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
wp-includes/link-template.php
View File

@@ -257,8 +257,8 @@ function get_permalink( $post = 0, $leavename = false ) {
* @global WP_Rewrite $wp_rewrite WordPress rewrite component.
*
* @param int|WP_Post $id Optional. Post ID or post object. Default is the global `$post`.
* @param bool $leavename Optional, defaults to false. Whether to keep post name. Default false.
* @param bool $sample Optional, defaults to false. Is it a sample permalink. Default false.
* @param bool $leavename Optional. Whether to keep post name. Default false.
* @param bool $sample Optional. Is it a sample permalink. Default false.
* @return string|WP_Error The post permalink.
*/
function get_post_permalink( $id = 0, $leavename = false, $sample = false ) {