Changeset 53300

Timestamp:

04/28/2022 09:47:19 AM (3 years ago)

Author:

johnbillion

Message:

Docs: Various docblock corrections.

See #54729

Location:

trunk/src

Files:

• wp-cron.php (modified) (1 diff)
• wp-includes/general-template.php (modified) (2 diffs)
• wp-includes/post.php (modified) (2 diffs)
• wp-includes/revision.php (modified) (1 diff)

trunk/src/wp-cron.php

@@ -55 +55 @@
  * @global wpdb $wpdb WordPress database abstraction object.
  *
- * @return string|false Value of the `doing_cron` transient, 0|false otherwise.
+ * @return string|int|false Value of the `doing_cron` transient, 0|false otherwise.
  */
 function _get_cron_lock() {

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

@@ -1316 +1316 @@
  * @param bool   $display     Optional. Whether to display or retrieve title. Default true.
  * @param string $seplocation Optional. Location of the separator ('left' or 'right').
- * @return string|void String when `$display` is true, nothing otherwise.
+ * @return string|void String when `$display` is false, nothing otherwise.
  */
 function wp_title( $sep = '»', $display = true, $seplocation = '' ) {
@@ -1637 +1637 @@
  * @param string $prefix  Optional. What to display before the title.
  * @param bool   $display Optional. Whether to display or retrieve title. Default true.
- * @return string|void Title when retrieving.
+ * @return string|false|void False if there's no valid title for the month. Title when retrieving.
  */
 function single_month_title( $prefix = '', $display = true ) {

trunk/src/wp-includes/post.php

@@ -3369 +3369 @@
      * @since 4.4.0
      *
-     * @param bool|null $delete       Whether to go forward with deletion.
-     * @param WP_Post   $post         Post object.
-     * @param bool      $force_delete Whether to bypass the Trash.
+     * @param WP_Post|false|null $delete       Whether to go forward with deletion. @TODO description
+     * @param WP_Post            $post         Post object.
+     * @param bool               $force_delete Whether to bypass the Trash.
      */
     $check = apply_filters( 'pre_delete_post', null, $post, $force_delete );
@@ -6345 +6345 @@
      * @since 5.5.0
      *
-     * @param bool|null $delete       Whether to go forward with deletion.
-     * @param WP_Post   $post         Post object.
-     * @param bool      $force_delete Whether to bypass the Trash.
+     * @param WP_Post|false|null $delete       Whether to go forward with deletion. @TODO description
+     * @param WP_Post            $post         Post object.
+     * @param bool               $force_delete Whether to bypass the Trash.
      */
     $check = apply_filters( 'pre_delete_attachment', null, $post, $force_delete );

trunk/src/wp-includes/revision.php

@@ -448 +448 @@
  *
  * @param int|WP_Post $revision_id Revision ID or revision object.
- * @return array|false|WP_Post|WP_Error|null Null or WP_Error if error, deleted post if success.
+ * @return WP_Post|false|null Null or false if error, deleted post object if success.
  */
 function wp_delete_post_revision( $revision_id ) {