[wp-hackers] Hook (Filter, Action) Documentation Idea

hakre hanskrentel at yahoo.de
Thu Sep 9 10:08:35 UTC 2010

----- Ursprüngliche Mail ----

> Von: Jacob Santos <wordpress at santosj.name>
> An: wp-hackers at lists.automattic.com
> Gesendet: Mittwoch, den 8. September 2010, 22:29:33 Uhr
> Betreff: Re: [wp-hackers] Hook (Filter, Action) Documentation Idea
> Well, my point was that given the large number of hooks, that it is  almost
> impractical to create a separate method or function describing each  hook.

Yeah documentation sucks. Really. It's only work, is it impractical? Probably.

My Hook Tracer so far successfully extracts the name of the hook and locates the 
calling location and type (filter, action, direct or ref_array method). I'm 
currently fiddling with parameters and I might be able to even substract the 
VARY part directly from code because of variable usage.

> 300 or 400 is probably the limit I would be at.

Reminds me that describing each hook might be totally optional. So if 
automatically generated the skeleton of such a file would be already pretty much 
done if I can figure out the stuff for VARY.

> Also, given  the
> already intermittent nature of inline documentation corrections, updates  and
> additions; it seems somewhat problematic to force people into adding a  new
> method when they add a new filter or action.

Forcing? This is not why I suggested it. I was looking for feedback. I can 
understand that some think that this looks like just as much work. And therefore 

> Given that those  writing
> patches might not even know about the method Hakre  describes

Yeah. But on the opposite most developers know about PHP and Comments, and the 
Docblock conventions. So it's mainly build on exisiting things which makes it 
easy to adopt.

-- hakre

More information about the wp-hackers mailing list