Changeset 12008 for trunk/src/bp-templates/bp-nouveau/includes/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/includes/functions.php (modified) (4 diffs)

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

@@ -363 +363 @@
  */
 function bp_nouveau_current_user_can( $capability = '' ) {
+        /**
+         * Filters whether or not the current user can perform an action for BuddyPress Nouveau.
+         *
+         * @since 3.0.0
+         *
+         * @param bool   $value      Whether or not the user is logged in.
+         * @param string $capability Current capability being checked.
+         * @param int    $value      Current logged in user ID.
+         */
         return apply_filters( 'bp_nouveau_current_user_can', is_user_logged_in(), $capability, bp_loggedin_user_id() );
 }
@@ -386 +395 @@
         // Get the hook output.
         ob_start();
+
+        /**
+         * Fires at the start of the output for `bp_nouveau_parse_hooked_dir_nav()`.
+         *
+         * This hook is variable and depends on the hook parameter passed in.
+         *
+         * @since 3.0.0
+         */
         do_action( $hook );
         $output = ob_get_clean();
@@ -452 +469 @@
 
         ob_start();
+
+        /**
+         * Fires at the start of the output for `bp_nouveau_parse_hooked_options()`.
+         *
+         * This hook is variable and depends on the hook parameter passed in.
+         *
+         * @since 3.0.0
+         */
         do_action( $hook );
 
@@ -881 +906 @@
 function bp_nouveau_get_user_feedback( $feedback_id = '' ) {
         /**
-         * Filter to add your custom feedback messages
+         * Filters the BuddyPress Nouveau feedback messages.
+         *
+         * Use this filter to add your custom feedback messages.
+         *
+         * @since 3.0.0
          *
          * @param array $value The list of feedback messages.