[Converted to Issue] Functions should have a section about their hooks

[dd32]

The only way to see a list of filters/actions present within a function is to expand the code block and read through.

There should be a dedicated list of filters (and their short description) present on the function page, linking to the hooks info page.

[iandunn]

It'd be really helpful if that section also listed the earliest hook at which you can call the function (when applicable). Also any other pre-conditions.

That'd probably require annotating the source, but we could add the functionality to display it, and open a core/docs ticket for others to populate it.

[iandunn]

Although, it may actually be better if instead Core would trigger a PHP notice/warning when it's called before it should be 🤔

[dd32]

Core does have a number of places where _doing_it_wrong() is fired when it's called too early, but also where it's called too late.

[iandunn]

Hmmm, yeah. I guess in my workflow I go looking for "when should i..." before i start trying different actions. So maybe documenting it (in addition do _doing_it_wrong) is helpful.

There are also other places where those checks aren't added -- but probably should be -- like wp_get_current_user().

[iandunn]

I guess the docs would want to handle things like:

• Don't call before init
• Don't call after wp_loaded
• maybe also: Only call during foo