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

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

@@ -224 +224 @@
         }
 
+        /**
+         * Filters the nav widget args for the BP_Nouveau_Object_Nav_Widget widget.
+         *
+         * @since 3.0.0
+         *
+         * @param array $value Array of arguments {
+         *     @param bool $bp_nouveau_widget_title Whether or not to assign a title for the widget.
+         * }
+         */
         $item_nav_args = wp_parse_args( $instance, apply_filters( 'bp_nouveau_object_nav_widget_args', array(
             'bp_nouveau_widget_title' => true,
@@ -242 +251 @@
         }
 
+        /**
+         * Filters the BP_Nouveau_Object_Nav_Widget widget title.
+         *
+         * @since 3.0.0
+         *
+         * @param string $title    The widget title.
+         * @param array  $instance The settings for the particular instance of the widget.
+         * @param string $id_base  Root ID for all widgets of this type.
+         */
         $title = apply_filters( 'widget_title', $title, $instance, $this->id_base );