[Summary view] [Print] [Text view]

   1  <?php
   2  /**
   3   * BuddyPress Friends Widget.
   4   *
   5   * @package BuddyPress
   6   * @subpackage Friends
   7   * @since 1.9.0
   8   */
   9  
  10  // Exit if accessed directly.
  11  defined( 'ABSPATH' ) || exit;
  12  
  13  /**
  14   * The User Friends widget class.
  15   *
  16   * @since 1.9.0
  17   */
  18  class BP_Core_Friends_Widget extends WP_Widget {
  19  
  20      /**
  21       * Class constructor.
  22       *
  23       * @since 1.9.0
  24       * @since 9.0.0 Adds the `show_instance_in_rest` property to Widget options.
  25       */
  26  	function __construct() {
  27          $widget_ops = array(
  28              'description'                 => __( 'A dynamic list of recently active, popular, and newest Friends of the displayed member. Widget is only shown when viewing a member profile.', 'buddypress' ),
  29              'classname'                   => 'widget_bp_core_friends_widget buddypress widget',
  30              'customize_selective_refresh' => true,
  31              'show_instance_in_rest'       => true,
  32          );
  33          parent::__construct( false, $name = _x( '(BuddyPress) Friends', 'widget name', 'buddypress' ), $widget_ops );
  34  
  35          if ( is_customize_preview() || bp_is_widget_block_active( '', $this->id_base ) ) {
  36              add_action( 'bp_enqueue_scripts', array( $this, 'enqueue_scripts' ) );
  37          }
  38      }
  39  
  40      /**
  41       * Enqueue scripts.
  42       *
  43       * @since 2.6.0
  44       */
  45  	public function enqueue_scripts() {
  46          $min = bp_core_get_minified_asset_suffix();
  47          wp_enqueue_script( 'bp_core_widget_friends-js', buddypress()->plugin_url . "bp-friends/js/widget-friends{$min}.js", array( 'jquery' ), bp_get_version() );
  48      }
  49  
  50      /**
  51       * Display the widget.
  52       *
  53       * @since 1.9.0
  54       *
  55       * @param array $args Widget arguments.
  56       * @param array $instance The widget settings, as saved by the user.
  57       */
  58  	function widget( $args, $instance ) {
  59          global $members_template;
  60  
  61          extract( $args );
  62  
  63          if ( ! bp_displayed_user_id() ) {
  64              return;
  65          }
  66  
  67          $user_id = bp_displayed_user_id();
  68          $link = trailingslashit( bp_displayed_user_domain() . bp_get_friends_slug() );
  69          $instance['title'] = sprintf( __( "%s's Friends", 'buddypress' ), bp_get_displayed_user_fullname() );
  70  
  71          if ( empty( $instance['friend_default'] ) ) {
  72              $instance['friend_default'] = 'active';
  73          }
  74  
  75          /**
  76           * Filters the Friends widget title.
  77           *
  78           * @since 1.8.0
  79           * @since 2.3.0 Added 'instance' and 'id_base' to arguments passed to filter.
  80           *
  81           * @param string $title    The widget title.
  82           * @param array  $instance The settings for the particular instance of the widget.
  83           * @param string $id_base  Root ID for all widgets of this type.
  84           */
  85          $title = apply_filters( 'widget_title', $instance['title'], $instance, $this->id_base );
  86  
  87          echo $before_widget;
  88  
  89          $title = $instance['link_title'] ? '<a href="' . esc_url( $link ) . '">' . esc_html( $title ) . '</a>' : esc_html( $title );
  90  
  91          echo $before_title . $title . $after_title;
  92  
  93          $members_args = array(
  94              'user_id'         => absint( $user_id ),
  95              'type'            => sanitize_text_field( $instance['friend_default'] ),
  96              'max'             => absint( $instance['max_friends'] ),
  97              'populate_extras' => 1,
  98          );
  99  
 100          // Back up the global.
 101          $old_members_template = $members_template;
 102  
 103          ?>
 104  
 105          <?php if ( bp_has_members( $members_args ) ) : ?>
 106              <div class="item-options" id="friends-list-options">
 107                  <a href="<?php bp_members_directory_permalink(); ?>" id="newest-friends" <?php if ( $instance['friend_default'] == 'newest' ) : ?>class="selected"<?php endif; ?>><?php _e( 'Newest', 'buddypress' ); ?></a>
 108                  | <a href="<?php bp_members_directory_permalink(); ?>" id="recently-active-friends" <?php if ( $instance['friend_default'] == 'active' ) : ?>class="selected"<?php endif; ?>><?php _e( 'Active', 'buddypress' ); ?></a>
 109                  | <a href="<?php bp_members_directory_permalink(); ?>" id="popular-friends" <?php if ( $instance['friend_default'] == 'popular' ) : ?>class="selected"<?php endif; ?>><?php _e( 'Popular', 'buddypress' ); ?></a>
 110              </div>
 111  
 112              <ul id="friends-list" class="item-list">
 113                  <?php while ( bp_members() ) : bp_the_member(); ?>
 114                      <li class="vcard">
 115                          <div class="item-avatar">
 116                              <a href="<?php bp_member_permalink(); ?>" class="bp-tooltip" data-bp-tooltip="<?php bp_member_name(); ?>"><?php bp_member_avatar(); ?></a>
 117                          </div>
 118  
 119                          <div class="item">
 120                              <div class="item-title fn"><a href="<?php bp_member_permalink(); ?>"><?php bp_member_name(); ?></a></div>
 121                              <div class="item-meta">
 122                                  <?php if ( 'newest' == $instance['friend_default'] ) : ?>
 123                                      <span class="activity" data-livestamp="<?php bp_core_iso8601_date( bp_get_member_registered( array( 'relative' => false ) ) ); ?>"><?php bp_member_registered(); ?></span>
 124                                  <?php elseif ( 'active' == $instance['friend_default'] ) : ?>
 125                                      <span class="activity" data-livestamp="<?php bp_core_iso8601_date( bp_get_member_last_active( array( 'relative' => false ) ) ); ?>"><?php bp_member_last_active(); ?></span>
 126                                  <?php else : ?>
 127                                      <span class="activity"><?php bp_member_total_friend_count(); ?></span>
 128                                  <?php endif; ?>
 129                              </div>
 130                          </div>
 131                      </li>
 132  
 133                  <?php endwhile; ?>
 134              </ul>
 135              <?php wp_nonce_field( 'bp_core_widget_friends', '_wpnonce-friends' ); ?>
 136              <input type="hidden" name="friends_widget_max" id="friends_widget_max" value="<?php echo absint( $instance['max_friends'] ); ?>" />
 137  
 138          <?php else: ?>
 139  
 140              <div class="widget-error">
 141                  <?php _e( 'Sorry, no members were found.', 'buddypress' ); ?>
 142              </div>
 143  
 144          <?php endif; ?>
 145  
 146          <?php echo $after_widget;
 147  
 148          // Restore the global.
 149          $members_template = $old_members_template;
 150      }
 151  
 152      /**
 153       * Process a widget save.
 154       *
 155       * @since 1.9.0
 156       *
 157       * @param array $new_instance The parameters saved by the user.
 158       * @param array $old_instance The parameters as previously saved to the database.
 159       * @return array $instance The processed settings to save.
 160       */
 161  	function update( $new_instance, $old_instance ) {
 162          $instance = $old_instance;
 163  
 164          $instance['max_friends']    = absint( $new_instance['max_friends'] );
 165          $instance['friend_default'] = sanitize_text_field( $new_instance['friend_default'] );
 166          $instance['link_title']        = ! empty( $new_instance['link_title'] );
 167  
 168          return $instance;
 169      }
 170  
 171      /**
 172       * Render the widget edit form.
 173       *
 174       * @since 1.9.0
 175       *
 176       * @param array $instance The saved widget settings.
 177       * @return void
 178       */
 179  	function form( $instance ) {
 180          $defaults = array(
 181              'max_friends'      => 5,
 182              'friend_default' => 'active',
 183              'link_title'      => false
 184          );
 185          $instance = wp_parse_args( (array) $instance, $defaults );
 186  
 187          $max_friends     = $instance['max_friends'];
 188          $friend_default = $instance['friend_default'];
 189          $link_title    = (bool) $instance['link_title'];
 190          ?>
 191  
 192          <p><label for="<?php echo $this->get_field_id( 'link_title' ); ?>"><input type="checkbox" name="<?php echo $this->get_field_name('link_title'); ?>" id="<?php echo $this->get_field_id( 'link_title' ); ?>" value="1" <?php checked( $link_title ); ?> /> <?php _e( 'Link widget title to Members directory', 'buddypress' ); ?></label></p>
 193  
 194          <p><label for="<?php echo $this->get_field_id( 'max_friends' ); ?>"><?php _e( 'Max friends to show:', 'buddypress' ); ?> <input class="widefat" id="<?php echo $this->get_field_id( 'max_friends' ); ?>" name="<?php echo $this->get_field_name( 'max_friends' ); ?>" type="text" value="<?php echo absint( $max_friends ); ?>" style="width: 30%" /></label></p>
 195  
 196          <p>
 197              <label for="<?php echo $this->get_field_id( 'friend_default' ) ?>"><?php _e( 'Default friends to show:', 'buddypress' ); ?></label>
 198              <select name="<?php echo $this->get_field_name( 'friend_default' ); ?>" id="<?php echo $this->get_field_id( 'friend_default' ); ?>">
 199                  <option value="newest" <?php selected( $friend_default, 'newest' ); ?>><?php _e( 'Newest', 'buddypress' ); ?></option>
 200                  <option value="active" <?php selected( $friend_default, 'active' );?>><?php _e( 'Active', 'buddypress' ); ?></option>
 201                  <option value="popular"  <?php selected( $friend_default, 'popular' ); ?>><?php _e( 'Popular', 'buddypress' ); ?></option>
 202              </select>
 203          </p>
 204  
 205      <?php
 206      }
 207  }