Changeset 12008 for trunk/src/bp-templates/bp-nouveau/buddypress-functions.php

Timestamp:

04/28/2018 01:32:52 AM (8 years ago)

Author:

tw2113

Message:

add/touchup documentation to a lot of Nouveau actions and filters

File:

• trunk/src/bp-templates/bp-nouveau/buddypress-functions.php (modified) (8 diffs)

trunk/src/bp-templates/bp-nouveau/buddypress-functions.php

@@ -117 +117 @@
         }
 
+        /**
+         * Fires after all of the BuddyPress Nouveau includes have been loaded. Passed by reference.
+         *
+         * @since 3.0.0
+         *
+         * @param BP_Nouveau $value Current BP_Nouveau instance.
+         */
         do_action_ref_array( 'bp_nouveau_includes', array( &$this ) );
     }
@@ -128 +135 @@
         $width         = 1300;
         $top_offset    = 150;
+
+        /** This filter is documented in bp-core/bp-core-avatars.php. */
         $avatar_height = apply_filters( 'bp_core_avatar_full_height', $top_offset );
 
@@ -215 +224 @@
         }
 
+        /**
+         * Filters the BuddyPress Nouveau CSS dependencies.
+         *
+         * @since 3.0.0
+         *
+         * @param array $value Array of style dependencies. Default Dashicons.
+         */
         $css_dependencies = apply_filters( 'bp_nouveau_css_dependencies', array( 'dashicons' ) );
 
+        /**
+         * Filters the styles to enqueue for BuddyPress Nouveau.
+         *
+         * This filter provides a multidimensional array that will map to arguments used for wp_enqueue_style().
+         * The primary index should have the stylesheet handle to use, and be assigned an array that has indexes for
+         * file location, dependencies, and version.
+         *
+         * @since 3.0.0
+         *
+         * @param array $value Array of styles to enqueue.
+         */
         $styles = apply_filters( 'bp_nouveau_enqueue_styles', array(
             'bp-nouveau' => array(
@@ -270 +297 @@
         unset( $dependencies[ $bp_confirm ] );
 
+        /**
+         * Filters the scripts to enqueue for BuddyPress Nouveau.
+         *
+         * This filter provides a multidimensional array that will map to arguments used for wp_register_script().
+         * The primary index should have the script handle to use, and be assigned an array that has indexes for
+         * file location, dependencies, version and if it should load in the footer or not.
+         *
+         * @since 3.0.0
+         *
+         * @param array $value Array of scripts to register.
+         */
         $scripts = apply_filters( 'bp_nouveau_register_scripts', array(
             'bp-nouveau' => array(
@@ -337 +375 @@
         }
 
+        /**
+         * Fires after all of the BuddyPress Nouveau scripts have been enqueued.
+         *
+         * @since 3.0.0
+         */
         do_action( 'bp_nouveau_enqueue_scripts' );
     }
@@ -390 +433 @@
         }
 
-        // Set the supported components
+        /**
+         * Filters the supported BuddyPress Nouveau components.
+         *
+         * @since 3.0.0
+         *
+         * @param array $value Array of supported components.
+         */
         $supported_objects = (array) apply_filters( 'bp_nouveau_supported_components', bp_core_get_packaged_component_ids() );
         $object_nonces     = array();
@@ -421 +470 @@
          * @since 3.0.0
          *
-         * @param array $value Array of key/value pairs for AJAX usage.
+         * @param array $params Array of key/value pairs for AJAX usage.
          */
         wp_localize_script( 'bp-nouveau', 'BP_Nouveau', apply_filters( 'bp_core_get_js_strings', $params ) );
@@ -442 +491 @@
          * Filters whether or not we are looking at a directory to determine if to return early.
          *
-         * @since 2.2.0
+         * @since 3.0.0
          *
          * @param bool $value Whether or not we are viewing a directory.