Changeset 9544 for trunk/src/bp-core/admin/bp-core-admin-components.php

Timestamp:

02/24/2015 03:04:40 AM (11 years ago)

Author:

tw2113

Message:

Adds hook documentation to bp-core-admin-components.php.

See #5940.

File:

• trunk/src/bp-core/admin/bp-core-admin-components.php (modified) (7 diffs)

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

@@ -15 +15 @@
  *
  * @package BuddyPress
- * @since BuddyPress (1.6)
+ * @since BuddyPress (1.6.0)
  * @uses bp_core_admin_component_options()
  */
@@ -45 +45 @@
  *
  * @package BuddyPress
- * @since BuddyPress (1.6)
+ * @since BuddyPress (1.6.0)
  * @todo Use settings API
  */
@@ -52 +52 @@
         // Declare local variables
         $deactivated_components = array();
+
+        /**
+         * Filters the array of available components.
+         *
+         * @since BuddyPress (1.5.0)
+         *
+         * @param mixed $value Active components.
+         */
         $active_components      = apply_filters( 'bp_active_components', bp_get_option( 'bp-active-components' ) );
 
@@ -228 +236 @@
  * Handle saving the Component settings
  *
- * @since BuddyPress (1.6)
+ * @since BuddyPress (1.6.0)
  * @todo Use settings API when it supports saving network settings
  */
@@ -287 +295 @@
  *   ones.
  *
- * @since (BuddyPress) 1.7
+ * @since BuddyPress (1.7.0)
  *
  * @param array This is the array of component settings coming from the POST
@@ -332 +340 @@
  * well as to do some processing on settings data submitted from those screens.
  *
- * @since (BuddyPress) 1.7
+ * @since BuddyPress (1.7.0)
  *
  * @param string $type 'all', 'optional', 'retired', 'required'
@@ -422 +430 @@
         }
 
+        /**
+         * Filters the list of component information.
+         *
+         * @since BuddyPress (2.0.0)
+         *
+         * @param array  $components Array of component information.
+         * @param string $type       Type of component list requested.
+         *                           Possible values include 'all', 'optional',
+         *                                                       'retired', 'required'.
+         */
         return apply_filters( 'bp_core_admin_get_components', $components, $type );
 }