WordPress.org
Get WordPress

Make WordPress Core

Opened 3 years ago

Closed 3 years ago

Last modified 3 years ago

#50502 closed defect (bug) (fixed)

Parameter description in update_post_meta()

Reported by: stevenlinx's profile stevenlinx Owned by: sergeybiryukov's profile SergeyBiryukov
Milestone: 5.5 Priority: normal
Severity: minor Version:
Component: Posts, Post Types Keywords: has-patch
Focuses: Cc:

Description

Parameter descriptions should be updated/migrated from Codex.

Codex:
​https://codex.wordpress.org/Function_Reference/update_post_meta

DevHub:
​https://developer.wordpress.org/reference/functions/update_post_meta/

Attachments (1)

50502.diff​ (1.6 KB) - added by stevenlinx 3 years ago.

Download all attachments as: .zip

Change History (5)

@stevenlinx
3 years ago

#1 @stevenlinx
3 years ago

  • Keywords has-patch added; needs-patch removed

#2 @SergeyBiryukov
3 years ago

  • Milestone changed from Awaiting Review to 5.5

#3 @SergeyBiryukov
3 years ago

  • Owner set to SergeyBiryukov
  • Resolution set to fixed
  • Status changed from assigned to closed

In 48214:

Docs: Improve documentation for the $prev_value parameter and return result of various metadata update functions.

Props stevenlinx.
Fixes #50502. See #49572.

#4 @SergeyBiryukov
3 years ago

Thanks for the patch! The $prev_value and @return improvements are now in.

I'm less inclined to add that the meta key and value should be raw and not sanitized, as it's not mentioned in other similar functions and doesn't seem to come up often. If someone feels strongly about that, feel free to reopen.

Note: See TracTickets for help on using tickets.