Changeset 26274

Timestamp:

11/19/2013 11:15:07 PM (11 years ago)

Author:

DrewAPicture

Message:

Inline documentation for hooks in wp-admin/edit-tags.php.

Props pauldewouters for the initial patch.
Fixes #25532.

Location:

trunk/src/wp-admin

Files:

• edit-tag-form.php (modified) (1 diff)
• edit-tags.php (modified) (5 diffs)

trunk/src/wp-admin/edit-tag-form.php

@@ -18 +18 @@
 
 // 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 ); ?>
 
 <div class="wrap">

trunk/src/wp-admin/edit-tags.php

@@ -282 +282 @@
 );
 
+/**
+ * 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 );
 
@@ -341 +348 @@
 </div>
 <?php endif;
-do_action('after-' . $taxonomy . '-table', $taxonomy);
+
+/**
+ * Fires after the taxonomy list table.
+ *
+ * The dynamic portion of the hook name, $taxonomy, refers to the taxonomy slug.
+ *
+ * @since 3.0.0
+ *
+ * @param string $taxonomy The taxonomy name.
+ */
+do_action( "after-{$taxonomy}-table", $taxonomy );
 ?>
 
@@ -369 +386 @@
 
 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);
-
-    do_action($taxonomy . '_pre_add_form', $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 );
+    }
+
+    /**
+     * 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 );
 ?>
 
 <div class="form-wrap">
 <h3><?php echo $tax->labels->add_new_item; ?></h3>
-<form id="addtag" method="post" action="edit-tags.php" class="validate"<?php do_action( $taxonomy . '_term_new_form_tag' ); ?>>
+<?php
+/**
+ * Fires at the beginning of the Add Tag form.
+ *
+ * The dynamic portion of the hook name, $taxonomy, refers to the taxonomy slug.
+ *
+ * @since 3.0.0
+ */
+?>
+<form id="addtag" method="post" action="edit-tags.php" class="validate"<?php do_action( "{$taxonomy}_term_new_form_tag" ); ?>>
 <input type="hidden" name="action" value="add-tag" />
 <input type="hidden" name="screen" value="<?php echo esc_attr($current_screen->id); ?>" />
@@ -415 +474 @@
     );
 
+    /**
+     * 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 );
@@ -430 +508 @@
 
 <?php
-if ( ! is_taxonomy_hierarchical($taxonomy) )
-    do_action('add_tag_form_fields', $taxonomy);
-do_action($taxonomy . '_add_form_fields', $taxonomy);
+if ( ! is_taxonomy_hierarchical( $taxonomy ) ) {
+    /**
+     * Fires after the Add Tag form fields for non-hierarchical taxonomies.
+     *
+     * @since 3.0.0
+     *
+     * @param string $taxonomy The taxonomy slug.
+     */
+    do_action( 'add_tag_form_fields', $taxonomy );
+}
+
+/**
+ * Fires after the Add Term form fields for hierarchical 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_fields", $taxonomy );
 
 submit_button( $tax->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);
-
-do_action($taxonomy . '_add_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 );
+}
+
+/**
+ * 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 );
 ?>
 </form></div>