1: <?php
2: /**
3: * WIDGET :: Property Gallery
4: *
5: * @package EPL
6: * @subpackage Widget/Classes/Gallery
7: * @copyright Copyright (c) 2019, Merv Barrett
8: * @license http://opensource.org/licenses/gpl-2.0.php GNU Public License
9: * @since 1.0
10: */
11:
12: // Exit if accessed directly.
13: if ( ! defined( 'ABSPATH' ) ) {
14: exit;
15: }
16:
17: /**
18: * EPL_Widget_Property_Gallery class
19: *
20: * @since 1.0
21: * @since 3.5 Added accessibility labels to select elements. Escaping value missing.
22: */
23: class EPL_Widget_Property_Gallery extends WP_Widget {
24:
25: /**
26: * Construct the widget.
27: *
28: * @since 1.0.0
29: */
30: public function __construct() {
31: parent::__construct( false, $name = __( 'EPL - Listing Gallery', 'easy-property-listings' ), array( 'description' => __( 'Display image gallery.', 'easy-property-listings' ) ) );
32: // Widget name for filter: epl_property_gallery.
33: }
34:
35: /**
36: * Widget function.
37: *
38: * @since 1.0
39: * @since 3.5 Added escaping to elements.
40: * @since 3.6 Uses the epl_property_gallery_html filter, as epl_property_gallery() does.
41: *
42: * @param array $args Widget arguments.
43: * @param array $instance Widget instance.
44: */
45: public function widget( $args, $instance ) {
46:
47: // phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped
48:
49: $defaults = array(
50: 'title' => '',
51: 'd_columns' => '4',
52: );
53: $instance = wp_parse_args( (array) $instance, $defaults );
54:
55: foreach ( $args as $arg_key => $arg_val ) {
56: ${$arg_key} = $arg_val;
57: }
58:
59: $title = apply_filters( 'widget_title', $instance['title'] );
60: $d_columns = $instance['d_columns'];
61:
62: // Allow an extension to supply gallery HTML (e.g. CDN-hosted images not in
63: // the media library). Mirrors epl_property_gallery().
64: $custom = apply_filters( 'epl_property_gallery_html', null, get_the_ID() );
65: if ( null !== $custom ) {
66: echo $before_widget; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
67: if ( $title ) {
68: echo $before_title . esc_html( $title ) . $after_title; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
69: }
70: echo $custom; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
71: echo $after_widget; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
72: return;
73: }
74:
75: $attachments = get_children(
76: array(
77: 'post_parent' => get_the_ID(),
78: 'post_type' => 'attachment',
79: 'post_mime_type' => 'image',
80: )
81: );
82: if ( ! empty( $attachments ) ) {
83: echo $before_widget;
84: if ( $title ) {
85: echo $before_title . esc_html( $title ) . $after_title;
86: }
87:
88: $gall = '[gallery columns="' . $d_columns . '" link="file"]';
89: echo do_shortcode( $gall );
90: echo $after_widget;
91: }
92: }
93:
94: /**
95: * Widget update.
96: *
97: * @param array $new_instance Old values.
98: * @param array $old_instance New values.
99: *
100: * @return array
101: * @since 1.0
102: */
103: public function update( $new_instance, $old_instance ) {
104: $instance = $old_instance;
105: $instance['title'] = wp_strip_all_tags( $new_instance['title'] );
106: $instance['d_columns'] = wp_strip_all_tags( $new_instance['d_columns'] );
107: return $instance;
108: }
109:
110: /**
111: * Render the widget form.
112: *
113: * @since 1.0
114: * @since 3.5 Refactored escaping elements. Removed unnecessary variables.
115: * @param array $instance options.
116: */
117: public function form( $instance ) {
118:
119: $defaults = array(
120: 'title' => '',
121: 'd_columns' => '4',
122: );
123: $instance = wp_parse_args( (array) $instance, $defaults );
124:
125: ?>
126:
127: <p>
128: <label for="<?php echo esc_attr( $this->get_field_id( 'title' ) ); ?>"><?php esc_html_e( 'Title:', 'easy-property-listings' ); ?></label>
129: <input class="widefat" id="<?php echo esc_attr( $this->get_field_id( 'title' ) ); ?>" name="<?php echo esc_attr( $this->get_field_name( 'title' ) ); ?>" type="text" value="<?php echo esc_attr( $instance['title'] ); ?>" />
130: </p>
131:
132: <p>
133: <label for="<?php echo esc_attr( $this->get_field_id( 'd_columns' ) ); ?>"><?php esc_html_e( 'Number of columns', 'easy-property-listings' ); ?></label>
134: <select aria-label="<?php esc_attr_e( 'Number of columns', 'easy-property-listings' ); ?>" class="widefat" id="<?php echo esc_attr( $this->get_field_id( 'd_columns' ) ); ?>" name="<?php echo esc_attr( $this->get_field_name( 'd_columns' ) ); ?>">
135: <?php
136: for ( $i = 1;$i <= 6;$i++ ) {
137: echo '<option value="' . esc_attr( $i ) . '"';
138: if ( $i == $instance['d_columns'] ) { //phpcs:ignore
139: echo ' selected="selected"';
140: } echo '>' . esc_html( $i ) . '</option>';
141: }
142: ?>
143: </select>
144: </p>
145: <?php
146: }
147: }
148:
149: /**
150: * Register Property Gallery Widget.
151: *
152: * Registers the EPL Widgets.
153: *
154: * @since 3.2.2
155: * @return void
156: */
157: function epl_register_widget_property_gallery() {
158: register_widget( 'EPL_Widget_Property_Gallery' );
159: }
160: add_action( 'widgets_init', 'epl_register_widget_property_gallery' );
161: