bobbingwide
commented
10 years ago For my oik plugin shortcodes I considered parsing the code to determine the parameters that the shortcode would accept but eventually I plumped for providing dynamically generated hooks for each shortcode to implement that allowed it to return:
- help - a one line description
- syntax - the parameters and possible values
- example - a hardcoded example
- live example - an generated example using live content
- snippet - the snippet of HTML that the shortcode generates
http://www.oik-plugins.com/oik_shortcodes/bw_code/
I also created a simple dialog box to help users with the creation of shortcodes accessible from both TinyMCE and as a quicktag. The code needs a little love and attention... the sort that this shortcode-suggest plugin can give.
JDGrimes
danielpataki
Hi Scott,
Awesome work! We did something like this for our themes for buyers to be able to see what shortcodes there are. We also bumped up agains the "how to document arguments" issue. In the end we created a globally available "documentation array" which we added to when registering each shortcode.
Another method is to parse out phpdoc documentation but this would be a LOT more difficult I imagine as the docblock is added before the function definition.
I've been trying to think of a WordPress standard way to do this, but I don't think it's possible at the moment. The documentation array worked for us, but I don't know if this could/should be widely used.
I will definitely keep an eye on the project and contribute if I can!
Daniel