Changeset 9597

Timestamp:

03/05/2015 05:08:16 AM (11 years ago)

Author:

tw2113

Message:

Adds hooks documentation for bp-core-loader.php.

See #5940.

File:

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

trunk/src/bp-core/bp-core-loader.php

@@ -44 +44 @@
 
         /**
-         * At this point in the stack, BuddyPress core has been loaded but
-         * individual components (friends/activity/groups/etc...) have not.
-         *
-         * The 'bp_core_loaded' action lets you execute code ahead of the
-         * other components.
+         * Fires before the loading of individual components and after BuddyPress Core.
+         *
+         * Allows plugins to run code ahead of the other components.
+         *
+         * @since BuddyPress (1.2.0)
          */
         do_action( 'bp_core_loaded' );
@@ -54 +54 @@
         /** Components ********************************************************/
 
-        // Set the included and optional components.
+        /**
+         * Filters the included and optional components.
+         *
+         * @since BuddyPress (1.5.0)
+         *
+         * @param array $value Array of included and optional components.
+         */
         $bp->optional_components = apply_filters( 'bp_optional_components', array( 'activity', 'blogs', 'forums', 'friends', 'groups', 'messages', 'notifications', 'settings', 'xprofile' ) );
 
-        // Set the required components
+        /**
+         * Filters the required components.
+         *
+         * @since BuddyPress (1.5.0)
+         *
+         * @param array $value Array of required components.
+         */
         $bp->required_components = apply_filters( 'bp_required_components', array( 'members' ) );
 
         // Get a list of activated components
         if ( $active_components = bp_get_option( 'bp-active-components' ) ) {
+
+            /** This filter is documented in bp-core/admin/bp-core-admin-components.php */
             $bp->active_components      = apply_filters( 'bp_active_components', $active_components );
+
+            /**
+             * Filters the deactivated components.
+             *
+             * @since BuddyPress (1.0.0)
+             *
+             * @param array $value Array of deactivated components.
+             */
             $bp->deactivated_components = apply_filters( 'bp_deactivated_components', array_values( array_diff( array_values( array_merge( $bp->optional_components, $bp->required_components ) ), array_keys( $bp->active_components ) ) ) );
 
@@ -73 +95 @@
             }
 
-            // Set globals
+            /** This filter is documented in bp-core/bp-core-loader.php */
             $bp->deactivated_components = apply_filters( 'bp_deactivated_components', $trimmed );
 
@@ -79 +101 @@
             $active_components     = array_fill_keys( array_diff( array_values( array_merge( $bp->optional_components, $bp->required_components ) ), array_values( $bp->deactivated_components ) ), '1' );
 
-            // Set the active component global
+            /** This filter is documented in bp-core/admin/bp-core-admin-components.php */
             $bp->active_components = apply_filters( 'bp_active_components', $bp->active_components );
 
@@ -91 +113 @@
             $active_components     = array_fill_keys( array_values( array_merge( $bp->optional_components, $bp->required_components ) ), '1' );
 
-            // Set the active component global
+            /** This filter is documented in bp-core/admin/bp-core-admin-components.php */
             $bp->active_components = apply_filters( 'bp_active_components', $bp->active_components );
         }
@@ -112 +134 @@
         $bp->required_components[] = 'core';
 
+        /**
+         * Fires after the loading of individual components.
+         *
+         * @since BuddyPress (2.0.0)
+         */
         do_action( 'bp_core_components_included' );
     }
@@ -180 +207 @@
         // Fetches the default Gravatar image to use if the user/group/blog has no avatar or gravatar
         $bp->grav_default        = new stdClass;
+
+        /**
+         * Filters the default user Gravatar.
+         *
+         * @since BuddyPress (1.1.0)
+         *
+         * @param string $value Default user Gravatar.
+         */
         $bp->grav_default->user  = apply_filters( 'bp_user_gravatar_default',  $bp->site_options['avatar_default'] );
+
+        /**
+         * Filters the default group Gravatar.
+         *
+         * @since BuddyPress (1.1.0)
+         *
+         * @param string $value Default group Gravatar.
+         */
         $bp->grav_default->group = apply_filters( 'bp_group_gravatar_default', $bp->grav_default->user );
+
+        /**
+         * Filters the default blog Gravatar.
+         *
+         * @since BuddyPress (1.1.0)
+         *
+         * @param string $value Default blog Gravatar.
+         */
         $bp->grav_default->blog  = apply_filters( 'bp_blog_gravatar_default',  $bp->grav_default->user );
 
@@ -201 +252 @@
         bp_update_is_item_mod( false,                  'core' );
 
+        /**
+         * Fires at the end of the setup of bp-core globals setting.
+         *
+         * @since BuddyPress (1.1.0)
+         */
         do_action( 'bp_core_setup_globals' );
     }