Changeset 9215 for trunk/src/bp-settings/bp-settings-template.php

Timestamp:

12/06/2014 09:19:03 PM (12 years ago)

Author:

tw2113

Message:

Add hook documentation for the Settings component.

Fixes #5947

File:

• trunk/src/bp-settings/bp-settings-template.php (modified) (4 diffs)

trunk/src/bp-settings/bp-settings-template.php

@@ -16 +16 @@
  * @package BuddyPress
  * @subpackage SettingsTemplate
- * @since BuddyPress (1.5)
+ * @since BuddyPress (1.5.0)
  *
  * @uses bp_get_settings_slug()
@@ -28 +28 @@
          * @package BuddyPress
          * @subpackage SettingsTemplate
-         * @since BuddyPress (1.5)
+         * @since BuddyPress (1.5.0)
          */
         function bp_get_settings_slug() {
+
+                /**
+                 * Filters the Settings component slug.
+                 *
+                 * @since BuddyPress (1.5.0)
+                 *
+                 * @param string $slug Settings component slug.
+                 */
                 return apply_filters( 'bp_get_settings_slug', buddypress()->settings->slug );
         }
@@ -39 +47 @@
  * @package BuddyPress
  * @subpackage SettingsTemplate
- * @since BuddyPress (1.5)
+ * @since BuddyPress (1.5.0)
  *
  * @uses bp_get_settings_root_slug()
@@ -51 +59 @@
          * @package BuddyPress
          * @subpackage SettingsTemplate
-         * @since BuddyPress (1.5)
+         * @since BuddyPress (1.5.0)
          */
         function bp_get_settings_root_slug() {
+
+                /**
+                 * Filters the Settings component root slug.
+                 *
+                 * @since BuddyPress (1.5.0)
+                 *
+                 * @param string $root_slug Settings component root slug.
+                 */
                 return apply_filters( 'bp_get_settings_root_slug', buddypress()->settings->root_slug );
         }