Changeset 47104

Timestamp:

01/22/2020 12:55:13 AM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Expand @return value description for wp_loginout(), wp_register(), get_calendar().

See #48303.

File:

• trunk/src/wp-includes/general-template.php (modified) (3 diffs)

trunk/src/wp-includes/general-template.php

@@ -318 +318 @@
  * @param string $redirect Optional path to redirect to on login/logout.
  * @param bool   $echo     Default to echo and not return the link.
- * @return string|void String when retrieving.
+ * @return void|string Void if `$echo` argument is true, log in/out link if `$echo` is false.
  */
 function wp_loginout( $redirect = '', $echo = true ) {
@@ -588 +588 @@
  * @param string $after  Text to output after the link. Default `</li>`.
  * @param bool   $echo   Default to echo and not return the link.
- * @return string|void String when retrieving.
+ * @return void|string Void if `$echo` argument is true, registration or admin link
+ *                     if `$echo` is false.
  */
 function wp_register( $before = '<li>', $after = '</li>', $echo = true ) {
@@ -2058 +2059 @@
  * @param bool $initial Optional, default is true. Use initial calendar names.
  * @param bool $echo    Optional, default is true. Set to false for return.
- * @return string|void String when retrieving.
+ * @return void|string Void if `$echo` argument is true, calendar HTML if `$echo` is false.
  */
 function get_calendar( $initial = true, $echo = true ) {