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 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 <?php
/**
* Metabox Oject
*
* @package EPL
* @subpackage Classes/MetaboxesCustomFields
* @copyright Copyright (c) 2019, Merv Barrett
* @license http://opensource.org/licenses/gpl-2.0.php GNU Public License
* @since 2.3
*/
// Exit if accessed directly.
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
/**
* EPL_METABOX class
* Can also be used by extensions to handle all the metabox functionality
* it adds metabox wrapper & renders metabox fields and finally save it on save_post hook
* the constructor of the class accepts one or more array of metabox to be rendered
* the structure of the metabox array should be similar to make it work
*
* @since 2.0
*/
class EPL_METABOX {
/**
* Holds the user submitted metabox array
*
* @var array $epl_meta_boxes
*/
protected $epl_meta_boxes;
/**
* Prefix used in nonces and other places to make them unique
*
* Default is epl_
*
* @var array $epl_meta_boxes
*/
protected $prefix;
/**
* Translation domain used to translate string
*
* Default is epl
*
* @var array $text_domain
*/
protected $text_domain;
/**
* Constructor
*
* Register a mea box.
*
* @param mixed $epl_meta_boxes The name(s) of the meta box.
* @param string $prefix Prefix of meta box.
* @param string $text_domain Text domain name.
*/
public function __construct( $epl_meta_boxes, $prefix = 'epl_', $text_domain = 'easy-property-listings' ) {
$this->epl_meta_boxes = $epl_meta_boxes;
$this->prefix = (string) $prefix;
$this->text_domain = (string) $text_domain;
// Register meta boxes.
$this->add_action( 'add_meta_boxes', array( &$this, 'add_meta_boxes' ) );
// Save meta boxes.
$this->add_action( 'save_post', array( &$this, 'save_meta_box' ) );
}
/**
* Add Action
*
* Helper function to add add_action WordPress filters.
*
* @param string $action Name of the action.
* @param string $function Function to hook that will run on action.
* @param int $priority Order in which to execute the function, relation to other functions hooked to this action.
* @param integer $accepted_args The number of arguments the function accepts.
*/
public function add_action( $action, $function, $priority = 10, $accepted_args = 1 ) {
// Pass variables into WordPress add_action function.
add_action( $action, $function, $priority, $accepted_args );
}
/**
* Add Filter
*
* Create add_filter WordPress filter.
*
* @see http://codex.wordpress.org/Function_Reference/add_filter
*
* @param string $action Name of the action to hook to, e.g 'init'.
* @param string $function Function to hook that will run on @action.
* @param int $priority Order in which to execute the function, relation to other function hooked to this action.
* @param int $accepted_args The number of arguements the function accepts.
*/
public function add_filter( $action, $function, $priority = 10, $accepted_args = 1 ) {
// Pass variables into WordPress add_action function.
add_filter( $action, $function, $priority, $accepted_args );
}
/**
* Add metaboxes
*
* See how to register custom field metaboxes to listings here.
*
* @link https://codex.easypropertylistings.com.au/article/127-epllistingmetaboxes-filter
*/
public function add_meta_boxes() {
if ( ! empty( $this->epl_meta_boxes ) ) {
foreach ( $this->epl_meta_boxes as $epl_meta_box ) {
// If we have multiple metaboxes.
if ( isset( $epl_meta_box['id'] ) && is_array( $epl_meta_box ) ) {
// Multiple post type.
if ( is_array( $epl_meta_box['post_type'] ) ) {
foreach ( $epl_meta_box['post_type'] as $post_type ) {
$this->add_meta_box(
$epl_meta_box['id'],
$epl_meta_box['label'],
'inner_meta_box',
$post_type,
$epl_meta_box['context'],
$epl_meta_box['priority'],
$epl_meta_box
);
}
} else {
$this->add_meta_box(
$epl_meta_box['id'],
$epl_meta_box['label'],
'inner_meta_box',
$epl_meta_box['post_type'],
$epl_meta_box['context'],
$epl_meta_box['priority'],
$epl_meta_box
);
}
} else {
// If we have single metabox.
$epl_meta_box = $this->epl_meta_boxes;
// Multiple post type.
if ( is_array( $epl_meta_box['post_type'] ) ) {
foreach ( $epl_meta_box['post_type'] as $post_type ) {
$this->add_meta_box(
$epl_meta_box['id'],
$epl_meta_box['label'],
'inner_meta_box',
$post_type,
$epl_meta_box['context'],
$epl_meta_box['priority'],
$epl_meta_box
);
}
} else {
$this->add_meta_box(
$epl_meta_box['id'],
$epl_meta_box['label'],
'inner_meta_box',
$epl_meta_box['post_type'],
$epl_meta_box['context'],
$epl_meta_box['priority'],
$epl_meta_box
);
}
break;
}
}
}
}
/**
* Class wrapper for WordPress function add_meta_box
*
* @see https://codex.wordpress.org/Function_Reference/add_meta_box
*
* @param string $id Meta box ID (used in the 'id' attribute for the meta box).
* @param string $label Title of the meta box.
* @param string $func Function that fills the box with the desired content.
* The function should echo its output.
* @param array $post_type Post type name.
* @param string $context Optional. The context within the screen where the boxes
* should display. Available contexts vary from screen to
* screen. Post edit screen contexts include 'normal', 'side',
* and 'advanced'. Comments screen contexts include 'normal'
* and 'side'. Menus meta boxes (accordion sections) all use
* the 'side' context. Global default is 'advanced'.
* @param string $priority Optional. The priority within the context where the boxes
* should show ('high', 'low'). Default 'default'.
* @param array $args Optional. Data that should be set as the $args property
* of the box array (which is the second parameter passed
* to your callback). Default null.
*/
public function add_meta_box( $id = '', $label = '', $func = 'inner_meta_box', $post_type = array(), $context = 'normal', $priority = 'default', $args = null ) {
add_meta_box(
$id,
$label,
array( $this, $func ),
$post_type,
$context,
$priority,
$args
);
}
/**
* Used to render the metabox fields
*
* @param array $post Post object.
* @param array $args Array of options.
*
* @since 3.4.19 Updated to new html structure for fields using html lists
*/
public function inner_meta_box( $post, $args ) {
$groups = $args['args']['groups'];
$groups = array_filter( $groups );
$render_as = empty( $args['args']['render_as'] ) ? 'default' : sanitize_text_field( $args['args']['render_as'] );
// This supports both tabs-horizontal and tabs-vertical options.
if ( ! empty( $groups ) ) {
wp_nonce_field( $this->prefix . 'inner_custom_box', $this->prefix . 'inner_custom_box_nonce' );
if ( in_array( $render_as, array( 'tabs-horizontal', 'tabs-vertical' ), true ) ) {
// Wrapper for tabs.
echo '<div class="epl-group-tab-wrapper epl-' . esc_attr( $render_as ) . '">';
}
if ( in_array( $render_as, array( 'tabs-horizontal', 'tabs-vertical' ), true ) ) { ?>
<ul class="epl-group-tabs">
<?php
foreach ( $groups as $group ) {
echo '<li><a href="#epl-field-group-' . esc_attr( $group['id'] ) . '"><h3>' . esc_attr( $group['label'] ) . '</h3></a></li>';
}
?>
</ul>
<?php
}
foreach ( $groups as $group ) {
?>
<div id="epl-field-group-<?php echo esc_attr( $group['id'] ); ?>">
<div class="epl-inner-div col-<?php echo esc_attr( $group['columns'] ); ?> table-<?php echo esc_attr( $args['args']['context'] ); ?>">
<?php
$group['label'] = trim( $group['label'] );
if ( ! empty( $group['label'] ) && ! in_array( $render_as, array( 'tabs-horizontal', 'tabs-vertical' ), true ) ) {
echo '<h3>' . esc_attr( $group['label'] ) . '</h3>';
}
?>
<ul class="form-table epl-form-table">
<?php
$fields = $group['fields'];
$gp_field_width = isset( $group['width'] ) ? $group['width'] : '1';
$fields = array_filter( $fields );
if ( ! empty( $fields ) ) {
foreach ( $fields as $field ) {
if ( isset( $field['exclude'] ) && ! empty( $field['exclude'] ) ) {
if ( in_array( $post->post_type, $field['exclude'], true ) ) {
continue;
}
}
if ( isset( $field['include'] ) && ! empty( $field['include'] ) ) {
if ( ! in_array( $post->post_type, $field['include'], true ) ) {
continue;
}
}
$val = get_post_meta( $post->ID, $field['name'], true );
if ( has_action( 'epl_before_meta_field_' . $field['name'] ) ) {
do_action( 'epl_before_meta_field_' . $field['name'], $post, $val );
}
$field_width = isset( $field['width'] ) ? $field['width'] : $gp_field_width;
?>
<li id="epl_<?php echo esc_attr( $field['name'] ); ?>_wrap" class="epl-form-field-wrap epl-grid-<?php echo esc_attr( $field_width ); ?> epl_<?php echo esc_attr( $field['name'] ); ?>_wrap epl-field-type-<?php echo esc_attr( $field['type'] ); ?>">
<?php if ( 'checkbox_single' !== $field['type'] || ( isset( $field['opts'] ) && 1 !== count( $field['opts'] ) ) ) : ?>
<div class="form-field epl-form-field-label">
<span valign="top" scope="row">
<label for="<?php echo esc_attr( $field['name'] ); ?>"><?php echo esc_attr( $field['label'] ); ?></label>
</span>
</div>
<?php endif; ?>
<div id="epl_<?php echo esc_attr( $field['name'] ); ?>" class="form-field epl-form-field-value epl_<?php echo esc_attr( $field['name'] ); ?>">
<?php
epl_render_html_fields( $field, $val );
?>
</div>
</li>
<?php
if ( has_action( 'epl_after_meta_field_' . $field['name'] ) ) {
do_action( 'epl_after_meta_field_' . $field['name'], $post, $val );
}
?>
<?php
}
}
?>
</ul>
</div>
</div>
<?php
}
?>
<input type="hidden" name="epl_meta_box_ids[]" value="<?php echo esc_attr( $args['id'] ); ?>" />
<div class="epl-clear"></div>
<?php
if ( in_array( $render_as, array( 'tabs-horizontal', 'tabs-vertical' ), true ) ) {
// Wrapper end.
echo '</div>';
}
}
}
/**
* Callback function hooked on WordPress save_post hook
* used to save all the meta fields
*
* @see https://codex.wordpress.org/Plugin_API/Action_Reference/save_post
*
* @param int $post_ID The post ID.
*
* @return int
* @since 3.4.17 Fixed issue : empty values not getting saved for decimals & numbers
*/
public function save_meta_box( $post_ID ) {
if ( ! isset( $_POST[ $this->prefix . 'inner_custom_box_nonce' ] ) ) {
return $post_ID;
}
$nonce = $_POST[ $this->prefix . 'inner_custom_box_nonce' ]; //phpcs:ignore
if ( ! wp_verify_nonce( $nonce, $this->prefix . 'inner_custom_box' ) ) {
return $post_ID;
}
if ( defined( 'DOING_AUTOSAVE' ) && DOING_AUTOSAVE ) {
return $post_ID;
}
if ( isset( $_POST['post_type'] ) && 'page' === $_POST['post_type'] ) {
if ( ! current_user_can( 'edit_page', $post_ID ) ) {
return $post_ID;
}
} else {
if ( ! current_user_can( 'edit_post', $post_ID ) ) {
return $post_ID;
}
}
$epl_meta_box_ids = '';
if ( isset( $_POST['epl_meta_box_ids'] ) ) {
$epl_meta_box_ids = wp_unslash( $_POST['epl_meta_box_ids'] ); //phpcs:ignore
}
if ( ! empty( $epl_meta_box_ids ) ) {
if ( ! empty( $this->epl_meta_boxes ) ) {
foreach ( $epl_meta_box_ids as $epl_meta_box_id ) {
foreach ( $this->epl_meta_boxes as $epl_meta_box ) {
if ( $epl_meta_box['id'] === $epl_meta_box_id ) {
if ( ! empty( $epl_meta_box['groups'] ) ) {
foreach ( $epl_meta_box['groups'] as $group ) {
$fields = $group['fields'];
if ( ! empty( $fields ) ) {
foreach ( $fields as $field ) {
// Dont go further if the current post type is in excluded list of the current field.
if ( isset( $field['exclude'] ) && ! empty( $field['exclude'] ) ) {
if ( isset( $_POST['post_type'] ) && in_array( $_POST['post_type'], $field['exclude'], true ) ) {
continue;
}
}
// Dont go further if the current post type is not in included list of the current field.
if ( isset( $field['include'] ) && ! empty( $field['include'] ) ) {
if ( ! in_array( $_POST['post_type'], $field['include'] ) ) { // phpcs:ignore
continue;
}
}
if ( 'radio' === $field['type'] ) {
if ( ! isset( $_POST[ $field['name'] ] ) ) {
continue;
}
} elseif ( 'checkbox_single' === $field['type'] ) {
if ( ! isset( $_POST[ $field['name'] ] ) ) {
$_POST[ $field['name'] ] = '';
}
} elseif ( in_array( $field['type'], array( 'number', 'decimal' ), true ) ) {
// Validate numeric data.
if ( ! is_numeric( $_POST[ $field['name'] ] ) && ! empty( $_POST[ $field['name'] ] ) ) {
continue;
}
} elseif ( in_array( $field['type'], array( 'textarea' ), true ) ) {
if ( function_exists( 'sanitize_textarea_field' ) ) {
$_POST[ $field['name'] ] =
sanitize_textarea_field( wp_unslash( $_POST[ $field['name'] ] ) );
}
} elseif ( in_array( $field['type'], array( 'url', 'file' ), true ) ) {
// Sanitize URLs.
$_POST[ $field['name'] ] = esc_url_raw( wp_unslash( $_POST[ $field['name'] ] ) );
} elseif ( 'auction-date' === $field['type'] && ! empty( $_POST[ $field['name'] ] ) ) {
$epl_date = sanitize_text_field( wp_unslash( $_POST[ $field['name'] ] ) );
if ( strpos( $epl_date, 'T' ) !== false ) {
$epl_date = date( 'Y-m-d\TH:i', strtotime( $epl_date ) );
} else {
$epl_date = DateTime::createFromFormat( 'Y-m-d-H:i:s', $epl_date );
if ( $epl_date ) {
$epl_date = $epl_date->format( 'Y-m-d\TH:i' );
}
}
$_POST[ $field['name'] ] = $epl_date;
} elseif ( 'sold-date' === $field['type'] && ! empty( $_POST[ $field['name'] ] ) ) {
$epl_date = sanitize_text_field( wp_unslash( $_POST[ $field['name'] ] ) );
if ( strpos( $epl_date, 'T' ) !== false ) {
$epl_date = date( 'Y-m-d\TH:i', strtotime( $epl_date ) );
} else {
$epl_date = DateTime::createFromFormat( 'Y-m-d', $epl_date );
if ( $epl_date ) {
$epl_date = $epl_date->format( 'Y-m-d' );
}
}
$_POST[ $field['name'] ] = $epl_date;
}
if ( isset( $_POST[ $field['name'] ] ) ) {
$meta_value = wp_unslash( $_POST[ $field['name'] ] ); // phpcs:ignore
update_post_meta( $post_ID, $field['name'], $meta_value );
}
}
}
}
}
}
}
}
}
}
}
}