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

Timestamp:

01/11/2020 06:30:58 PM (5 years 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/post-template.php (modified) (8 diffs)

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

@@ -38 +38 @@
  * @param string $after  Optional. Markup to append to the title. Default empty.
  * @param bool   $echo   Optional. Whether to echo or return the title. Default true for echo.
- * @return string|void Current post title if $echo is false.
+ * @return void|string Void if `$echo` argument is true, current post title if `$echo` is false.
  */
 function the_title( $before = '', $after = '', $echo = true ) {
@@ -76 +76 @@
  *     @type WP_Post $post   Current post object to retrieve the title for.
  * }
- * @return string|void String when echo is false.
+ * @return void|string Void if 'echo' argument is true, the title attribute if 'echo' is false.
  */
 function the_title_attribute( $args = '' ) {
@@ -1063 +1063 @@
  *
  * @param string $key Meta data key name.
- * @return false|string|array Array of values or single value, if only one element exists. False will be returned if key does not exist.
+ * @return array|string|false Array of values, or single value if only one element exists.
+ *                            False if the key does not exist.
  */
 function post_custom( $key = '' ) {
@@ -1154 +1155 @@
  *                                               elements. Accepts any valid post field. Default 'ID'.
  * }
- * @return string HTML content, if not displaying.
+ * @return string HTML dropdown list of pages.
  */
 function wp_dropdown_pages( $args = '' ) {
@@ -1212 +1213 @@
         echo $html;
     }
+
     return $html;
 }
@@ -1253 +1255 @@
  *     @type Walker       $walker       Walker instance to use for listing pages. Default empty (Walker_Page).
  * }
- * @return string|void HTML list of pages.
+ * @return void|string Void if 'echo' argument is true, HTML list of pages if 'echo' is false.
  */
 function wp_list_pages( $args = '' ) {
@@ -1374 +1376 @@
  *     @type Walker          $walker       Walker instance to use for listing pages. Default empty (Walker_Page).
  * }
- * @return string|void HTML menu
+ * @return void|string Void if 'echo' argument is true, HTML menu if 'echo' is false.
  */
 function wp_page_menu( $args = array() ) {
@@ -1489 +1491 @@
      */
     $menu = apply_filters( 'wp_page_menu', $menu, $args );
+
     if ( $args['echo'] ) {
         echo $menu;