Docs: Add examples of possible names for various hooks whose name contains a dynamic portion.

This provides greater discoverability of such hooks in search results on the Code Reference site as well as increased clarity when reading the source.

See #50734, #52628


git-svn-id: https://develop.svn.wordpress.org/trunk@50505 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
John Blackbourn
2021-03-07 12:30:38 +00:00
parent c3be472657
commit fa05e5e733
26 changed files with 403 additions and 35 deletions

View File

@@ -627,6 +627,11 @@ function get_taxonomy_labels( $tax ) {
*
* The dynamic portion of the hook name, `$taxonomy`, refers to the taxonomy slug.
*
* Possible hook names include:
*
* - `taxonomy_labels_category`
* - `taxonomy_labels_post_tag`
*
* @since 4.4.0
*
* @see get_taxonomy_labels() for the full list of taxonomy labels.
@@ -2031,6 +2036,11 @@ function wp_delete_term( $term, $taxonomy, $args = array() ) {
* The dynamic portion of the hook name, `$taxonomy`, refers to the specific
* taxonomy the term belonged to.
*
* Possible hook names include:
*
* - `delete_category`
* - `delete_post_tag`
*
* @since 2.3.0
* @since 4.5.0 Introduced the `$object_ids` argument.
*
@@ -2474,6 +2484,11 @@ function wp_insert_term( $term, $taxonomy, $args = array() ) {
* The dynamic portion of the hook name, `$taxonomy`, refers
* to the slug of the taxonomy the term was created for.
*
* Possible hook names include:
*
* - `create_category`
* - `create_post_tag`
*
* @since 2.3.0
*
* @param int $term_id Term ID.
@@ -2513,6 +2528,11 @@ function wp_insert_term( $term, $taxonomy, $args = array() ) {
*
* The dynamic portion of the hook name, `$taxonomy`, refers to the taxonomy slug.
*
* Possible hook names include:
*
* - `created_category`
* - `created_post_tag`
*
* @since 2.3.0
*
* @param int $term_id Term ID.
@@ -2541,6 +2561,11 @@ function wp_insert_term( $term, $taxonomy, $args = array() ) {
*
* The dynamic portion of the hook name, `$taxonomy`, refers to the taxonomy slug.
*
* Possible hook names include:
*
* - `saved_category`
* - `saved_post_tag`
*
* @since 5.5.0
*
* @param int $term_id Term ID.
@@ -3186,6 +3211,11 @@ function wp_update_term( $term_id, $taxonomy, $args = array() ) {
*
* The dynamic portion of the hook name, `$taxonomy`, refers to the taxonomy slug.
*
* Possible hook names include:
*
* - `edit_category`
* - `edit_post_tag`
*
* @since 2.3.0
*
* @param int $term_id Term ID.
@@ -3218,6 +3248,11 @@ function wp_update_term( $term_id, $taxonomy, $args = array() ) {
*
* The dynamic portion of the hook name, `$taxonomy`, refers to the taxonomy slug.
*
* Possible hook names include:
*
* - `edited_category`
* - `edited_post_tag`
*
* @since 2.3.0
*
* @param int $term_id Term ID.