Changeset 6334

Timestamp:

03/01/2017 02:17:21 AM (8 years ago)

Author:

johnjamesjacoby

Message:

Engagements: Integrate the user_query into favorites, subscriptions, and engagements.

• Add to admin metabox avatar loops
• Fix a few bugs in BBP_User_Query, and include a custom constructor to set the loop counter

See #3068.

Location:

trunk/src/includes

Files:

• admin/metaboxes.php (modified) (6 diffs)
• admin/topics.php (modified) (2 diffs)
• users/template.php (modified) (7 diffs)

trunk/src/includes/admin/metaboxes.php

@@ -669 +669 @@
 
 /**
+ * See who engaged with a topic
+ *
+ * @since 2.6.0 bbPress (r6333)
+ */
+function bbp_topic_engagements_metabox( $post ) {
+
+    // Get user IDs
+    $user_ids = bbp_get_topic_engagements( $post->ID );
+
+    // Output
+    ?><p><?php
+
+        // Relationships
+        $args = array(
+            'include' => $user_ids
+        );
+
+        // Users were found
+        if ( ! empty( $user_ids ) && bbp_has_users( $args ) ) :
+
+            while ( bbp_users() ) : bbp_the_user();
+                echo get_avatar( bbp_get_user_id(), 32 );
+            endwhile;
+
+        // No users
+        else :
+            esc_html_e( 'No users have engaged to this topic.', 'bbpress' );
+        endif;
+
+    ?></p><?php
+
+    do_action( 'bbp_topic_engagements_metabox', $post );
+}
+
+/**
  * See who marked a topic as a favorite
  *
  * @since 2.6.0 bbPress (r6197)
+ * @since 2.6.0 bbPress (r6333) Updated to use BBP_User_Query
  */
 function bbp_topic_favorites_metabox( $post ) {
@@ -681 +717 @@
     ?><p><?php
 
+        // Relationships
+        $args = array(
+            'include' => $user_ids
+        );
+
         // Users were found
-        if ( ! empty( $user_ids ) ) :
-
-            foreach ( $user_ids as $user_id ) :
-                echo get_avatar( $user_id, 32 );
-            endforeach;
+        if ( ! empty( $user_ids ) && bbp_has_users( $args ) ) :
+
+            while ( bbp_users() ) : bbp_the_user();
+                echo get_avatar( bbp_get_user_id(), 32 );
+            endwhile;
 
         // No users
@@ -702 +743 @@
  *
  * @since 2.6.0 bbPress (r6197)
+ * @since 2.6.0 bbPress (r6333) Updated to use BBP_User_Query
  */
 function bbp_topic_subscriptions_metabox( $post ) {
@@ -711 +753 @@
     ?><p><?php
 
+        // Relationships
+        $args = array(
+            'include' => $user_ids
+        );
+
         // Users were found
-        if ( ! empty( $user_ids ) ) :
-
-            foreach ( $user_ids as $user_id ) :
-                echo get_avatar( $user_id, 32 );
-            endforeach;
+        if ( ! empty( $user_ids ) && bbp_has_users( $args ) ) :
+
+            while ( bbp_users() ) : bbp_the_user();
+                echo get_avatar( bbp_get_user_id(), 32 );
+            endwhile;
 
         // No users
@@ -732 +779 @@
  *
  * @since 2.6.0 bbPress (r6197)
+ * @since 2.6.0 bbPress (r6333) Updated to use BBP_User_Query
  */
 function bbp_forum_subscriptions_metabox( $post ) {
@@ -741 +789 @@
     ?><p><?php
 
+        // Relationships
+        $args = array(
+            'include' => $user_ids
+        );
+
         // Users were found
-        if ( ! empty( $user_ids ) ) :
-
-            foreach ( $user_ids as $user_id ) :
-                echo get_avatar( $user_id, 32 );
-            endforeach;
+        if ( ! empty( $user_ids ) && bbp_has_users( $args ) ) :
+
+            while ( bbp_users() ) : bbp_the_user();
+                echo get_avatar( bbp_get_user_id(), 32 );
+            endwhile;
 
         // No users

trunk/src/includes/admin/topics.php

@@ -81 +81 @@
         add_action( 'add_meta_boxes', array( $this, 'author_metabox'        ) );
         add_action( 'add_meta_boxes', array( $this, 'replies_metabox'       ) );
+        add_action( 'add_meta_boxes', array( $this, 'engagements_metabox'   ) );
         add_action( 'add_meta_boxes', array( $this, 'favorites_metabox'     ) );
         add_action( 'add_meta_boxes', array( $this, 'subscriptions_metabox' ) );
@@ -408 +409 @@
             'normal',
             'high'
+        );
+    }
+
+    /**
+     * Add the engagements meta-box
+     *
+     * Allows viewing of users who have engaged in a topic.
+     *
+     * @since 2.6.0 bbPress (r6333)
+     *
+     * @uses add_meta_box() To add the meta-box
+     */
+    public function engagements_metabox() {
+
+        // Bail when creating a new topic
+        if ( empty( $_GET['action'] ) || ( 'edit' !== $_GET['action'] ) ) {
+            return;
+        }
+
+        // Bail if no engagements
+        if ( ! bbp_is_engagements_active() ) {
+            return;
+        }
+
+        // Add the meta-box
+        add_meta_box(
+            'bbp_topic_engagements_metabox',
+            __( 'Engagements', 'bbpress' ),
+            'bbp_topic_engagements_metabox',
+            $this->post_type,
+            'side',
+            'low'
         );
     }

trunk/src/includes/users/template.php

@@ -57 +57 @@
 
     /**
-     * Set up the next user and iterate current user index.
+     * PHP5 constructor.
      *
      * @since 2.6.0 bbPress (r6330)
      * @access public
      *
+     * @param null|string|array $query Optional. The query variables.
+     */
+    public function __construct( $query = null ) {
+        if ( ! empty( $query ) ) {
+            parent::__construct( $query );
+            $this->user_count = count( $this->results );
+        }
+    }
+
+    /**
+     * Set up the next user and iterate current user index.
+     *
+     * @since 2.6.0 bbPress (r6330)
+     * @access public
+     *
      * @return WP_User Next user.
      */
     public function next_user() {
-
         $this->current_user++;
-
-        $this->user = $this->users[ $this->current_user ];
+        $this->user = $this->results[ $this->current_user ];
 
         return $this->user;
@@ -89 +102 @@
         // loop has just started
         if ( $this->current_user === -1 ) {
+
             /**
              * Fires once the loop is started.
              *
-             * @since 2.6.0 bbPress
+             * @since 2.6.0 bbPress (r6330)
              *
              * @param WP_Query &$this The WP_Query instance (passed by reference).
@@ -99 +113 @@
         }
 
-        $this->user = $this->next_user();
+        $this->next_user();
     }
 
@@ -120 +134 @@
              * Fires once the loop has ended.
              *
-             * @since 2.0.0
+             * @since 2.6.0 bbPress (r6330)
              *
              * @param WP_Query &$this The WP_Query instance (passed by reference).
@@ -145 +159 @@
 
         if ( $this->user_count > 0 ) {
-            $this->user = $this->users[ 0 ];
+            $this->user = $this->results[ 0 ];
         }
     }
@@ -190 +204 @@
  */
 function bbp_users() {
-    return bbpress()->user_query->have_users();;
+    return bbpress()->user_query->have_users();
 }
 
@@ -238 +252 @@
         if ( ! empty( $user_id ) && is_numeric( $user_id ) ) {
             $bbp_user_id = $user_id;
+
+        // Currently inside a user loop
+        } elseif ( ! empty( $bbp->user_query->in_the_loop ) && isset( $bbp->user_query->user->ID ) ) {
+            $bbp_user_id = $bbp->user_query->user->ID;
 
         // Currently viewing or editing a user