Common Hook Explanations

Mods, feel free to remove this if you don’t think it is appropriate for this section.

That being said, I would like to see some better/more documentation on the hooks, filters, classes. I love having so many options, but the number of options also makes it harder to know which ones do what. I and others have spent a ton of time with trial and error going through hooks and filters to find the right one for our purposes.

I know the developers and customer service guys have their hands full so I thought maybe we could make an “unofficial guide” to documenting what hooks we use and why and what they do.

It would be nice if this could be it’s own forum so we can include topic titles or maybe we could just put it here, though it may be harder to search through if it’s included with the hacks.

I would think the post would be something like this:

Title: hook or filter name : Explained
Post:
Class Name
Hook Name
How it works, what it does, where it is in the process, notable variables available (not all, just ones specific to the function)

Just a thought. Thanks for reading! lol!

Dave

EDIT: I do see this as being different from the Hacks, simply because it’s more educational and less “fix it” or “hack” if that makes sense.

• This topic was modified 4 years, 10 months ago by  David Welch.

David Welch. Forum rank/icon updated to Experienced User.

Thanks David. Yes, I couldn’t agree more. We’ll probably never document ALL of them in great detail (well over 1000 now), but we’d certainly like to document the most important ones. We’ll be working to improve this as we move forward this year.

As it exists now, the s2Member Codex does already include some prelimary documentation for ALL Hooks/Filters, broken down by Package Class, and with references to where each Hook/Filter is located in the source code.

See Also: s2Member® » Codex (Source Code Docs)