Changeset 58212

Timestamp:

05/27/2024 04:28:00 PM (2 months ago)

Author:

SergeyBiryukov

Message:

Docs: Improve documentation for a few functions accepting a WP_Post object.

Follow-up to [15777], [23769], [24490], [25697], [37252], [49544].

See #60699.

Location:

trunk/src

Files:

• wp-admin/includes/post.php (modified) (1 diff)
• wp-includes/link-template.php (modified) (1 diff)
• wp-includes/post-formats.php (modified) (1 diff)
• wp-includes/post-template.php (modified) (2 diffs)

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

@@ -1140 +1140 @@
  * @access private
  *
- * @param int|object $post Post ID or post object.
+ * @param int|t $post Post ID or post object.
  * @return void|int|WP_Error Void if nothing fixed. 0 or WP_Error on update failure. The post ID on update success.
  */

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

@@ -466 +466 @@
  * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
  *
- * @param int|object $post      Optional. Post ID or object. Default uses the global `$post`.
- * @param bool       $leavename Optional. Whether to keep the page name. Default false.
+ * @param int|t $post      Optional. Post ID or object. Default uses the global `$post`.
+ * @param bool       $leavename Optional. Whether to keep the page name. Default false.
  * @return string The attachment permalink.
  */

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

@@ -64 +64 @@
  * @since 3.1.0
  *
- * @param int|object $post   The post for which to assign a format.
- * @param string     $format A format to assign. Use an empty string or array to remove all formats from the post.
+ * @param int|t $post   The post for which to assign a format.
+ * @param string     $format A format to assign. Use an empty string or array to remove all formats from the post.
  * @return array|WP_Error|false Array of affected term IDs on success. WP_Error on error.
  */

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

@@ -1862 +1862 @@
  * @since 2.6.0
  *
- * @param int|object $revision Revision ID or revision object.
- * @param bool       $link     Optional. Whether to link to revision's page. Default true.
+ * @param int|t $revision Revision ID or revision object.
+ * @param bool       $link     Optional. Whether to link to revision's page. Default true.
  * @return string|false i18n formatted datetimestamp or localized 'Current Revision'.
  */
@@ -1904 +1904 @@
  * @since 3.6.0
  *
- * @param int|object $revision Revision ID or revision object.
- * @param bool       $link     Optional. Whether to link to revision's page. Default true.
+ * @param int|t $revision Revision ID or revision object.
+ * @param bool       $link     Optional. Whether to link to revision's page. Default true.
  * @return string|false gravatar, user, i18n formatted datetimestamp or localized 'Current Revision'.
  */