WordPress Hooks

Step 1
Go thee forth and register an account.

Step 2
Wait for someone to promote your account to have posting access. Or, hop into #wordpress and bug me about it. Nicely.

Step 3
Contribute! But first, read the rest of the steps.

Step 4
Write or edit an entry, using the correct format, which is as follows

<code>%TITLE%</code> is [an action/a filter] that [is fired when X happens/filters Y] and is related to <a href="/hooks/some_other_hook/">some_other_hook</a> and has something to do with <code>some_wordpress_function()</code>. It accepts [list parameters] as parameters and returns [the thing that it returns].

[Example of clever usage can go here, as well as special notes about any "gotchas"]

<pre class="context"><file>path/to/file/containing/hook/</file>
// PHP code goes here
// Note: do NOT encode HTML entities... just paste it raw
$foo = <em>apply_filters('some_action', $blah)</em>;

// Note: wrap the actual apply_filters() or do_action() call in <em></em>, which will highlight
// it in the code<
</pre>

Step 5
Correctly categorize the hook.

Select one of:

• action
• filter

If the hook accepts any number of parameters other than one, select the category with the correct number of categories. If the number of parameters is two or more, additionally select the "multiple parameters" category.

If the hook was introduced in a specific WordPress version (i.e. other than 1.5.3), select that category.

If the hook utilizes a wildcard section (i.e. part of the hook name is dynamic), select the "wildcard" category.

Select any additional categories that apply. Please ask me for clarification, or view other hooks to see examples.

Step 6
Title the hook. For regular hooks, the title should be the hook name. For "wildcard" hooks, name like so:

For a hook that is 'activate_' . $plugin_filename, the name would be activate_plugin-filename. Please ask me if you are unsure about this.

Step 7
Publish! Thanks for helping out.