Changeset 47060 for trunk/src/wp-includes/general-template.php

Timestamp:

01/11/2020 06:30:58 PM (13 months ago)

Author:

SergeyBiryukov

Message:

Docs: In various @return tags, list the expected type first, instead of false.

Follow-up to [46696].

See #48303.

File:

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

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

@@ -197 +197 @@
  *                              accessibility. Default empty.
  * }
- * @return string|void String when the $echo param is false.
+ * @return void|string Void if 'echo' argument is true, search form HTML if 'echo' is false.
  */
 function get_search_form( $args = array() ) {
@@ -301 +301 @@
     }
 
-    if ( isset( $args['echo'] ) && $args['echo'] ) {
+    if ( $args['echo'] ) {
         echo $result;
     } else {
@@ -427 +427 @@
  * Provides a simple login form for use anywhere within WordPress.
  *
- * The login format HTML is echoed by default. Pass a false value for `$echo` to return it instead.
+ * The login form HTML is echoed by default. Pass a false value for `$echo` to return it instead.
  *
  * @since 3.0.0
@@ -453 +453 @@
  *
  * }
- * @return string|void String when retrieving.
+ * @return void|string Void if 'echo' argument is true, login form HTML if 'echo' is false.
  */
 function wp_login_form( $args = array() ) {
@@ -1807 +1807 @@
  *     @type string     $w               Week. Default current week.
  * }
- * @return string|void String when retrieving.
+ * @return void|string Void if 'echo' argument is true, archive links if 'echo' is false.
  */
 function wp_get_archives( $args = '' ) {
@@ -2020 +2020 @@
         }
     }
+
     if ( $parsed_args['echo'] ) {
         echo $output;
@@ -2390 +2391 @@
  * @param  string      $d    Optional. PHP date format defaults to the date_format option if not specified.
  * @param  int|WP_Post $post Optional. Post ID or WP_Post object. Default current post.
- * @return false|string Date the current post was written. False on failure.
+ * @return string|false Date the current post was written. False on failure.
  */
 function get_the_date( $d = '', $post = null ) {
@@ -2461 +2462 @@
  * @param string      $d    Optional. PHP date format defaults to the date_format option if not specified.
  * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default current post.
- * @return false|string Date the current post was modified. False on failure.
+ * @return string|false Date the current post was modified. False on failure.
  */
 function get_the_modified_date( $d = '', $post = null ) {
@@ -2706 +2707 @@
  *                           to the value specified in the time_format option. Default empty.
  * @param int|WP_Post $post  Optional. Post ID or WP_Post object. Default current post.
- * @return false|string Formatted date string or Unix timestamp. False on failure.
+ * @return string|false Formatted date string or Unix timestamp. False on failure.
  */
 function get_the_modified_time( $d = '', $post = null ) {
@@ -4071 +4072 @@
  *     @type string $after_page_number  A string to append after the page number. Default empty.
  * }
- * @return string|array|void String of page links or array of page links.
+ * @return string|array|void String of page links or array of page links, depending on 'type' argument.
+ *                           Void if total number of pages is less than 2.
  */
 function paginate_links( $args = '' ) {