'widget_bp_profile_completion_widget widget buddypress', 'description' => __( 'Show Logged in user Profile Completion Progress.', 'buddyx' ), ); /* Set up the widget. */ parent::__construct( false, __( '(BuddyPress) Profile Completion', 'buddyx' ), $widget_ops ); } /** * Displays the widget. */ function widget( $args, $instance ) { /* * do not do anything if user isn't logged in OR IF user is viewing other members profile. */ if ( ! is_user_logged_in() || ( bp_is_user() && ! bp_is_my_profile() ) ) { return; } $profile_groups_selected = isset( $instance['profile_groups_enabled'] ) ? $instance['profile_groups_enabled'] : array(); $profile_phototype_selected = ! empty( $instance['profile_photos_enabled'] ) ? $instance['profile_photos_enabled'] : array(); $profile_hide_widget_selected = ! empty( $instance['profile_hide_widget'] ) ? $instance['profile_hide_widget'] : array(); $user_progress = $this->get_user_profile_progress_data( $profile_groups_selected, $profile_phototype_selected ); // IF nothing selected then return and nothing to display. if ( empty( $profile_groups_selected ) && empty( $profile_phototype_selected ) ) { return; } // Hide the widget if "Hide widget once progress hits 100%" selected and progress is 100% if ( 100 === (int) $user_progress['completion_percentage'] && ! empty( $instance['profile_hide_widget'] ) ) { return; } /* Widget Template */ echo $args['before_widget']; // Widget Title echo $args['before_title'] . $instance['title'] . $args['after_title']; // Widget Content $progress_label = sprintf( __( '%s Complete', 'buddyx' ), $user_progress['completion_percentage'] . '%' ); ?>
'; ?> user_email, 200 ); echo ''; } ?>
get_user_profile_progress( $profile_groups, $profile_phototype ); $user_progress_formmatted = $this->get_user_profile_progress_formatted( $user_progress_arr ); return $user_progress_formmatted; } /** * Function returns logged in user progress based on options selected in the widget form. * * @param type $group_ids * @param type $photo_types * * @return int */ function get_user_profile_progress( $group_ids, $photo_types ) { /* User Progress specific VARS. */ $user_id = get_current_user_id(); $progress_details = array(); $grand_total_fields = 0; $grand_completed_fields = 0; $total_fields = 0; $completed_fields = 0; /* * Profile Photo */ $is_profile_photo_disabled = bp_disable_avatar_uploads(); if ( ! $is_profile_photo_disabled && in_array( 'profile_photo', $photo_types ) ) { ++$grand_total_fields; $is_profile_photo_uploaded = ( bp_get_user_has_avatar( $user_id ) ) ? 1 : 0; if ( $is_profile_photo_uploaded ) { ++$grand_completed_fields; } $progress_details['photo_type']['profile_photo'] = array( 'is_uploaded' => $is_profile_photo_uploaded, 'name' => __( 'Profile Photo', 'buddyx' ), ); } /* * Cover Photo */ $is_cover_photo_disabled = bp_disable_cover_image_uploads(); if ( ! $is_cover_photo_disabled && in_array( 'cover_photo', $photo_types ) ) { ++$grand_total_fields; $is_cover_photo_uploaded = ( bp_attachments_get_user_has_cover_image( $user_id ) ) ? 1 : 0; if ( $is_cover_photo_uploaded ) { ++$grand_completed_fields; } $progress_details['photo_type']['cover_photo'] = array( 'is_uploaded' => $is_cover_photo_uploaded, 'name' => __( 'Cover Photo', 'buddyx' ), ); } /* * Groups Fields */ $profile_groups = bp_xprofile_get_groups( array( 'fetch_fields' => true, 'fetch_field_data' => true, 'user_id' => $user_id, ) ); foreach ( $profile_groups as $single_group_details ) { if ( empty( $single_group_details->fields ) ) { continue; } /* Single Group Specific VARS */ $group_id = $single_group_details->id; $single_group_progress = array(); /* * Consider only selected Groups ids from the widget form settings, skip all others. */ if ( ! in_array( $group_id, $group_ids ) ) { continue; } // Check if Current Group is repeater if YES then get number of fields inside current group. $is_group_repeater_str = bp_xprofile_get_meta( $group_id, 'group', 'is_repeater_enabled', true ); $is_group_repeater = ( 'on' === $is_group_repeater_str ) ? true : false; /* Loop through all the fields and check if fields completed or not. */ $group_total_fields = 0; $group_completed_fields = 0; foreach ( $single_group_details->fields as $group_single_field ) { /* * If current group is repeater then only consider first set of fields. */ if ( $is_group_repeater ) { /* * If field not a "clone number 1" then stop. That means proceed with the first set of fields and restrict others. */ $field_id = $group_single_field->id; $clone_number = bp_xprofile_get_meta( $field_id, 'field', '_clone_number', true ); if ( $clone_number > 1 ) { continue; } } $field_data_value = maybe_unserialize( $group_single_field->data->value ); if ( ! empty( $field_data_value ) ) { ++$group_completed_fields; } ++$group_total_fields; } /* * Prepare array to return group specific progress details */ $single_group_progress['group_name'] = $single_group_details->name; $single_group_progress['group_total_fields'] = $group_total_fields; $single_group_progress['group_completed_fields'] = $group_completed_fields; $grand_total_fields += $group_total_fields; $grand_completed_fields += $group_completed_fields; $total_fields += $group_total_fields; $completed_fields += $group_completed_fields; } $progress_details['groups'][] = array( 'group_name' => __( 'Profile Fields', 'buddyx' ), 'group_total_fields' => $total_fields, 'group_completed_fields' => $completed_fields, ); /* * Total Fields vs completed fields to calculate progress percentage. */ $progress_details['total_fields'] = $grand_total_fields; $progress_details['completed_fields'] = $grand_completed_fields; return apply_filters( 'BP_buddyx_user_progress', $progress_details ); } /** * Function formats user progress to pass on to templates. * * @param type $user_progress_arr * * @return int */ function get_user_profile_progress_formatted( $user_progress_arr ) { /* Groups */ $loggedin_user_domain = bp_loggedin_user_domain(); $profile_slug = bp_get_profile_slug(); /* * Calculate Total Progress percentage. */ $profile_completion_percentage = round( ( $user_progress_arr['completed_fields'] * 100 ) / $user_progress_arr['total_fields'] ); $user_prgress_formatted = array( 'completion_percentage' => $profile_completion_percentage, ); /* * Group specific details */ $listing_number = 1; foreach ( $user_progress_arr['groups'] as $group_id => $group_details ) { $group_link = trailingslashit( $loggedin_user_domain . $profile_slug . '/edit/group/' . $group_id ); $user_prgress_formatted['groups'][] = array( 'number' => $listing_number, 'label' => $group_details['group_name'], 'link' => $group_link, 'is_group_completed' => ( $group_details['group_total_fields'] === $group_details['group_completed_fields'] ) ? true : false, 'total' => $group_details['group_total_fields'], 'completed' => $group_details['group_completed_fields'], ); $listing_number ++; } /* Profile Photo */ if ( isset( $user_progress_arr['photo_type']['profile_photo'] ) ) { $change_avatar_link = trailingslashit( $loggedin_user_domain . $profile_slug . '/change-avatar' ); $is_profile_uploaded = ( 1 === $user_progress_arr['photo_type']['profile_photo']['is_uploaded'] ); $user_prgress_formatted['groups'][] = array( 'number' => $listing_number, 'label' => $user_progress_arr['photo_type']['profile_photo']['name'], 'link' => $change_avatar_link, 'is_group_completed' => ( $is_profile_uploaded ) ? true : false, 'total' => 1, 'completed' => ( $is_profile_uploaded ) ? 1 : 0, ); $listing_number ++; } /* Cover Photo */ if ( isset( $user_progress_arr['photo_type']['cover_photo'] ) ) { $change_cover_link = trailingslashit( $loggedin_user_domain . $profile_slug . '/change-cover-image' ); $is_cover_uploaded = ( 1 === $user_progress_arr['photo_type']['cover_photo']['is_uploaded'] ); $user_prgress_formatted['groups'][] = array( 'number' => $listing_number, 'label' => $user_progress_arr['photo_type']['cover_photo']['name'], 'link' => $change_cover_link, 'is_group_completed' => ( $is_cover_uploaded ) ? true : false, 'total' => 1, 'completed' => ( $is_cover_uploaded ) ? 1 : 0, ); $listing_number ++; } /** * Filter returns User Progress array in the template friendly format. */ return apply_filters( 'BP_buddyx_user_progress_formatted', $user_prgress_formatted ); } /** * Callback to save widget settings. */ function update( $new_instance, $old_instance ) { return apply_filters( 'BP_buddyx_profile_completion_form_update', $new_instance ); } /** * Widget settings form. */ function form( $instance ) { $instance = wp_parse_args( (array) $instance, array( 'title' => __( 'Complete Your Profile', 'buddyx' ), 'profile_groups_enabled' => array( 0 => 1 ), 'profile_photos_enabled' => array( 0 => 'profile_photo', 1 => 'cover_photo', ), ) ); /* * Profile Groups and Profile Cover Photo. */ if ( function_exists( 'bp_xprofile_get_groups' ) ) { $profile_groups = bp_xprofile_get_groups(); } $photos_enabled_arr = array(); $is_profile_photo_disabled = bp_disable_avatar_uploads(); $is_cover_photo_disabled = bp_disable_cover_image_uploads(); /* * Show Options only when Profile Photo and Cover option enabled in the Profile Settings. */ if ( ! $is_profile_photo_disabled ) { $photos_enabled_arr['profile_photo'] = __( 'Profile Photo', 'buddyx' ); } if ( ! $is_cover_photo_disabled ) { $photos_enabled_arr['cover_photo'] = __( 'Cover Photo', 'buddyx' ); } /* Widget Form HTML */ ?>