Changeset 9549

Timestamp:

02/24/2015 03:26:17 AM (10 years ago)

Author:

tw2113

Message:

Adds hooks documentation for bp-core-admin-slugs.php.

See #5940.

File:

• trunk/src/bp-core/admin/bp-core-admin-slugs.php (modified) (7 diffs)

trunk/src/bp-core/admin/bp-core-admin-slugs.php

@@ -14 +14 @@
  * Renders the page mapping admin panel.
  *
- * @since BuddyPress (1.6)
+ * @since BuddyPress (1.6.0)
  * @todo Use settings API
  * @uses bp_core_admin_component_options()
@@ -45 +45 @@
  *
  * @package BuddyPress
- * @since BuddyPress (1.6)
+ * @since BuddyPress (1.6.0)
  * @todo Use settings API
  */
@@ -73 +73 @@
     /** Directory Display *****************************************************/
 
+    /**
+     * Filters the loaded components needing directory page association to a WordPress page.
+     *
+     * @since BuddyPress (1.5.0)
+     *
+     * @param array $directory_pages Array of available components to set associations for.
+     */
     $directory_pages = apply_filters( 'bp_directory_pages', $directory_pages );
 
@@ -116 +123 @@
                 <?php endforeach ?>
 
-                <?php do_action( 'bp_active_external_directories' ); ?>
+                <?php
+
+                /**
+                 * Fires after the display of default directories.
+                 *
+                 * Allows plugins to add their own directory associations.
+                 *
+                 * @since BuddyPress (1.5.0)
+                 */
+                do_action( 'bp_active_external_directories' ); ?>
 
             </tbody>
@@ -133 +149 @@
     );
 
+    /**
+     * Filters the default static pages for BuddyPress setup.
+     *
+     * @since BuddyPress (1.6.0)
+     *
+     * @param array $static_pages Array of static default static pages.
+     */
     $static_pages = apply_filters( 'bp_static_pages', $static_pages );
 
@@ -175 +198 @@
                 <?php endforeach ?>
 
-                <?php do_action( 'bp_active_external_pages' ); ?>
+                <?php
+
+                /**
+                 * Fires after the display of default static pages for BuddyPress setup.
+                 *
+                 * @since BuddyPress (1.5.0)
+                 */
+                do_action( 'bp_active_external_pages' ); ?>
 
             </tbody>
@@ -187 +217 @@
  * Handle saving of the BuddyPress slugs
  *
- * @since BuddyPress (1.6)
+ * @since BuddyPress (1.6.0)
  * @todo Use settings API
  */