Changeset 10354 for trunk/src/bp-core/admin/bp-core-admin-actions.php

Timestamp:

11/15/2015 06:56:24 PM (11 years ago)

Author:

tw2113

Message:

More documentation cleanup for part of BP-Core component.

See #6398.

File:

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

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

@@ -35 +35 @@
  * near the bottom of this file.
  *
- *           v--WordPress Actions       v--BuddyPress Sub-actions
+ *          v--WordPress Actions       v--BuddyPress Sub-actions
  */
 add_action( 'admin_menu',              'bp_admin_menu'                    );
@@ -47 +47 @@
 add_action( 'wpmu_new_blog',           'bp_new_site',               10, 6 );
 
-// Hook on to admin_init
+// Hook on to admin_init.
 add_action( 'bp_admin_init', 'bp_setup_updater',          1000 );
 add_action( 'bp_admin_init', 'bp_core_activation_notice', 1010 );
@@ -55 +55 @@
 add_action( 'bp_admin_init', 'bp_do_activation_redirect', 1    );
 
-// Add a new separator
+// Add a new separator.
 add_action( 'bp_admin_menu', 'bp_admin_separator' );
 
@@ -64 +64 @@
  * @since 1.7.0
  *
- * @param int    $blog_id
- * @param int    $user_id
- * @param string $domain
- * @param string $path
- * @param int    $site_id
- * @param array  $meta
+ * @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.
  */
 function bp_new_site( $blog_id, $user_id, $domain, $path, $site_id, $meta ) {
 
-        // Bail if plugin is not network activated
+        // Bail if plugin is not network activated.
         if ( ! is_plugin_active_for_network( buddypress()->basename ) )
                 return;
 
-        // Switch to the new blog
+        // Switch to the new blog.
         switch_to_blog( $blog_id );
 
@@ -94 +94 @@
         do_action( 'bp_new_site', $blog_id, $user_id, $domain, $path, $site_id, $meta );
 
-        // restore original blog
+        // Restore original blog.
         restore_current_blog();
 }
@@ -104 +104 @@
  *
  * @since 1.7.0
+ *
  * @uses do_action() Calls 'bp_admin_init'.
  */
@@ -120 +121 @@
  *
  * @since 1.7.0
+ *
  * @uses do_action() Calls 'bp_admin_menu'.
  */
@@ -136 +138 @@
  *
  * @since 1.7.0
+ *
  * @uses do_action() Calls 'bp_admin_head'.
  */
@@ -152 +155 @@
  *
  * @since 1.7.0
+ *
  * @uses do_action() Calls 'bp_admin_notices'.
  */
@@ -169 +173 @@
  * @since 1.7.0
  *
- * @uses do_action() Calls 'bp_admin_enqueue_scripts''.
+ * @uses do_action() Calls 'bp_admin_enqueue_scripts'.
  *
  * @param string $hook_suffix The current admin page, passed to
@@ -190 +194 @@
  *
  * @since 1.7.0
+ *
  * @uses do_action() Calls 'bp_admin_notices'.
  */
@@ -208 +213 @@
  *
  * @since 1.7.0
+ *
  * @uses do_action() Calls 'bp_admin_notices'.
  */
@@ -224 +230 @@
  *
  * @since 1.7.0
+ *
  * @uses do_action() Calls 'bp_register_admin_settings'.
  */