From db8a601bf9f15bdedde789034899769f8e3d43f9 Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Tue, 19 Nov 2013 23:15:07 +0000 Subject: [PATCH] Inline documentation for hooks in wp-admin/edit-tags.php. Props pauldewouters for the initial patch. Fixes #25532. git-svn-id: https://develop.svn.wordpress.org/trunk@26274 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-admin/edit-tag-form.php | 20 ++-- src/wp-admin/edit-tags.php | 171 +++++++++++++++++++++++++++++---- 2 files changed, 162 insertions(+), 29 deletions(-) diff --git a/src/wp-admin/edit-tag-form.php b/src/wp-admin/edit-tag-form.php index b8f4125315..dd611dacbb 100644 --- a/src/wp-admin/edit-tag-form.php +++ b/src/wp-admin/edit-tag-form.php @@ -17,14 +17,18 @@ if ( empty($tag_ID) ) { ?> } // Back compat hooks -if ( 'category' == $taxonomy ) - do_action('edit_category_form_pre', $tag ); -elseif ( 'link_category' == $taxonomy ) - do_action('edit_link_category_form_pre', $tag ); -else - do_action('edit_tag_form_pre', $tag); - -do_action($taxonomy . '_pre_edit_form', $tag, $taxonomy); ?> +if ( 'category' == $taxonomy ) { + /** This action is documented in wp-admin/edit-tags.php */ + do_action( 'edit_category_form_pre', $tag ); +} elseif ( 'link_category' == $taxonomy ) { + /** This action is documented in wp-admin/edit-tags.php */ + do_action( 'edit_link_category_form_pre', $tag ); +} else { + /** This action is documented in wp-admin/edit-tags.php */ + do_action( 'edit_tag_form_pre', $tag ); +} +/** This action is documented in wp-admin/edit-tags.php */ +do_action( "{$taxonomy}_pre_edit_form", $tag, $taxonomy ); ?>
diff --git a/src/wp-admin/edit-tags.php b/src/wp-admin/edit-tags.php index 0a046370b3..795879dbc1 100644 --- a/src/wp-admin/edit-tags.php +++ b/src/wp-admin/edit-tags.php @@ -281,6 +281,13 @@ $messages['post_tag'] = array( 6 => __( 'Tags deleted.' ) ); +/** + * Filter the messages displayed when a tag is updated. + * + * @since 3.7.0 + * + * @param array $messages The messages to be displayed. + */ $messages = apply_filters( 'term_updated_messages', $messages ); $message = false; @@ -340,7 +347,17 @@ endif; ?>

tag to category converter.'), 'import.php') ;?>

@@ -368,20 +385,62 @@ endif; } if ( current_user_can($tax->cap->edit_terms) ) { - // Back compat hooks. Deprecated in preference to {$taxonomy}_pre_add_form - if ( 'category' == $taxonomy ) - do_action('add_category_form_pre', (object)array('parent' => 0) ); - elseif ( 'link_category' == $taxonomy ) - do_action('add_link_category_form_pre', (object)array('parent' => 0) ); - else - do_action('add_tag_form_pre', $taxonomy); + if ( 'category' == $taxonomy ) { + /** + * Fires before the Add Category form. + * + * @since 2.1.0 + * @deprecated 3.0.0 Use {$taxonomy}_pre_add_form instead. + * + * @param object $arg Optional arguments cast to an object. + */ + do_action( 'add_category_form_pre', (object) array( 'parent' => 0 ) ); + } elseif ( 'link_category' == $taxonomy ) { + /** + * Fires before the link category form. + * + * @since 2.3.0 + * @deprecated 3.0.0 Use {$taxonomy}_pre_add_form instead. + * + * @param object $arg Optional arguments cast to an object. + */ + do_action( 'add_link_category_form_pre', (object) array( 'parent' => 0 ) ); + } else { + /** + * Fires before the Add Tag form. + * + * @since 2.5.0 + * @deprecated 3.0.0 Use {$taxonomy}_pre_add_form instead. + * + * @param string $taxonomy The taxonomy slug. + */ + do_action( 'add_tag_form_pre', $taxonomy ); + } - do_action($taxonomy . '_pre_add_form', $taxonomy); + /** + * Fires before the Add Term form for all taxonomies. + * + * The dynamic portion of the hook name, $taxonomy, refers to the taxonomy slug. + * + * @since 3.0.0 + * + * @param string $taxonomy The taxonomy slug. + */ + do_action( "{$taxonomy}_pre_add_form", $taxonomy ); ?>

labels->add_new_item; ?>

-
> + +> @@ -414,6 +473,25 @@ if ( current_user_can($tax->cap->edit_terms) ) { 'show_option_none' => __( 'None' ), ); + /** + * Filter the taxonomy parent drop-down on the Edit Term page. + * + * @since 3.7.0 + * + * @param array $dropdown_args { + * An array of taxonomy parent drop-down arguments. + * + * @type int|bool $hide_empty Whether to hide terms not attached to any posts. Default 0|false. + * @type bool $hide_if_empty Whether to hide the drop-down if no terms exist. Default false. + * @type string $taxonomy The taxonomy slug. + * @type string $name Value of the name attribute to use for the drop-down select element. + * Default 'parent'. + * @type string $orderby The field to order by. Default 'name'. + * @type bool $hierarchical Whether the taxonomy is hierarchical. Default true. + * @type string $show_option_none Label to display if there are no terms. Default 'None'. + * } + * @param string $taxonomy The taxonomy slug. + */ $dropdown_args = apply_filters( 'taxonomy_parent_dropdown_args', $dropdown_args, $taxonomy ); wp_dropdown_categories( $dropdown_args ); ?> @@ -429,21 +507,72 @@ if ( current_user_can($tax->cap->edit_terms) ) {
labels->add_new_item ); -// Back compat hooks. Deprecated in preference to {$taxonomy}_add_form -if ( 'category' == $taxonomy ) - do_action('edit_category_form', (object)array('parent' => 0) ); -elseif ( 'link_category' == $taxonomy ) - do_action('edit_link_category_form', (object)array('parent' => 0) ); -else - do_action('add_tag_form', $taxonomy); +if ( 'category' == $taxonomy ) { + /** + * Fires at the end of the Edit Category form. + * + * @since 2.1.0 + * @deprecated 3.0.0 Use {$taxonomy}_add_form instead. + * + * @param object $arg Optional arguments cast to an object. + */ + do_action( 'edit_category_form', (object) array( 'parent' => 0 ) ); +} elseif ( 'link_category' == $taxonomy ) { + /** + * Fires at the end of the Edit Link form. + * + * @since 2.3.0 + * @deprecated 3.0.0 Use {$taxonomy}_add_form instead. + * + * @param object $arg Optional arguments cast to an object. + */ + do_action( 'edit_link_category_form', (object) array( 'parent' => 0 ) ); +} else { + /** + * Fires at the end of the Add Tag form. + * + * @since 2.7.0 + * @deprecated 3.0.0 Use {$taxonomy}_add_form instead. + * + * @param string $taxonomy The taxonomy slug. + */ + do_action( 'add_tag_form', $taxonomy ); +} -do_action($taxonomy . '_add_form', $taxonomy); +/** + * Fires at the end of the Add Term form for all taxonomies. + * + * The dynamic portion of the hook name, $taxonomy, refers to the taxonomy slug. + * + * @since 3.0.0 + * + * @param string $taxonomy The taxonomy slug. + */ +do_action( "{$taxonomy}_add_form", $taxonomy ); ?>