WordPress.org

Make WordPress Core

Opened 3 years ago

Closed 3 years ago

#38254 closed defect (bug) (fixed)

outdated blog post in register_meta doc for 4.6 update

Reported by: Mista-Flo Owned by: jorbin
Milestone: 4.7 Priority: normal
Severity: normal Version: 4.6
Component: Options, Meta APIs Keywords: has-patch
Focuses: docs Cc:

Description

Hello,

The 4.6 WordPress version update the register_meta function, in the PHP Doc header of the function, there is a link to the Core blog post that explains changes, but it's an outdated post, since the direction of the function change's has evolved.

Now it should be https://make.wordpress.org/core/2016/07/20/additional-register_meta-changes-in-4-6/ instead of https://make.wordpress.org/core/2016/07/08/enhancing-register_meta-in-4-6/

Attachments (3)

38254.patch (1.4 KB) - added by Mista-Flo 3 years ago.
Fix phpdoc
38254.diff (707 bytes) - added by morganestes 3 years ago.
38254.2.patch (1.3 KB) - added by Mista-Flo 3 years ago.
Refresh : Add core ticket @link to register_meta php doc

Download all attachments as: .zip

Change History (14)

@Mista-Flo
3 years ago

Fix phpdoc

#1 @Mista-Flo
3 years ago

  • Keywords has-patch added

This ticket was mentioned in Slack in #docs by florian-tiar. View the logs.


3 years ago

@morganestes
3 years ago

#3 @morganestes
3 years ago

  • Keywords commit added
  • Milestone changed from Awaiting Review to 4.7

#4 @ocean90
3 years ago

  • Keywords close added

IIRC this was intentionally because the second post doesn't include all the information which the initial post has.

#5 @morganestes
3 years ago

  • Keywords close removed

My patch 38254.diff has the same changes as the one from @Mista-Flo, just from outside src. His patch wasn't applying with grunt patch so I tried with the same info and uploaded it from grunt to test it out.

#6 @morganestes
3 years ago

@ocean90 The note at the top of the original post directs readers to use the second one. Maybe it would be better to include the notes from those posts in the inline docs with the correct usage instead of just linking to one or the other?

This ticket was mentioned in Slack in #core by jeffpaul. View the logs.


3 years ago

#8 @ocean90
3 years ago

  • Keywords commit removed
  • Milestone changed from 4.7 to Awaiting Review

I don't think we should change the posts. Maybe there should be a page on devhub instead. I'm leaving the decision to @DrewAPicture.

#9 @DrewAPicture
3 years ago

  • Keywords needs-patch added; has-patch removed
  • Milestone changed from Awaiting Review to 4.7

I think the best move here would be to link to the ticket (#35658) as the canonical history for the changes introduced in 4.6. All of the discussions, decision making, and conclusions are included there.

@Mista-Flo
3 years ago

Refresh : Add core ticket @link to register_meta php doc

#10 @Mista-Flo
3 years ago

  • Keywords has-patch added; needs-patch removed

I have made a new patch according to your comment.

#11 @jorbin
3 years ago

  • Owner set to jorbin
  • Resolution set to fixed
  • Status changed from new to closed

In 39066:

Update link in register_meta about 4.6 changes

The blog post, while originally canonical, was later updated to include additional changes. The ticket includes all the changes and alot of rational for why things changed.

Props Mista-Flo, DrewAPicture, morganestes.
Fixes #38254.

Note: See TracTickets for help on using tickets.