Changeset 11145

Timestamp:

09/21/2016 10:53:11 PM (8 years ago)

Author:

r-a-y

Message:

Groups: Introduce group type functionality on the Groups Directory page.

If a group type of foo is registered with the has_directory parameter,
you can view a group directory for foo at:
example.com/groups/type/foo/

See #7210.

Location:

trunk/src

Files:

• bp-core/bp-core-template.php (modified) (1 diff)
• bp-groups/bp-groups-functions.php (modified) (1 diff)
• bp-groups/bp-groups-screens.php (modified) (1 diff)
• bp-groups/bp-groups-template.php (modified) (4 diffs)
• bp-groups/classes/class-bp-groups-component.php (modified) (1 diff)
• bp-groups/classes/class-bp-groups-theme-compat.php (modified) (1 diff)
• bp-templates/bp-legacy/buddypress/groups/groups-loop.php (modified) (1 diff)

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

@@ -2687 +2687 @@
  */
 function bp_is_groups_directory() {
-    if ( bp_is_groups_component() && ! bp_current_action() && ! bp_current_item() ) {
+    if ( bp_is_groups_component() && ! bp_is_group() && ( ! bp_current_action() || ( bp_action_variable() && bp_is_current_action( bp_get_groups_group_type_base() ) ) ) ) {
         return true;
     }

trunk/src/bp-groups/bp-groups-functions.php

@@ -2446 +2446 @@
 
 /**
+ * Get the "current" group type, if one is provided, in group directories.
+ *
+ * @since 2.7.0
+ *
+ * @return string
+ */
+function bp_get_current_group_directory_type() {
+
+    /**
+     * Filters the "current" group type, if one is provided, in group directories.
+     *
+     * @since 2.7.0
+     *
+     * @param string $value "Current" group type.
+     */
+    return apply_filters( 'bp_get_current_group_directory_type', buddypress()->groups->current_directory_type );
+}
+
+/**
  * Delete a group's type when the group is deleted.
  *

trunk/src/bp-groups/bp-groups-screens.php

@@ -26 +26 @@
 function groups_directory_groups_setup() {
     if ( bp_is_groups_directory() ) {
+        // Set group type if available.
+        if ( bp_is_current_action( bp_get_groups_group_type_base() ) && bp_action_variable() ) {
+            $matched_types = bp_groups_get_group_types( array(
+                'has_directory'  => true,
+                'directory_slug' => bp_action_variable(),
+            ) );
+
+            // Redirect back to group directory if no match.
+            if ( empty( $matched_types ) ) {
+                bp_core_redirect( bp_get_groups_directory_permalink() );
+            }
+
+            // Set our global variable.
+            buddypress()->groups->current_directory_type = reset( $matched_types );
+        }
+
         bp_update_is_directory( true, 'groups' );
 

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

@@ -70 +70 @@
          */
         return apply_filters( 'bp_get_groups_root_slug', buddypress()->groups->root_slug );
+    }
+
+/**
+ * Output the group type base slug.
+ *
+ * @since 2.7.0
+ */
+function bp_groups_group_type_base() {
+    echo esc_url( bp_get_groups_group_type_base() );
+}
+    /**
+     * Get the group type base slug.
+     *
+     * The base slug is the string used as the base prefix when generating group
+     * type directory URLs. For example, in example.com/groups/type/foo/, 'foo' is
+     * the group type and 'type' is the base slug.
+     *
+     * @since 2.7.0
+     *
+     * @return string
+     */
+    function bp_get_groups_group_type_base() {
+        /**
+         * Filters the group type URL base.
+         *
+         * @since 2.7.0
+         *
+         * @param string $base
+         */
+        return apply_filters( 'bp_groups_group_type_base', _x( 'type', 'group type URL base', 'buddypress' ) );
     }
 
@@ -174 +204 @@
     }
 
+    $group_type = bp_get_current_group_directory_type();
+    if ( ! $group_type && ! empty( $_GET['group_type'] ) ) {
+        if ( is_array( $_GET['group_type'] ) ) {
+            $group_type = $_GET['group_type'];
+        } else {
+            // Can be a comma-separated list.
+            $group_type = explode( ',', $_GET['group_type'] );
+        }
+    }
+
     // Default search string (too soon to escape here).
     $search_query_arg = bp_core_get_component_search_query_arg( 'groups' );
@@ -197 +237 @@
         'slug'               => $slug,
         'search_terms'       => $search_terms,
-        'group_type'         => '',
+        'group_type'         => $group_type,
         'group_type__in'     => '',
         'group_type__not_in' => '',
@@ -5080 +5120 @@
 
 /**
+ * Echo the current group type message.
+ *
+ * @since 2.7.0
+ */
+function bp_current_group_directory_type_message() {
+    echo bp_get_current_group_directory_type_message();
+}
+    /**
+     * Generate the current group type message.
+     *
+     * @since 2.7.0
+     *
+     * @return string
+     */
+    function bp_get_current_group_directory_type_message() {
+        $type_object = bp_groups_get_group_type_object( bp_get_current_group_directory_type() );
+
+        $message = sprintf( __( 'Viewing groups of the type: %s', 'buddypress' ), '<strong>' . $type_object->labels['singular_name'] . '</strong>' );
+
+        /**
+         * Filters the current group type message.
+         *
+         * @since 2.7.0
+         *
+         * @param string $message Message to filter.
+         */
+        return apply_filters( 'bp_get_current_group_type_message', $message );
+    }
+
+/**
  * Is the current page a specific group admin screen?
  *

trunk/src/bp-groups/classes/class-bp-groups-component.php

@@ -84 +84 @@
      */
     public $types = array();
+
+    /**
+     * Current directory group type.
+     *
+     * @see groups_directory_groups_setup()
+     *
+     * @since 2.7.0
+     * @var string
+     */
+    public $current_directory_type = '';
 
     /**

trunk/src/bp-groups/classes/class-bp-groups-theme-compat.php

@@ -41 +41 @@
 
         // Group Directory.
-        if ( ! bp_current_action() && ! bp_current_item() ) {
+        if ( bp_is_groups_directory() ) {
             bp_update_is_directory( true, 'groups' );
 

trunk/src/bp-templates/bp-legacy/buddypress/groups/groups-loop.php

@@ -19 +19 @@
  */
 do_action( 'bp_before_groups_loop' ); ?>
+
+<?php if ( bp_get_current_group_directory_type() ) : ?>
+    <p class="current-group-type"><?php bp_current_group_directory_type_message() ?></p>
+<?php endif; ?>
 
 <?php if ( bp_has_groups( bp_ajax_querystring( 'groups' ) ) ) : ?>