WordPress.org

Make WordPress Core

Opened 5 months ago

Closed 7 weeks ago

#25905 closed defect (bug) (fixed)

Hook Docs (53): wp-includes/option.php

Reported by: siobhyb Owned by: kpdesign
Milestone: 3.9 Priority: normal
Severity: normal Version:
Component: Options, Meta APIs Keywords: has-patch commit
Focuses: docs Cc:

Description

Patch forthcoming.

Attachments (6)

25905.patch (15.2 KB) - added by siobhyb 4 months ago.
First pass at inline docs for filters.
25905.2.patch (18.2 KB) - added by siobhyb 2 months ago.
Second pass at inline docs for wp-includes/option.php hooks.
25905.3.patch (17.7 KB) - added by siobhyb 2 months ago.
Second pass at inline docs for wp-includes/option.php hooks. Corrected copy and paste error!
25905.4.patch (19.2 KB) - added by DrewAPicture 7 weeks ago.
3rd pass
25905.5.patch (26.9 KB) - added by DrewAPicture 7 weeks ago.
4th pass.
25905.6.patch (26.9 KB) - added by kpdesign 7 weeks ago.
Final pass

Download all attachments as: .zip

Change History (23)

comment:1 kpdesign5 months ago

  • Keywords needs-patch added

comment:2 siobhyb5 months ago

FYI: Still working on this. So many hooks!

comment:3 DrewAPicture4 months ago

  • Summary changed from Hook Docs: wp-includes/option.php to Hook Docs (53): wp-includes/option.php

Still waiting on an initial patch here. You can do it @siobhyb!

comment:4 siobhyb4 months ago

Will have a patch for this by the end of this weekend.

comment:5 siobhyb4 months ago

First pass at inline-docs for filters. Placeholder text currently in place for actions, still working on these.

siobhyb4 months ago

First pass at inline docs for filters.

comment:6 jeremyfelt3 months ago

  • Component changed from Inline Docs to Options and Meta
  • Focuses docs added

siobhyb2 months ago

Second pass at inline docs for wp-includes/option.php hooks.

siobhyb2 months ago

Second pass at inline docs for wp-includes/option.php hooks. Corrected copy and paste error!

comment:7 siobhyb2 months ago

Still need to some @since's for this.

comment:8 DrewAPicture2 months ago

  • Keywords has-patch added; needs-patch removed

DrewAPicture7 weeks ago

3rd pass

comment:9 DrewAPicture7 weeks ago

25905.4.patch adds initial and double checked @since versions to all hooks. Also fixes parameter spacing to use spaces instead of tabs.

Next iteration will be on content of the hook docs, language tweaks, etc.

comment:10 DrewAPicture7 weeks ago

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

DrewAPicture7 weeks ago

4th pass.

comment:11 DrewAPicture7 weeks ago

  • Milestone changed from Awaiting Review to 3.9
  • Owner changed from DrewAPicture to kpdesign

25905.5.patch should do it. Just needs a second look and a recommendation.

comment:12 follow-up: bravokeyl7 weeks ago

How about adding @link links to codex-reference ...because i have seen for some of the fucnctions for eg: get_post_meta(), add_post_meta(),delete_post_meta() etc.,

Last edited 7 weeks ago by bravokeyl (previous) (diff)

comment:13 in reply to: ↑ 12 DrewAPicture7 weeks ago

Replying to bravokeyl:

How about addign @link links to codex-reference ...because i have seen for some of the fucnctions for ge: get_post_meta(), add_post_meta(),delete_post_meta() etc.,

Basically the reason we're documenting hooks in this way is because the Codex function references will soon be going away, and will be replaced by the Code Reference parsed from these docs. So, linking related Codex articles might be moot.

comment:14 follow-up: bravokeyl7 weeks ago

Okay..i didn't know that...
Then can we take out the existing codex link references ?

comment:15 in reply to: ↑ 14 DrewAPicture7 weeks ago

Replying to bravokeyl:

Okay..i didn't know that...
Then can we take out the existing codex link references ?

It's kind of a double-edged sword :)

We'll probably leave the existing references in place until the Code Reference replaces them, but we won't be introducing a new ones to the documentation in the meantime.

kpdesign7 weeks ago

Final pass

comment:16 kpdesign7 weeks ago

  • Keywords commit added

25905.6.patch includes a few tweaks to descriptions.

This one's ready to go in. Recommend commit.

comment:17 DrewAPicture7 weeks ago

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

In 27365:

Inline documentation for hooks in wp-includes/option.php.

Props siobhyb for the initial patch. Props DrewAPicture, kpdesign.
Fixes #25905.

Note: See TracTickets for help on using tickets.