WordPress.org

Make WordPress Core

Opened 8 years ago

Closed 8 years ago

#25361 closed enhancement (fixed)

Hook Docs: wp-admin/admin-post.php

Reported by: ericlewis Owned by: DrewAPicture
Milestone: 3.7 Priority: normal
Severity: normal Version:
Component: Inline Docs Keywords: has-patch commit
Focuses: Cc:

Description

admin_init, admin_post_{$_REQUESTaction?}, admin_post_nopriv_{$_REQUESTaction?}

Attachments (2)

25361.diff (659 bytes) - added by ericlewis 8 years ago.
25361.1.diff (681 bytes) - added by kpdesign 8 years ago.
Fix short description, add periods to end of hook descriptions.

Download all attachments as: .zip

Change History (9)

@ericlewis
8 years ago

#1 @DrewAPicture
8 years ago

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

Couple notes on 25361.diff:

  • s/REQUEST/$_REQUEST in the short description
  • periods on the action hook variation descriptions

#2 follow-up: @rmccue
8 years ago

Hmm. I'm not sure how we've handled cases like this previously, but would it be helpful to add an @alias PHPDoc tag to the parser for cases like this?

Something like:

/**
 * This is my action.
 *
 * @alias first_action This is one action that could be called.
 * @alias second_{$variable}_action This is another that could be called.
 */
do_action($action);

#3 in reply to: ↑ 2 @DrewAPicture
8 years ago

Replying to rmccue:

Hmm. I'm not sure how we've handled cases like this previously, but would it be helpful to add an @alias PHPDoc tag to the parser for cases like this?

Something like:

/**
 * This is my action.
 *
 * @alias first_action This is one action that could be called.
 * @alias second_{$variable}_action This is another that could be called.
 */
do_action($action);

I agree it could be useful. We can discuss it next week at the inline docs chat on Wednesday, 18:00 UTC. Or, if you'd like to pick a better time for you, we can meet up and talk about it in #wordpress-sfd or something. Interested?

@kpdesign
8 years ago

Fix short description, add periods to end of hook descriptions.

#4 @kpdesign
8 years ago

25361.1.diff fixes items listed in @DrewAPicture's review in comment 1.

#5 @kpdesign
8 years ago

  • Keywords has-patch added; needs-patch removed

#6 @DrewAPicture
8 years ago

  • Keywords commit added

25361.1.diff looks good.

#7 @DrewAPicture
8 years ago

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

In 25589:

Inline documentation for hooks in wp-admin/admin-post.php.

Props ericlewis, kpdesign.
Fixes #25361.

Note: See TracTickets for help on using tickets.