WordPress.org
Get WordPress

Make WordPress Core

Opened 5 years ago

Closed 5 years ago

Last modified 5 years ago

#54835 closed enhancement (fixed)

Docs: Update comments for the post_meta functions

Reported by: thelovekesh Owned by: davidbaumwald
Priority: normal Milestone: 6.0
Component: Options, Meta APIs Version: 5.9
Severity: normal Keywords: has-patch
Cc: Focuses: docs

Description

Inline code comment for update_post_meta and delete_post_meta were same as add_post_meta when checking for the wp_is_post_revision.

Attachments (2)

54835.diff​ (956 bytes ) - added by thelovekesh 5 years ago.
#54835.patch​ (914 bytes ) - added by rehanali 5 years ago.
Added patch

Download all attachments as: .zip

Change History (6)

@thelovekesh
5 years ago

This ticket was mentioned in ​PR #2177 on ​WordPress/wordpress-develop by ​thelovekesh.
5 years ago #1

  • During checking wp_is_post_revision all post_meta functions have the same inline comment that matched add_post_meta comment.

Trac ticket: https://core.trac.wordpress.org/ticket/54835

#2 @davidbaumwald
5 years ago

  • Milestone Awaiting Review → 6.0
  • Owner set to davidbaumwald
  • Status new → reviewing

@rehanali
5 years ago

Added patch

#3 @davidbaumwald
5 years ago

  • Resolution → fixed
  • Status reviewing → closed

In 52660:

Options, Meta APIs: Correct some inline docs for update_post_meta and delete_post_meta.

In update_post_meta and delete_post_meta, code was added to fetch the parent post if these functions were called for a revision post ID. In [9252], the code was apparently copied from add_post_meta, and the inline comment describing the new block of code was not updated to mention either "updated" or "deleted" respectively. This change corrects the comment in both functions to reflect the current action instead of "added".

Props thelovekesh, rehanali.
Fixes #54835.

​dream-encode commented on ​PR #2177:
5 years ago #4

Thanks for the ticket and PR! This was merged into core in https://core.trac.wordpress.org/changeset/52660.

Note: See TracTickets for help on using tickets.