Changeset 9543

Timestamp:

02/24/2015 03:00:07 AM (11 years ago)

Author:

tw2113

Message:

Adds hooks documentation and cleanup to bp-core-admin-actions.php.

See #5940.

File:

• trunk/src/bp-core/admin/bp-core-admin-actions.php (modified) (8 diffs)

trunk/src/bp-core/admin/bp-core-admin-actions.php

@@ -2 +2 @@
 
 /**
- * BuddyPress Admin Actions
+ * BuddyPress Admin Actions.
  *
  * This file contains the actions that are used through-out BuddyPress Admin. They
@@ -8 +8 @@
  * understand at a glance the order in which things occur.
  *
- * There are a few common places that additional actions can currently be found
+ * There are a few common places that additional actions can currently be found.
  *
  *  - BuddyPress: In {@link BuddyPress::setup_actions()} in BuddyPress.php
@@ -23 +23 @@
 
 /**
- * Attach BuddyPress to WordPress
+ * Attach BuddyPress to WordPress.
  *
  * BuddyPress uses its own internal actions to help aid in third-party plugin
@@ -61 +61 @@
 /**
  * When a new site is created in a multisite installation, run the activation
- * routine on that site
- *
- * @since BuddyPress (1.7)
+ * routine on that site.
+ *
+ * @since BuddyPress (1.7.0)
  *
  * @param int $blog_id
@@ -70 +70 @@
  * @param string $path
  * @param int $site_id
- * @param array() $meta
+ * @param array $meta
  */
 function bp_new_site( $blog_id, $user_id, $domain, $path, $site_id, $meta ) {
@@ -81 +81 @@
     switch_to_blog( $blog_id );
 
-    // Do the BuddyPress activation routine
+    /**
+     * Fires the activation routine for a new site created in a multisite installation.
+     *
+     * @since BuddyPress (1.7.0)
+     *
+     * @param int    $blog_id ID of the blog being installed to.
+     * @param int    $user_id ID of the user the install is for.
+     * @param string $domain  Domain to use with the install.
+     * @param string $path    Path to use with the install.
+     * @param int    $site_id ID of the site being installed to.
+     * @param array  $meta    Metadata to use with the site creation.
+     */
     do_action( 'bp_new_site', $blog_id, $user_id, $domain, $path, $site_id, $meta );
 
@@ -91 +102 @@
 
 /**
- * Piggy back admin_init action
- *
- * @since BuddyPress (1.7)
- * @uses do_action() Calls 'bp_admin_init'
+ * Piggy back admin_init action.
+ *
+ * @since BuddyPress (1.7.0)
+ * @uses do_action() Calls 'bp_admin_init'.
  */
 function bp_admin_init() {
+
+    /**
+     * Fires inside the bp_admin_init function.
+     *
+     * @since BuddyPress (1.6.0)
+     */
     do_action( 'bp_admin_init' );
 }
 
 /**
- * Piggy back admin_menu action
- *
- * @since BuddyPress (1.7)
- * @uses do_action() Calls 'bp_admin_menu'
+ * Piggy back admin_menu action.
+ *
+ * @since BuddyPress (1.7.0)
+ * @uses do_action() Calls 'bp_admin_menu'.
  */
 function bp_admin_menu() {
+
+    /**
+     * Fires inside the bp_admin_menu function.
+     *
+     * @since BuddyPress (1.7.0)
+     */
     do_action( 'bp_admin_menu' );
 }
 
 /**
- * Piggy back admin_head action
- *
- * @since BuddyPress (1.7)
- * @uses do_action() Calls 'bp_admin_head'
+ * Piggy back admin_head action.
+ *
+ * @since BuddyPress (1.7.0)
+ * @uses do_action() Calls 'bp_admin_head'.
  */
 function bp_admin_head() {
+
+    /**
+     * Fires inside the bp_admin_head function.
+     *
+     * @since BuddyPress (1.6.0)
+     */
     do_action( 'bp_admin_head' );
 }
 
 /**
- * Piggy back admin_notices action
- *
- * @since BuddyPress (1.7)
- * @uses do_action() Calls 'bp_admin_notices'
+ * Piggy back admin_notices action.
+ *
+ * @since BuddyPress (1.7.0)
+ * @uses do_action() Calls 'bp_admin_notices'.
  */
 function bp_admin_notices() {
+
+    /**
+     * Fires inside the bp_admin_notices function.
+     *
+     * @since BuddyPress (1.5.0)
+     */
     do_action( 'bp_admin_notices' );
 }
@@ -138 +173 @@
  *
  * @param string $hook_suffix The current admin page, passed to
- *        'admin_enqueue_scripts'.
+ *                            'admin_enqueue_scripts'.
  */
 function bp_admin_enqueue_scripts( $hook_suffix = '' ) {
+
+    /**
+     * Fires inside the bp_admin_enqueue_scripts function.
+     *
+     * @since BuddyPress (1.7.0)
+     *
+     * @param string $hook_suffix The current admin page, passed to admin_enqueue_scripts.
+     */
     do_action( 'bp_admin_enqueue_scripts', $hook_suffix );
 }
 
 /**
- * Dedicated action to register BuddyPress importers
- *
- * @since BuddyPress (1.7)
- * @uses do_action() Calls 'bp_admin_notices'
+ * Dedicated action to register BuddyPress importers.
+ *
+ * @since BuddyPress (1.7.0)
+ * @uses do_action() Calls 'bp_admin_notices'.
  */
 function bp_register_importers() {
+
+    /**
+     * Fires inside the bp_register_importers function.
+     *
+     * Used to register a BuddyPress importer.
+     *
+     * @since BuddyPress (1.7.0)
+     */
     do_action( 'bp_register_importers' );
 }
 
 /**
- * Dedicated action to register admin styles
- *
- * @since BuddyPress (1.7)
- * @uses do_action() Calls 'bp_admin_notices'
+ * Dedicated action to register admin styles.
+ *
+ * @since BuddyPress (1.7.0)
+ * @uses do_action() Calls 'bp_admin_notices'.
  */
 function bp_register_admin_style() {
+
+    /**
+     * Fires inside the bp_register_admin_style function.
+     *
+     * @since BuddyPress (1.7.0)
+     */
     do_action( 'bp_register_admin_style' );
 }
 
 /**
- * Dedicated action to register admin settings
- *
- * @since BuddyPress (1.7)
- * @uses do_action() Calls 'bp_register_admin_settings'
+ * Dedicated action to register admin settings.
+ *
+ * @since BuddyPress (1.7.0)
+ * @uses do_action() Calls 'bp_register_admin_settings'.
  */
 function bp_register_admin_settings() {
+
+    /**
+     * Fires inside the bp_register_admin_settings function.
+     *
+     * @since BuddyPress (1.6.0)
+     */
     do_action( 'bp_register_admin_settings' );
 }