Changeset 9725

Timestamp:

04/09/2015 07:15:42 PM (11 years ago)

Author:

johnjamesjacoby

Message:

Members: Improvements to BP_Core_Whos_Online_Widget

• Escape gettext output
• Add missing semicolons after PHP execution
• Introduce parse_settings() method for setting smart default values
• Remove extract() usages
• Code formatting improvements

Fixes #6362.

File:

• trunk/src/bp-members/bp-members-widgets.php (modified) (7 diffs)

trunk/src/bp-members/bp-members-widgets.php

@@ -63 +63 @@
                 // Get widget settings
                 $settings = $this->parse_settings( $instance );
-
-                // Output any content before the widget
-                echo $args['before_widget'];
 
                 /**
@@ -80 +77 @@
                 $title = $settings['link_title'] ? '<a href="' . bp_get_members_directory_permalink() . '">' . $title . '</a>' : $title;
 
-                // Output title (and maybe content before & after it)
-                echo $args['before_title']
+                // Output before widget HTMl, title (and maybe content before & after it)
+                echo $args['before_widget']
+                   . $args['before_title']
                    . $title
                    . $args['after_title'];
@@ -246 +244 @@
          * Constructor method.
          */
-        function __construct() {
-                $widget_ops = array(
-                        'description' => __( 'Profile photos of online users', 'buddypress' ),
+        public function __construct() {
+                $name        = _x( "(BuddyPress) Who's Online", 'widget name', 'buddypress' );
+                $description = __( 'Profile photos of online users', 'buddypress' );
+                parent::__construct( false, $name, array(
+                        'description' => $description,
                         'classname' => 'widget_bp_core_whos_online_widget buddypress widget',
-                );
-                parent::__construct( false, $name = _x( "(BuddyPress) Who's Online", 'widget name', 'buddypress' ), $widget_ops );
+                ) );
         }
 
@@ -262 +261 @@
          * @param array $instance Widget settings, as saved by the user.
          */
-        function widget($args, $instance) {
-
-                extract( $args );
+        public function widget( $args, $instance ) {
+
+                // Get widget settings
+                $settings = $this->parse_settings( $instance );
 
                 /**
@@ -273 +273 @@
                  *
                  * @param string $title    The widget title.
-                 * @param array  $instance The settings for the particular instance of the widget.
+                 * @param array  $settings The settings for the particular instance of the widget.
                  * @param string $id_base  Root ID for all widgets of this type.
                  */
-                $title = apply_filters( 'widget_title', $instance['title'], $instance, $this->id_base );
-
-                echo $before_widget;
-                echo $before_title
+                $title = apply_filters( 'widget_title', $settings['title'], $settings, $this->id_base );
+
+                echo $args['before_widget']
+                   . $args['before_title']
                    . $title
-                   . $after_title;
-
+                   . $args['after_title'];
+
+                // Setup args for querying members
                 $members_args = array(
                         'user_id'         => 0,
                         'type'            => 'online',
-                        'per_page'        => $instance['max_members'],
-                        'max'             => $instance['max_members'],
+                        'per_page'        => $settings['max_members'],
+                        'max'             => $settings['max_members'],
                         'populate_extras' => true,
                         'search_terms'    => false,
-                );
-
-                ?>
+                ); ?>
 
                 <?php if ( bp_has_members( $members_args ) ) : ?>
+
                         <div class="avatar-block">
+
                                 <?php while ( bp_members() ) : bp_the_member(); ?>
+
                                         <div class="item-avatar">
-                                                <a href="<?php bp_member_permalink() ?>" title="<?php bp_member_name() ?>"><?php bp_member_avatar() ?></a>
+                                                <a href="<?php bp_member_permalink(); ?>" title="<?php bp_member_name(); ?>"><?php bp_member_avatar(); ?></a>
                                         </div>
+
                                 <?php endwhile; ?>
+
                         </div>
+
                 <?php else: ?>
 
                         <div class="widget-error">
-                                <?php _e( 'There are no users currently online', 'buddypress' ) ?>
+                                <?php esc_html_e( 'There are no users currently online', 'buddypress' ); ?>
                         </div>
 
                 <?php endif; ?>
 
-                <?php echo $after_widget; ?>
-        <?php
+                <?php echo $args['after_widget'];
         }
 
@@ -321 +325 @@
          * @return array $instance The parsed options to be saved.
          */
-        function update( $new_instance, $old_instance ) {
-                $instance = $old_instance;
-                $instance['title'] = strip_tags( $new_instance['title'] );
+        public function update( $new_instance, $old_instance ) {
+                $instance                = $old_instance;
+                $instance['title']       = strip_tags( $new_instance['title'] );
                 $instance['max_members'] = strip_tags( $new_instance['max_members'] );
 
@@ -334 +338 @@
          * @param $instance Settings for this widget.
          */
-        function form( $instance ) {
-                $defaults = array(
-                        'title' => __( "Who's Online", 'buddypress' ),
-                        'max_members' => 15
-                );
-                $instance = wp_parse_args( (array) $instance, $defaults );
-
-                $title = strip_tags( $instance['title'] );
-                $max_members = strip_tags( $instance['max_members'] );
-                ?>
-
-                <p><label for="bp-core-widget-title"><?php _e('Title:', 'buddypress'); ?> <input class="widefat" id="<?php echo $this->get_field_id( 'title' ); ?>" name="<?php echo $this->get_field_name( 'title' ); ?>" type="text" value="<?php echo esc_attr( $title ); ?>" style="width: 100%" /></label></p>
-
-                <p><label for="bp-core-widget-members-max"><?php _e('Max Members to show:', 'buddypress'); ?> <input class="widefat" id="<?php echo $this->get_field_id( 'max_members' ); ?>" name="<?php echo $this->get_field_name( 'max_members' ); ?>" type="text" value="<?php echo esc_attr( $max_members ); ?>" style="width: 30%" /></label></p>
+        public function form( $instance ) {
+
+                // Get widget settings
+                $settings    = $this->parse_settings( $instance );
+                $title       = strip_tags( $settings['title'] );
+                $max_members = strip_tags( $settings['max_members'] ); ?>
+
+                <p>
+                        <label for="bp-core-widget-title">
+                                <?php esc_html_e( 'Title:', 'buddypress' ); ?>
+                                <input class="widefat" id="<?php echo $this->get_field_id( 'title' ); ?>" name="<?php echo $this->get_field_name( 'title' ); ?>" type="text" value="<?php echo esc_attr( $title ); ?>" style="width: 100%" />
+                        </label>
+                </p>
+
+                <p>
+                        <label for="bp-core-widget-members-max">
+                                <?php esc_html_e( 'Max Members to show:', 'buddypress' ); ?>
+                                <input class="widefat" id="<?php echo $this->get_field_id( 'max_members' ); ?>" name="<?php echo $this->get_field_name( 'max_members' ); ?>" type="text" value="<?php echo esc_attr( $max_members ); ?>" style="width: 30%" />
+                        </label>
+                </p>
+
         <?php
+        }
+
+        /**
+         * Merge the widget settings into defaults array.
+         *
+         * @since BuddyPress (2.3.0)
+         *
+         * @param $instance Instance
+         * @uses bp_parse_args() To merge widget settings into defaults
+         */
+        public function parse_settings( $instance = array() ) {
+                return bp_parse_args( $instance, array(
+                        'title'              => __( "Who's Online", 'buddypress' ),
+                        'max_members'    => 15,
+                ), 'members_widget_settings' );
         }
 }