earned-user-achievements-widget.php
19.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
<?php
/**
* Achievement Widget
*
* @package badgeos/includes/widgets
*/
/**
* Class earned_user_achievements_widget.
*/
class Earned_User_Achievements_Widget extends WP_Widget {
/**
* Constructor
*/
public function __construct() {
$widget_ops = array(
'classname' => 'earned_user_achievements_class',
'description' => __( 'Displays all achievements earned by the logged in user', 'badgeos' ),
);
parent::__construct( 'earned_user_achievements_widget', __( 'BadgeOS Earned User Achievements', 'badgeos' ), $widget_ops );
}
/**
* Form
*
* @param array $instance args.
*/
public function form( $instance ) {
$defaults = array(
'title' => __( 'My Achievements', 'badgeos' ),
'number' => '10',
'set_point_type' => '',
'point_total' => '',
'set_achievements' => '',
'set_ranks' => array(),
);
$instance = wp_parse_args( (array) $instance, $defaults );
$title = isset( $instance['title'] ) ? sanitize_text_field( wp_unslash( $instance['title'] ) ) : '';
$number = isset( $instance['number'] ) ? sanitize_text_field( wp_unslash( $instance['number'] ) ) : '';
$point_total = isset( $instance['point_total'] ) ? sanitize_text_field( wp_unslash( $instance['point_total'] ) ) : '';
$set_point_type = isset( $instance['total_points_type'] ) ? sanitize_text_field( wp_unslash( $instance['total_points_type'] ) ) : '';
$set_ranks = isset( $instance['set_ranks'] ) ? array_map( 'sanitize_text_field', (array) $instance['set_ranks'] ) : array();
$set_achievements = isset( $instance['set_achievements'] ) ? array_map( 'sanitize_text_field', (array) $instance['set_achievements'] ) : array();
$remove_title_field = isset( $instance['remove_title_field'] ) ? sanitize_text_field( wp_unslash( $instance['remove_title_field'] ) ) : '';
$remove_thumb_field = isset( $instance['remove_thumb_field'] ) ? sanitize_text_field( wp_unslash( $instance['remove_thumb_field'] ) ) : '';
$rank_section_title = isset( $instance['rank_section_title'] ) ? sanitize_text_field( wp_unslash( $instance['rank_section_title'] ) ) : '';
$achievement_section_title = isset( $instance['achievement_section_title'] ) ? sanitize_text_field( wp_unslash( $instance['achievement_section_title'] ) ) : '';
$badgeos_settings = ! empty( badgeos_utilities::get_option( 'badgeos_settings' ) ) ? badgeos_utilities::get_option( 'badgeos_settings' ) : array();
?>
<p><label><?php esc_attr_e( 'Title', 'badgeos' ); ?>: <input class="widefat" name="<?php echo esc_attr( $this->get_field_name( 'title' ) ); ?>" type="text" value="<?php echo esc_attr( $title ); ?>" /></label></p>
<p><label><?php esc_attr_e( 'Number to display (0 = all)', 'badgeos' ); ?>: <input class="widefat" name="<?php echo esc_attr( $this->get_field_name( 'number' ) ); ?>" type="text" value="<?php echo absint( $number ); ?>" /></label></p>
<p><label><?php esc_attr_e( 'Hide following fields:', 'badgeos' ); ?></label></p>
<p>
<label for="remove_title_field">
<input type="checkbox" name="<?php echo esc_attr( $this->get_field_name( 'remove_title_field' ) ); ?>" id="<?php echo esc_attr( $this->get_field_name( 'remove_title_field' ) ); ?>" <?php echo 'on' === $remove_title_field ? esc_attr( 'checked' ) : ''; ?> />
<?php esc_attr_e( 'Title Field', 'badgeos' ); ?>
</label><br />
<label for="remove_thumb_field">
<input type="checkbox" name="<?php echo esc_attr( $this->get_field_name( 'remove_thumb_field' ) ); ?>" id="<?php echo esc_attr( $this->get_field_name( 'remove_thumb_field' ) ); ?>" <?php echo 'on' === $remove_thumb_field ? esc_attr( 'checked' ) : ''; ?> />
<?php esc_attr_e( 'Thumbnail Field', 'badgeos' ); ?>
</label><br />
</p>
<p><label><?php esc_attr_e( 'Rank Section Title', 'badgeos' ); ?>: <input class="widefat" name="<?php echo esc_attr( $this->get_field_name( 'rank_section_title' ) ); ?>" type="text" value="<?php echo esc_attr( $rank_section_title ); ?>" /></label></p>
<p><label><?php esc_attr_e( 'Display only the following User Rank Types:', 'badgeos' ); ?></label></p>
<p>
<?php
// Get all registered achievements.
$ranks = badgeos_get_rank_types_slugs_detailed();
// Loop through all registered achievements.
foreach ( $ranks as $rank_slug => $rank ) {
// If rank displaying exists in the saved array it is enabled for display.
$checked = checked( in_array( $rank_slug, $set_ranks, true ), true, false );
echo '<label for="' . esc_attr( $this->get_field_name( 'set_ranks' ) ) . '_' . esc_attr( $rank_slug ) . '">'
. '<input type="checkbox" name="' . esc_attr( $this->get_field_name( 'set_ranks' ) ) . '[]" id="' . esc_attr( $this->get_field_name( 'set_ranks' ) ) . '_' . esc_attr( $rank_slug ) . '" value="' . esc_attr( $rank_slug ) . '" ' . esc_attr( $checked ) . ' />'
. ' ' . esc_html( ucfirst( $rank['plural_name'] ) )
. '</label><br />';
}
?>
</p>
<p><label><input type="checkbox" id="<?php echo esc_attr( $this->get_field_name( 'point_total' ) ); ?>" name="<?php echo esc_attr( $this->get_field_name( 'point_total' ) ); ?>" <?php checked( $point_total, 'on' ); ?> /> <?php esc_attr_e( 'Display user\'s total points', 'badgeos' ); ?></label></p>
<p>
<?php esc_attr_e( 'Select Point Type: ', 'badgeos' ); ?><br />
<?php
// Get all credit types.
$point_types = badgeos_get_point_types();
if ( is_array( $point_types ) && ! empty( $point_types ) ) {
?>
<select id="total_points_type" name="<?php echo esc_attr( $this->get_field_name( 'total_points_type' ) ); ?>" class="widget-total-points-type">
<option value=""><?php esc_attr_e( 'Select Points Type' ); ?></option>
<?php
foreach ( $point_types as $key => $point_type ) {
?>
<option value="<?php echo esc_attr( $point_type->ID ); ?>" <?php echo selected( $set_point_type, $point_type->ID ); ?> ><?php echo esc_attr( $point_type->post_title ); ?></option>
<?php
}
?>
</select>
<br />
<span class="tool-hint"><?php esc_attr_e( 'Total points of selected type will be displayed on frontend.', 'badgeos' ); ?></span>
<?php } ?>
</p>
<p><label><?php esc_attr_e( 'Achievement Section Title', 'badgeos' ); ?>: <input class="widefat" name="<?php echo esc_attr( $this->get_field_name( 'achievement_section_title' ) ); ?>" type="text" value="<?php echo esc_attr( $achievement_section_title ); ?>" /></label></p>
<p><?php esc_html_e( 'Display only the following Achievement Types:', 'badgeos' ); ?></p>
<p>
<?php
// get all registered achievements.
$achievements = badgeos_get_achievement_types();
// loop through all registered achievements.
foreach ( $achievements as $achievement_slug => $achievement ) {
// hide the step CPT.
if ( trim( $badgeos_settings['achievement_step_post_type'] === $achievement['single_name'] ) ) {
continue;
}
// if achievement displaying exists in the saved array it is enabled for display.
$checked = checked( in_array( $achievement_slug, $set_achievements, true ), true, false );
echo '<label for="' . esc_attr( $this->get_field_name( 'set_achievements' ) ) . '_' . esc_attr( $achievement_slug ) . '">'
. '<input type="checkbox" name="' . esc_attr( $this->get_field_name( 'set_achievements' ) ) . '[]" id="' . esc_attr( $this->get_field_name( 'set_achievements' ) ) . '_' . esc_attr( $achievement_slug ) . '" value="' . esc_attr( $achievement_slug ) . '" ' . esc_attr( $checked ) . ' />'
. ' ' . esc_html( ucfirst( $achievement['plural_name'] ) )
. '</label><br />';
}
?>
</p>
<?php
}
/**
* Widget
*
* @param array $new_instance selected args.
* @param array $old_instance $args.
*/
public function update( $new_instance, $old_instance ) {
$instance = $old_instance;
if ( ! isset( $new_instance['set_ranks'] ) || empty( $new_instance['set_ranks'] ) ) {
$new_instance['set_ranks'] = array();
}
if ( ! isset( $new_instance['set_achievements'] ) || empty( $new_instance['set_achievements'] ) ) {
$new_instance['set_achievements'] = array();
}
$instance['title'] = sanitize_text_field( $new_instance['title'] );
$instance['number'] = absint( $new_instance['number'] );
$instance['total_points_type'] = sanitize_text_field( $new_instance['total_points_type'] );
$instance['set_ranks'] = array_map( 'sanitize_text_field', $new_instance['set_ranks'] );
$instance['point_total'] = ( ! empty( $new_instance['point_total'] ) ) ? sanitize_text_field( $new_instance['point_total'] ) : '';
$instance['set_achievements'] = array_map( 'sanitize_text_field', $new_instance['set_achievements'] );
$instance['remove_title_field'] = ( ! empty( $new_instance['remove_title_field'] ) ) ? sanitize_text_field( $new_instance['remove_title_field'] ) : '';
$instance['remove_thumb_field'] = ( ! empty( $new_instance['remove_thumb_field'] ) ) ? sanitize_text_field( $new_instance['remove_thumb_field'] ) : '';
$instance['rank_section_title'] = ( ! empty( $new_instance['rank_section_title'] ) ) ? sanitize_text_field( $new_instance['rank_section_title'] ) : '';
$instance['achievement_section_title'] = ( ! empty( $new_instance['achievement_section_title'] ) ) ? sanitize_text_field( $new_instance['achievement_section_title'] ) : '';
return $instance;
}
/**
* Widget
*
* @param array $args selected args.
* @param array $instance args.
*/
public function widget( $args, $instance ) {
$args = array_map( 'sanitize_text_field', $args );
if ( array_key_exists( 'before_widget', $args ) ) {
echo esc_html( $args['before_widget'] );
}
$badgeos_settings = ! empty( badgeos_utilities::get_option( 'badgeos_settings' ) ) ? badgeos_utilities::get_option( 'badgeos_settings' ) : array();
$title = apply_filters( 'widget_title', $instance['title'] );
$remove_title_field = isset( $instance['remove_title_field'] ) ? $instance['remove_title_field'] : '';
$remove_thumb_field = isset( $instance['remove_thumb_field'] ) ? $instance['remove_thumb_field'] : '';
$rank_section_title = ( isset( $instance['rank_section_title'] ) ) ? $instance['rank_section_title'] : '';
$achievement_section_title = ( isset( $instance['achievement_section_title'] ) ) ? $instance['achievement_section_title'] : '';
$show_title = true;
if ( 'on' === $remove_title_field ) {
$show_title = false;
}
$show_thumb = true;
if ( 'on' === $remove_thumb_field ) {
$show_thumb = false;
}
if ( ! empty( $title ) ) {
echo esc_html( $args['before_title'] . $title . $args['after_title'] );
};
// user must be logged in to view earned badges and points.
if ( is_user_logged_in() ) {
// display user's points if widget option is enabled.
if ( 'on' === $instance['point_total'] && ! empty( $instance['total_points_type'] ) ) {
$earned_points = badgeos_get_points_by_type( $instance['total_points_type'], get_current_user_id() );
if ( $show_title ) {
$plural_name = badgeos_utilities::get_post_meta( $instance['total_points_type'], '_point_plural_name', true );
if ( ! empty( $plural_name ) ) {
$point_title = $plural_name;
} else {
$point_title = get_the_title( $instance['total_points_type'] );
}
} else {
$point_title = '';
}
$badge_image = badgeos_get_point_image( $instance['total_points_type'] );
$badge_image = apply_filters( 'badgeos_profile_points_image', $badge_image, 'front-widget', $instance['total_points_type'] );
?>
<div class="badgeos_earned_points_only">
<table>
<tr>
<td width="100%">
<div class="badgeos_earned_points_widget_image">
<?php echo wp_kses_post( $badge_image ); ?>
</div>
<div class="badgeos_earned_points_widget">
<div class="badgeos-earned-credit">
<span><?php echo esc_html( number_format( $earned_points ) ); ?></span>
</div>
</div>
</td>
</tr>
<tr>
<td>
<div class="points_widget_title">
<?php echo esc_html( $point_title ); ?>
</div>
</td>
</tr>
</table>
</div>
<?php
}
if ( isset( $instance['set_ranks'] ) && is_array( $instance['set_ranks'] ) && count( $instance['set_ranks'] ) > 0 ) {
$user_ranks = badgeos_get_user_ranks( array( 'rank_type' => $instance['set_ranks'] ) );
if ( isset( $user_ranks ) && count( $user_ranks ) > 0 ) {
?>
<p class="badgeos-user-ranks-main">
<?php if ( ! empty( $rank_section_title ) ) { ?>
<h3><?php echo esc_html( $rank_section_title ); ?></h3>
<?php } ?>
<?php
echo '<ul class="widget-ranks-listing">';
$rank_width = '50';
if ( isset( $badgeos_settings['badgeos_rank_global_image_width'] ) && intval( $badgeos_settings['badgeos_rank_global_image_width'] ) > 0 ) {
$rank_width = intval( $badgeos_settings['badgeos_rank_global_image_width'] );
}
$rank_height = '50';
if ( isset( $badgeos_settings['badgeos_rank_global_image_height'] ) && intval( $badgeos_settings['badgeos_rank_global_image_height'] ) > 0 ) {
$rank_height = intval( $badgeos_settings['badgeos_rank_global_image_height'] );
}
foreach ( $user_ranks as $rank ) {
$img = badgeos_get_rank_image( $rank->rank_id, $rank_width, $rank_height );
$img_permalink = 'javascript:;';
if ( ! function_exists( 'post_exists' ) ) {
require_once ABSPATH . 'wp-admin/includes/post.php';
}
if ( post_exists( get_the_title( $rank->rank_id ) ) ) {
$img_permalink = get_permalink( $rank->rank_id );
}
$thumb = $img ? '<a class="badgeos-item-thumb" href="' . $img_permalink . '">' . $img . '</a>' : '';
$class = 'widget-badgeos-item-title';
$item_class = $thumb ? ' has-thumb' : '';
$rank_title = get_the_title( $rank->rank_id );
if ( empty( $rank_title ) ) {
$rank_title = '<a class="widget-badgeos-item-title ' . esc_attr( $class ) . '" href="javascript:;">' . esc_html( $rank->rank_title ) . '</a>';
} else {
$permalink = get_permalink( $rank->rank_id );
$rank_title = '<a class="widget-badgeos-item-title ' . esc_attr( $class ) . '" href="' . esc_url( $permalink ) . '">' . esc_html( $rank_title ) . '</a>';
}
echo '<li id="widget-rank-listing-item-' . absint( $rank->rank_id ) . '" class="widget-rank-listing-item' . esc_attr( $item_class ) . '">';
if ( $show_thumb ) {
echo wp_kses_post( $thumb );
}
if ( $show_title ) {
echo wp_kses_post( $rank_title );
}
do_action( 'badgeos_widget_ranks_listing', $rank );
echo '</li>';
}
echo '</ul>';
?>
</p>
<?php
}
}
$achievements = badgeos_get_user_achievements( array( 'user_id' => absint( get_current_user_id() ) ) );
if ( is_array( $achievements ) && ! empty( $achievements ) && count( $achievements ) > 0 ) {
$number_to_show = absint( $instance['number'] );
$thecount = 0;
wp_enqueue_script( 'badgeos-achievements' );
wp_enqueue_style( 'badgeos-widget' );
// load widget setting for achievement types to display.
$set_achievements = ( isset( $instance['set_achievements'] ) ) ? $instance['set_achievements'] : '';
// show most recently earned achievement first.
$achievements = array_reverse( $achievements );
$is_title_show = false;
foreach ( $achievements as $achievement ) {
// verify achievement type is set to display in the widget settings.
// if $set_achievements is not an array it means nothing is set so show all achievements.
if ( is_array( $set_achievements ) && in_array( $achievement->post_type, $set_achievements, true ) ) {
$is_hidden = badgeos_utilities::get_post_meta( $achievement->ID, '_badgeos_hidden', true );
if ( 'hidden' !== $is_hidden ) {
if ( badgeos_utilities::get_post_type( $achievement->ID ) !== trim( $badgeos_settings['achievement_step_post_type'] ) ) {
if ( false === $is_title_show ) {
echo '<p class="badgeos-user-achievements-main">';
if ( ! empty( $achievement_section_title ) ) {
echo '<h3>' . esc_html( $achievement_section_title ) . '</h3>';
}
echo '<ul class="widget-achievements-listing" style="margin:0px 0px">';
$is_title_show = true;
}
$achievement_width = '50';
if ( isset( $badgeos_settings['badgeos_achievement_global_image_width'] ) && intval( $badgeos_settings['badgeos_achievement_global_image_width'] ) > 0 ) {
$achievement_width = intval( $badgeos_settings['badgeos_achievement_global_image_width'] );
}
$achievement_height = '50';
if ( isset( $badgeos_settings['badgeos_achievement_global_image_height'] ) && intval( $badgeos_settings['badgeos_achievement_global_image_height'] ) > 0 ) {
$achievement_height = intval( $badgeos_settings['badgeos_achievement_global_image_height'] );
}
$img = badgeos_get_achievement_post_thumbnail( $achievement->ID, array( $achievement_width, $achievement_height ), 'wp-post-image' );
$img = apply_filters( 'badgeos_profile_achivement_image', $img, $achievement, array() );
$img_permalink = 'javascript:;';
if ( ! function_exists( 'post_exists' ) ) {
require_once ABSPATH . 'wp-admin/includes/post.php';
}
if ( post_exists( get_the_title( $achievement->ID ) ) ) {
$img_permalink = get_permalink( $achievement->ID );
}
$open_badge_enable_baking = badgeos_get_option_open_badge_enable_baking( $achievement->ID );
if ( $open_badge_enable_baking ) {
$badgeos_evidence_page_id = badgeos_utilities::get_option( 'badgeos_evidence_url' );
$badgeos_evidence_url = get_permalink( $badgeos_evidence_page_id );
$badgeos_evidence_url = add_query_arg( 'bg', $achievement->ID, $badgeos_evidence_url );
$badgeos_evidence_url = add_query_arg( 'eid', $achievement->entry_id, $badgeos_evidence_url );
$badgeos_evidence_url = add_query_arg( 'uid', $achievement->user_id, $badgeos_evidence_url );
$img_permalink = $badgeos_evidence_url;
}
$thumb = $img ? '<a class="badgeos-item-thumb" href="' . $img_permalink . '">' . $img . '</a>' : '';
$class = 'widget-badgeos-item-title';
$item_class = $thumb ? ' has-thumb' : '';
$achievement_title = get_the_title( $achievement->ID );
if ( empty( $achievement_title ) ) {
$achievement_title = '<a class="widget-badgeos-item-title ' . esc_attr( $class ) . '" href="' . esc_url( $img_permalink ) . '">' . esc_html( $achievement->achievement_title ) . '</a>';
} else {
$permalink = get_permalink( $achievement->ID );
$achievement_title = '<a class="widget-badgeos-item-title ' . esc_attr( $class ) . '" href="' . esc_url( $img_permalink ) . '">' . esc_html( $achievement_title ) . '</a>';
}
echo '<li id="widget-achievements-listing-item-' . esc_attr( $achievement->ID ) . '" class="widget-achievements-listing-item' . esc_attr( $item_class ) . '">';
if ( $show_thumb ) {
echo wp_kses_post( $thumb );
}
if ( $show_title ) {
echo wp_kses_post( $achievement_title );
}
do_action( 'badgeos_widget_achievements_listing', $achievement );
echo '</li>';
$thecount++;
if ( $thecount === $number_to_show && 0 !== $number_to_show ) {
break;
}
}
}
}
}
echo '</ul><!-- widget-achievements-listing -->';
echo '</p>';
}
} else {
// user is not logged in so display a message.
esc_attr_e( 'You must be logged in to view earned achievements', 'badgeos' );
}
if ( array_key_exists( 'after_widget', $args ) ) {
echo esc_html( $args['after_widget'] );
}
}
}