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

[siobhyb]

Patch forthcoming.

[siobhyb]

FYI: Still working on this. So many hooks!

[DrewAPicture]

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

[siobhyb]

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

[siobhyb]

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

[siobhyb]

First pass at inline docs for filters.

[siobhyb]

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

[siobhyb]

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

[siobhyb]

Still need to some @since's for this.

[DrewAPicture]

3rd pass

[DrewAPicture]

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.

[DrewAPicture]

4th pass.

[DrewAPicture]

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

[bravokeyl]

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.,

[DrewAPicture]

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.

[bravokeyl]

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

[DrewAPicture]

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.

[kpdesign]

Final pass

[kpdesign]

25905.6.patch​ includes a few tweaks to descriptions.

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

[DrewAPicture]

In 27365:

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

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

[johnbillion]

In 30943:

Add braces around a Docblock in an if statement, although not required by PHP, this is required by our coding standards for readability.
Introduced in 3.9 with r27365

Merges [30886] to the 4.1 branch.

See #25905