vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2026-08-11 20:30:23 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Convert various uses of (optional) in core parameter descriptions to use the style prescribed in the inline documentation standards for PHP.

Browse Source 
The style for marking parameters optional in inline PHP docs is: `@param type $var Optional. Description. Accepts. Default.`, where Accepts can be omitted on a case-by-case basis.

Props coffee2code.
Fixes #30591.


git-svn-id: https://develop.svn.wordpress.org/trunk@30753 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes (DrewAPicture)
2014-12-06 21:23:52 +00:00
parent 71bb091cc3
commit 7187da0b32
9 changed files with 85 additions and 68 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/wp-includes/link-template.php
+31 -23
View File
@@ -2587,13 +2587,14 @@ function get_shortcut_link() {
* Retrieve the home url for the current site.
*
* Returns the 'home' option with the appropriate protocol, 'https' if
* is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is
* overridden.
* {@see is_ssl()} and 'http' otherwise. If `$scheme` is 'http' or 'https',
* `is_ssl()` is overridden.
*
* @since 3.0.0
*
* @param string $path (optional) Path relative to the home url.
* @param string $scheme (optional) Scheme to give the home url context. Currently 'http', 'https', or 'relative'.
* @param string $path Optional. Path relative to the home url. Default empty.
* @param string $scheme Optional. Scheme to give the home url context. Accepts
* 'http', 'https', or 'relative'. Default null.
* @return string Home url link with optional path appended.
*/
function home_url( $path = '', $scheme = null ) {
@@ -2604,15 +2605,17 @@ function home_url( $path = '', $scheme = null ) {
* Retrieve the home url for a given site.
*
* Returns the 'home' option with the appropriate protocol, 'https' if
* is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is
* {@see is_ssl()} and 'http' otherwise. If `$scheme` is 'http' or 'https',
* `is_ssl()` is
* overridden.
*
* @since 3.0.0
*
* @param int $blog_id (optional) Blog ID. Defaults to current blog.
* @param string $path (optional) Path relative to the home url.
* @param string $scheme (optional) Scheme to give the home url context. Currently 'http', 'https', or 'relative'.
* @return string Home url link with optional path appended.
* @param int $blog_id Optional. Blog ID. Default null (current blog).
* @param string $path Optional. Path relative to the home URL. Default empty.
* @param string|null $orig_scheme Optional. Scheme to give the home URL context. Accepts
* 'http', 'https', 'relative', or null. Default null.
* @return string Home URL link with optional path appended.
*/
function get_home_url( $blog_id = null, $path = '', $scheme = null ) {
$orig_scheme = $scheme;
@@ -2671,14 +2674,16 @@ function site_url( $path = '', $scheme = null ) {
* Retrieve the site url for a given site.
*
* Returns the 'site_url' option with the appropriate protocol, 'https' if
* is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is
* overridden.
* {@see is_ssl()} and 'http' otherwise. If `$scheme` is 'http' or 'https',
* `is_ssl()` is overridden.
*
* @since 3.0.0
*
* @param int $blog_id (optional) Blog ID. Defaults to current blog.
* @param string $path Optional. Path relative to the site url.
* @param string $scheme Optional. Scheme to give the site url context. Currently 'http', 'https', 'login', 'login_post', 'admin', or 'relative'.
* @param int $blog_id Optional. Blog ID. Default null (current site).
* @param string $path Optional. Path relative to the site url. Default empty.
* @param string $scheme Optional. Scheme to give the site url context. Accepts
* 'http', 'https', 'login', 'login_post', 'admin', or
* 'relative'. Default null.
* @return string Site url link with optional path appended.
*/
function get_site_url( $blog_id = null, $path = '', $scheme = null ) {
@@ -2723,13 +2728,15 @@ function admin_url( $path = '', $scheme = 'admin' ) {
}
/**
* Retrieve the url to the admin area for a given site.
* Retrieves the url to the admin area for a given site.
*
* @since 3.0.0
*
* @param int $blog_id (optional) Blog ID. Defaults to current blog.
* @param string $path Optional path relative to the admin url.
* @param string $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes.
* @param int $blog_id Optional. Blog ID. Default null (current site).
* @param string $path Optional. Path relative to the admin url. Default empty.
* @param string $scheme Optional. The scheme to use. Accepts 'http' or 'https',
* to force those schemes. Default 'admin', which obeys
* {@see force_ssl_admin()} and {@see is_ssl()}.
* @return string Admin url link with optional path appended.
*/
function get_admin_url( $blog_id = null, $path = '', $scheme = 'admin' ) {
@@ -2896,16 +2903,17 @@ function network_site_url( $path = '', $scheme = null ) {
}
/**
* Retrieve the home url for the current network.
* Retrieves the home url for the current network.
*
* Returns the home url with the appropriate protocol, 'https' if
* is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is
* Returns the home url with the appropriate protocol, 'https' {@see is_ssl()}
* and 'http' otherwise. If `$scheme` is 'http' or 'https', `is_ssl()` is
* overridden.
*
* @since 3.0.0
*
* @param string $path (optional) Path relative to the home url.
* @param string $scheme (optional) Scheme to give the home url context. Currently 'http', 'https', or 'relative'.
* @param string $path Optional. Path relative to the home url. Default empty.
* @param string $scheme Optional. Scheme to give the home url context. Accepts
* 'http', 'https', or 'relative'. Default null.
* @return string Home url link with optional path appended.
*/
function network_home_url( $path = '', $scheme = null ) {