Changeset 25558

Timestamp:

09/21/2013 08:46:15 PM (12 years ago)

Author:

DrewAPicture

Message:

Inline documentation for hooks in wp-admin/includes/ajax-actions.php.

Fixes #25374.

File:

• trunk/src/wp-admin/includes/ajax-actions.php (modified) (11 diffs)

trunk/src/wp-admin/includes/ajax-actions.php

@@ -27 +27 @@
     if ( ! empty($_POST['data']) ) {
         $data = wp_unslash( (array) $_POST['data'] );
+
+        /**
+         * Filter Heartbeat AJAX response in no-privilege environments.
+         *
+         * @since 3.6.0
+         *
+         * @param array|object $response  The no-priv Heartbeat response object or array.
+         * @param array        $data      An array of data passed via $_POST.
+         * @param string       $screen_id The screen id.
+         */
         $response = apply_filters( 'heartbeat_nopriv_received', $response, $data, $screen_id );
     }
 
+    /**
+     * Filter Heartbeat AJAX response when no data is passed.
+     *
+     * @since 3.6.0
+     *
+     * @param array|object $response  The Heartbeat response object or array.
+     * @param string       $screen_id The screen id.
+     */
     $response = apply_filters( 'heartbeat_nopriv_send', $response, $screen_id );
 
-    // Allow the transport to be replaced with long-polling easily
+    /**
+     * Fires when Heartbeat ticks in no-privilege environments.
+     *
+     * Allows the transport to be easily replaced with long-polling.
+     *
+     * @since 3.6.0
+     *
+     * @param array|object $response  The no-priv Heartbeat response.
+     * @param string       $screen_id The screen id.
+     */
     do_action( 'heartbeat_nopriv_tick', $response, $screen_id );
 
@@ -164 +191 @@
         wp_die( -1 );
 
+    //duplicate_hook
     if ( ! is_super_admin() && ! apply_filters( 'autocomplete_users_for_site_admins', false ) )
         wp_die( -1 );
@@ -922 +950 @@
     }
 
+    /**
+     * Filter the Walker class used when adding nav menu items.
+     *
+     * @since 3.4.0
+     *
+     * @param string $class   The walker class to use. Default 'Walker_Nav_Menu_Edit'.
+     * @param int    $menu_id The menu id, derived from $_POST['menu'].
+     */
     $walker_class_name = apply_filters( 'wp_edit_nav_menu_walker', 'Walker_Nav_Menu_Edit', $_POST['menu'] );
 
@@ -1193 +1229 @@
 
     if ( ! empty( $_POST['item-object'] ) && isset( $items[$_POST['item-object']] ) ) {
-        $item = apply_filters( 'nav_menu_meta_box_object', $items[ $_POST['item-object'] ] );
+        $menus_meta_box_object = $items[ $_POST['item-object'] ];
+        /**
+         * Filter a nav menu meta box object.
+         *
+         * @since 3.0.0
+         *
+         * @param object $menus_meta_box_object A nav menu meta box object, such as Page, Post, Category, Tag, etc.
+         */
+        $item = apply_filters( 'nav_menu_meta_box_object', $menus_meta_box_object );
         ob_start();
         call_user_func_array($callback, array(
@@ -1522 +1566 @@
     unset( $_POST['savewidgets'], $_POST['action'] );
 
-    do_action('load-widgets.php');
-    do_action('widgets.php');
-    do_action('sidebar_admin_setup');
+    /**
+     * Fires early when editing the widgets displayed in sidebars.
+     *
+     * @since 2.8.0
+     */
+    do_action( 'load-widgets.php' );
+
+    /**
+     * Fires early when editing the widgets displayed in sidebars.
+     *
+     * @since 2.8.0
+     */
+    do_action( 'widgets.php' );
+
+    /**
+     * Fires early when editing the widgets displayed in sidebars.
+     *
+     * @since 2.2.0
+     */
+    do_action( 'sidebar_admin_setup' );
 
     $id_base = $_POST['id_base'];
@@ -1778 +1839 @@
         wp_die( 0 );
 
+    /**
+     * Filter the post lock window duration.
+     *
+     * @since 3.3.0
+     *
+     * @param int $interval The interval in seconds the post lock duration should last, plus 5 seconds. Default 120.
+     */
     $new_lock = ( time() - apply_filters( 'wp_check_post_lock_window', 120 ) + 5 ) . ':' . $active_lock[1];
     update_post_meta( $post_id, '_edit_lock', $new_lock, implode( ':', $active_lock ) );
@@ -1853 +1921 @@
      *
      * @since 3.7.0
-     * @param array $query Array of query variables.
+     *
+     * @param array $query An array of query variables. @see WP_Query::parse_query()
      */
     $query = apply_filters( 'ajax_query_attachments_args', $query );
@@ -1934 +2003 @@
         wp_send_json_error();
 
+    //duplicate_hook
     $post = apply_filters( 'attachment_fields_to_save', $post, $attachment_data );
 
@@ -2036 +2106 @@
     }
 
+    //duplicate_hook
     $html = apply_filters( 'media_send_to_editor', $html, $id, $attachment );
 
@@ -2076 +2147 @@
             $type = $ext_type;
 
+    //duplicate_hook
     $html = apply_filters( $type . '_send_to_editor_url', $html, $src, $title );
 
@@ -2106 +2178 @@
     if ( ! empty($_POST['data']) ) {
         $data = (array) $_POST['data'];
+
+        /**
+         * Filter the Heartbeat response received.
+         *
+         * @since 3.6.0
+         *
+         * @param array|object $response  The Heartbeat response object or array.
+         * @param array        $data      The $_POST data sent.
+         * @param string       $screen_id The screen id.
+         */
         $response = apply_filters( 'heartbeat_received', $response, $data, $screen_id );
     }
 
+    /**
+     * Filter the Heartbeat response sent.
+     *
+     * @since 3.6.0
+     *
+     * @param array|object $response  The Heartbeat response object or array.
+     * @param string       $screen_id The screen id.
+     */
     $response = apply_filters( 'heartbeat_send', $response, $screen_id );
 
-    // Allow the transport to be replaced with long-polling easily
+    /**
+     * Fires when Heartbeat ticks in logged-in environments.
+     *
+     * Allows the transport to be easily replaced with long-polling.
+     *
+     * @since 3.6.0
+     *
+     * @param array|object $response  The Heartbeat response object or array.
+     * @param string       $screen_id The screen id.
+     */
     do_action( 'heartbeat_tick', $response, $screen_id );