Changeset 28351

Timestamp:

05/08/2014 10:59:17 AM (10 years ago)

Author:

DrewAPicture

Message:

Rename the $action hook in wp-admin/admin-post.php to admin_post{$action}.

Also, clarify documentation of priv vs nopriv prefixing of the hook name.

See #26869.

File:

• trunk/src/wp-admin/admin-post.php (modified) (2 diffs)

trunk/src/wp-admin/admin-post.php

@@ -27 +27 @@
 do_action( 'admin_init' );
 
-$action = 'admin_post';
+$action = '';
 
 if ( !wp_validate_auth_cookie() )
@@ -38 +38 @@
  * Fires the requested handler action.
  *
- * admin_post_nopriv_{$_REQUEST['action']} is called for not-logged-in users.
- * admin_post_{$_REQUEST['action']} is called for logged-in users.
+ * The dynamic portion of the hook name, $action, refers to a combination
+ * of whether the user is logged-in or not, and the requested handler action.
+ *
+ * If the user is logged-out, '_nopriv' will be affixed to the
+ * base "admin_post" hook name. If a handler action was passed, that action
+ * will also be affixed.
+ * 
+ * For example:
+ * Hook combinations fired for logged-out users:
+ * `admin_post_nopriv_{$action}` and `admin_post_nopriv` (no action supplied).
+ *
+ * Hook combinations fired for logged-in users:
+ * `admin_post_{$action}` and `admin_post` (no action supplied).
  *
  * @since 2.6.0
  */
-do_action( $action );
+do_action( "admin_post{$action}" );