WordPress.org

Make WordPress Core

Opened 5 years ago

Closed 3 years ago

#36319 closed defect (bug) (fixed)

Post meta authorization filter docs are incorrect

Reported by: ericlewis Owned by: adamsilverstein
Milestone: 4.9 Priority: normal
Severity: normal Version:
Component: Options, Meta APIs Keywords: has-patch dev-feedback commit
Focuses: docs Cc:

Description

The doc for the auth_post_meta_* filter says

Filter whether the user is allowed to add post meta to a post.

This is not actually the case. If the filter returns false, the user will need to have the edit_post_meta cap. Otherwise, edit_post mapped meta caps apply.

Attachments (5)

36319.patch (2.2 KB) - added by johneckman 4 years ago.
Patch to docs section to clarify filters.
36319.2.patch (2.6 KB) - added by adamsilverstein 4 years ago.
36319.diff (2.7 KB) - added by adamsilverstein 3 years ago.
36319.2.diff (2.7 KB) - added by adamsilverstein 3 years ago.
36319.3.diff (2.7 KB) - added by adamsilverstein 3 years ago.

Download all attachments as: .zip

Change History (18)

#1 @ericlewis
5 years ago

  • Keywords needs-patch good-first-bug added
  • Milestone changed from Awaiting Review to Future Release

#2 @lukecavanagh
4 years ago

Let me work on a patch.

@johneckman
4 years ago

Patch to docs section to clarify filters.

#3 @johneckman
4 years ago

  • Keywords has-patch dev-feedback added; needs-patch good-first-bug removed

36319.patch includes comments to try to clarify how these filters interact.

For clarity, added brackets to nested if( ! $allowed) statement as it is unclear as an inline if.

#4 @adamsilverstein
4 years ago

@johneckman thanks for your patch here!

I had a little trouble getting the patch to apply because things have moved around quite a bit. The original inline documentation for both hooks was removed and replaced with This filter is documented in wp-includes/meta.php - when I looked there I did not find similar hooks or inline documentation.

36319.2.patch is an update against trunk and also helps clarify the functionality I think. Can you please review and let me know what you think?

#5 @DrewAPicture
3 years ago

@adamsilverstein So, we should at the very least document the auth_post_meta_{$meta_key} as having been introduced in 3.3.0 and renamed to auth_{$object_type}_meta_{$meta_key} later. The way we handle hooks getting renamed is like this:

 * @since 3.3.0 As 'auth_post_meta_{$meta_key}'.
 * @since 4.7.0

I'm unsure about whether the other original hook was maintained in the rename. If it was, the same procedure applies. If not, we need to properly deprecate the old hook.

Last edited 3 years ago by DrewAPicture (previous) (diff)

#6 @adamsilverstein
3 years ago

@DrewAPicture thanks for the feedback and syntax clarification. I tracked down the origin of each filter and made sure to have an @since line listing the previous use in both cases. Does 36319.diff look good?

#7 @DrewAPicture
3 years ago

  • Keywords commit added
  • Milestone changed from Future Release to 4.9

@adamsilverstein Looks good. We should probably do inline @see notations for the dynamic hook references in the descriptions, but you can fix that on commit.

Just make sure to remove the extra curly braces so the parser doesn't get confused, e.g. Use the {@see 'auth_$object_type_$sub_type_meta_$meta_key'} filter ...

You want to do the honors? :-)

#8 @DrewAPicture
3 years ago

@coffee2code: Leaving a note here that we should manually pick up these docs in the 4.8.1 re-parse.

#9 @adamsilverstein
3 years ago

@DrewAPicture Thanks for the feedback, does 36319.2.diff look right? Happy to commit once I get your confirmation!

#10 @DrewAPicture
3 years ago

@adamsilverstein Looks good except for what looks like copy pasta in the first one: "{@see{@see auth_post_$object_type_meta_$meta_key}".

#11 @DrewAPicture
3 years ago

  • Owner set to adamsilverstein
  • Status changed from new to reviewing

#12 @adamsilverstein
3 years ago

36319.3.diff fix a copy/paste typo

#13 @adamsilverstein
3 years ago

  • Resolution set to fixed
  • Status changed from reviewing to closed

In 41800:

Docs: add docs for meta authorization filters.

Add filter documentation for auth_{$object_type}_meta_{$meta_key} and auth_{$object_type}_{$sub_type}_meta_{$meta_key}.

Props ericlewis, johneckman, DrewAPicture.
Fixes #36319.

Note: See TracTickets for help on using tickets.