Edit File by line

<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* Fields Utility

[2] Fix | Delete

[3] Fix | Delete

* @package PUM

[4] Fix | Delete

[5] Fix | Delete

[6] Fix | Delete

[7] Fix | Delete

if ( ! defined( 'ABSPATH' ) ) {

[8] Fix | Delete

exit;

[9] Fix | Delete

}

[10] Fix | Delete

[11] Fix | Delete

/**

[12] Fix | Delete

* Class PUM_Utils_Fields

[13] Fix | Delete

[14] Fix | Delete

class PUM_Utils_Fields {

[15] Fix | Delete

[16] Fix | Delete

/**

[17] Fix | Delete

* @param $fields

[18] Fix | Delete

* @param $field_id

[19] Fix | Delete

[20] Fix | Delete

* @return bool|mixed

[21] Fix | Delete

[22] Fix | Delete

public static function get_field( $fields, $field_id ) {

[23] Fix | Delete

$fields = static::flatten_fields_array( $fields );

[24] Fix | Delete

[25] Fix | Delete

return isset( $fields[ $field_id ] ) ? $fields[ $field_id ] : false;

[26] Fix | Delete

}

[27] Fix | Delete

[28] Fix | Delete

/**

[29] Fix | Delete

* @param array $fields

[30] Fix | Delete

[31] Fix | Delete

* @return array

[32] Fix | Delete

[33] Fix | Delete

public static function get_form_default_values( $fields = [] ) {

[34] Fix | Delete

$fields = static::flatten_fields_array( $fields );

[35] Fix | Delete

[36] Fix | Delete

return static::get_field_default_values( $fields );

[37] Fix | Delete

}

[38] Fix | Delete

[39] Fix | Delete

/**

[40] Fix | Delete

* @param array $fields

[41] Fix | Delete

[42] Fix | Delete

* @return array

[43] Fix | Delete

[44] Fix | Delete

public static function get_field_default_values( $fields = [] ) {

[45] Fix | Delete

$defaults = [];

[46] Fix | Delete

[47] Fix | Delete

foreach ( $fields as $field_id => $field ) {

[48] Fix | Delete

switch ( $field['type'] ) {

[49] Fix | Delete

case 'checkbox':

[50] Fix | Delete

$defaults[ $field_id ] = ! empty( $field['std'] ) ? $field['std'] : false;

[51] Fix | Delete

break;

[52] Fix | Delete

default:

[53] Fix | Delete

$defaults[ $field_id ] = isset( $field['std'] ) ? $field['std'] : null;

[54] Fix | Delete

}

[55] Fix | Delete

}

[56] Fix | Delete

[57] Fix | Delete

return $defaults;

[58] Fix | Delete

}

[59] Fix | Delete

[60] Fix | Delete

/**

[61] Fix | Delete

* @param $tabs

[62] Fix | Delete

[63] Fix | Delete

* @return array

[64] Fix | Delete

[65] Fix | Delete

public static function flatten_fields_array( $tabs ) {

[66] Fix | Delete

$fields = [];

[67] Fix | Delete

[68] Fix | Delete

foreach ( $tabs as $tab_id => $tab_sections ) {

[69] Fix | Delete

[70] Fix | Delete

if ( self::is_field( $tab_sections ) ) {

[71] Fix | Delete

$fields[ $tab_id ] = $tab_sections;

[72] Fix | Delete

continue;

[73] Fix | Delete

} else {

[74] Fix | Delete

foreach ( $tab_sections as $section_id => $section_fields ) {

[75] Fix | Delete

[76] Fix | Delete

if ( self::is_field( $tab_sections ) ) {

[77] Fix | Delete

$fields[ $section_id ] = $section_fields;

[78] Fix | Delete

continue;

[79] Fix | Delete

}

[80] Fix | Delete

[81] Fix | Delete

foreach ( $section_fields as $field_id => $field ) {

[82] Fix | Delete

$fields[ $field_id ] = $field;

[83] Fix | Delete

continue;

[84] Fix | Delete

}

[85] Fix | Delete

}

[86] Fix | Delete

}

[87] Fix | Delete

}

[88] Fix | Delete

[89] Fix | Delete

return $fields;

[90] Fix | Delete

}

[91] Fix | Delete

[92] Fix | Delete

/**

[93] Fix | Delete

* @param $field

[94] Fix | Delete

[95] Fix | Delete

* @return array

[96] Fix | Delete

[97] Fix | Delete

public static function parse_field( $field ) {

[98] Fix | Delete

return wp_parse_args(

[99] Fix | Delete

$field,

[100] Fix | Delete

[

[101] Fix | Delete

'section' => 'main',

[102] Fix | Delete

'type' => 'text',

[103] Fix | Delete

'id' => null,

[104] Fix | Delete

'label' => '',

[105] Fix | Delete

'desc' => '',

[106] Fix | Delete

'name' => null,

[107] Fix | Delete

'templ_name' => null,

[108] Fix | Delete

'size' => 'regular',

[109] Fix | Delete

'options' => [],

[110] Fix | Delete

'std' => null,

[111] Fix | Delete

'rows' => 5,

[112] Fix | Delete

'cols' => 50,

[113] Fix | Delete

'min' => 0,

[114] Fix | Delete

'max' => 50,

[115] Fix | Delete

'force_minmax' => false,

[116] Fix | Delete

'step' => 1,

[117] Fix | Delete

'select2' => null,

[118] Fix | Delete

'object_type' => 'post_type',

[119] Fix | Delete

'object_key' => 'post',

[120] Fix | Delete

'post_type' => null,

[121] Fix | Delete

'taxonomy' => null,

[122] Fix | Delete

'multiple' => null,

[123] Fix | Delete

'as_array' => false,

[124] Fix | Delete

'placeholder' => null,

[125] Fix | Delete

'checkbox_val' => 1,

[126] Fix | Delete

'allow_blank' => true,

[127] Fix | Delete

'readonly' => false,

[128] Fix | Delete

'required' => false,

[129] Fix | Delete

'disabled' => false,

[130] Fix | Delete

'hook' => null,

[131] Fix | Delete

'unit' => __( 'ms', 'popup-maker' ),

[132] Fix | Delete

'desc_position' => 'bottom',

[133] Fix | Delete

'units' => [

[134] Fix | Delete

'px' => 'px',

[135] Fix | Delete

'%' => '%',

[136] Fix | Delete

'em' => 'em',

[137] Fix | Delete

'rem' => 'rem',

[138] Fix | Delete

[139] Fix | Delete

'priority' => 10,

[140] Fix | Delete

'doclink' => '',

[141] Fix | Delete

'button_type' => 'submit',

[142] Fix | Delete

'class' => '',

[143] Fix | Delete

'messages' => [],

[144] Fix | Delete

'license_status' => '',

[145] Fix | Delete

'value' => null,

[146] Fix | Delete

'private' => false,

[147] Fix | Delete

]

[148] Fix | Delete

);

[149] Fix | Delete

}

[150] Fix | Delete

[151] Fix | Delete

/**

[152] Fix | Delete

* @param $fields

[153] Fix | Delete

* @param array $args

[154] Fix | Delete

[155] Fix | Delete

* @return mixed

[156] Fix | Delete

[157] Fix | Delete

public static function parse_tab_fields( $fields, $args = [] ) {

[158] Fix | Delete

$args = wp_parse_args(

[159] Fix | Delete

$args,

[160] Fix | Delete

[

[161] Fix | Delete

'has_sections' => false,

[162] Fix | Delete

'name' => '%s',

[163] Fix | Delete

]

[164] Fix | Delete

);

[165] Fix | Delete

[166] Fix | Delete

if ( $args['has_sections'] ) {

[167] Fix | Delete

foreach ( $fields as $tab_id => $tab_sections ) {

[168] Fix | Delete

foreach ( $tab_sections as $section_id => $section_fields ) {

[169] Fix | Delete

if ( self::is_field( $section_fields ) ) {

[170] Fix | Delete

// Allow for flat tabs with no sections.

[171] Fix | Delete

$section_id = 'main';

[172] Fix | Delete

$section_fields = [

[173] Fix | Delete

$section_id => $section_fields,

[174] Fix | Delete

];

[175] Fix | Delete

}

[176] Fix | Delete

[177] Fix | Delete

$fields[ $tab_id ][ $section_id ] = self::parse_fields( $section_fields, $args['name'] );

[178] Fix | Delete

}

[179] Fix | Delete

}

[180] Fix | Delete

} else {

[181] Fix | Delete

foreach ( $fields as $tab_id => $tab_fields ) {

[182] Fix | Delete

$fields[ $tab_id ] = self::parse_fields( $tab_fields, $args['name'] );

[183] Fix | Delete

}

[184] Fix | Delete

}

[185] Fix | Delete

[186] Fix | Delete

return $fields;

[187] Fix | Delete

}

[188] Fix | Delete

[189] Fix | Delete

/**

[190] Fix | Delete

* @param array $fields

[191] Fix | Delete

* @param string $name

[192] Fix | Delete

[193] Fix | Delete

* @return mixed

[194] Fix | Delete

[195] Fix | Delete

public static function parse_fields( $fields, $name = '%' ) {

[196] Fix | Delete

if ( is_array( $fields ) && ! empty( $fields ) ) {

[197] Fix | Delete

foreach ( $fields as $field_id => $field ) {

[198] Fix | Delete

if ( ! is_array( $field ) || ! self::is_field( $field ) ) {

[199] Fix | Delete

continue;

[200] Fix | Delete

}

[201] Fix | Delete

[202] Fix | Delete

// Remap old settings.

[203] Fix | Delete

if ( is_numeric( $field_id ) && ! empty( $field['id'] ) ) {

[204] Fix | Delete

try {

[205] Fix | Delete

$fields = PUM_Utils_Array::replace_key( $fields, $field_id, $field['id'] );

[206] Fix | Delete

} catch ( Exception $e ) {

[207] Fix | Delete

}

[208] Fix | Delete

[209] Fix | Delete

$field_id = $field['id'];

[210] Fix | Delete

} elseif ( empty( $field['id'] ) && ! is_numeric( $field_id ) ) {

[211] Fix | Delete

$field['id'] = $field_id;

[212] Fix | Delete

}

[213] Fix | Delete

[214] Fix | Delete

if ( empty( $field['name'] ) ) {

[215] Fix | Delete

$field['name'] = sprintf( $name, $field_id );

[216] Fix | Delete

}

[217] Fix | Delete

[218] Fix | Delete

$fields[ $field_id ] = self::parse_field( $field );

[219] Fix | Delete

}

[220] Fix | Delete

}

[221] Fix | Delete

[222] Fix | Delete

$fields = PUM_Utils_Array::sort( $fields, 'priority' );

[223] Fix | Delete

[224] Fix | Delete

return $fields;

[225] Fix | Delete

}

[226] Fix | Delete

[227] Fix | Delete

/**

[228] Fix | Delete

* Checks if an array is a field.

[229] Fix | Delete

[230] Fix | Delete

* @param array $array

[231] Fix | Delete

[232] Fix | Delete

* @return bool

[233] Fix | Delete

[234] Fix | Delete

public static function is_field( $array = [] ) {

[235] Fix | Delete

$field_tests = [

[236] Fix | Delete

! isset( $array['type'] ) && ( isset( $array['label'] ) || isset( $array['desc'] ) ),

[237] Fix | Delete

isset( $array['type'] ) && is_string( $array['type'] ),

[238] Fix | Delete

];

[239] Fix | Delete

[240] Fix | Delete

return in_array( true, $field_tests );

[241] Fix | Delete

}

[242] Fix | Delete

[243] Fix | Delete

/**

[244] Fix | Delete

* Checks if an array is a section.

[245] Fix | Delete

[246] Fix | Delete

* @param array $array

[247] Fix | Delete

[248] Fix | Delete

* @return bool

[249] Fix | Delete

[250] Fix | Delete

public static function is_section( $array = [] ) {

[251] Fix | Delete

return ! self::is_field( $array );

[252] Fix | Delete

}

[253] Fix | Delete

[254] Fix | Delete

/**

[255] Fix | Delete

* @param array $args

[256] Fix | Delete

[257] Fix | Delete

public static function render_field( $args = [] ) {

[258] Fix | Delete

$args = static::parse_field( $args );

[259] Fix | Delete

[260] Fix | Delete

// If no type default to text.

[261] Fix | Delete

$type = ! empty( $args['type'] ) ? $args['type'] : 'text';

[262] Fix | Delete

[263] Fix | Delete

/**

[264] Fix | Delete

* Check if any actions hooked to this type of field and load run those.

[265] Fix | Delete

[266] Fix | Delete

if ( has_action( "pum_{$type}_field" ) ) {

[267] Fix | Delete

do_action( "pum_{$type}_field", $args );

[268] Fix | Delete

} else {

[269] Fix | Delete

if ( method_exists( 'PUM_Form_Fields', $type . '_callback' ) ) {

[270] Fix | Delete

/**

[271] Fix | Delete

* Check if renderer method exists and load that.

[272] Fix | Delete

[273] Fix | Delete

$function_name = [ 'PUM_Form_Fields', $type . '_callback' ];

[274] Fix | Delete

} elseif ( function_exists( "pum_{$type}_callback" ) ) {

[275] Fix | Delete

/**

[276] Fix | Delete

* Check if function exists and load that.

[277] Fix | Delete

[278] Fix | Delete

$function_name = "pum_{$type}_callback";

[279] Fix | Delete

} else {

[280] Fix | Delete

/**

[281] Fix | Delete

* No method exists, lets notify them the field type doesn't exist.

[282] Fix | Delete

[283] Fix | Delete

$function_name = [ 'PUM_Form_Fields', 'missing_callback' ];

[284] Fix | Delete

}

[285] Fix | Delete

[286] Fix | Delete

/**

[287] Fix | Delete

* Call the determined method, passing the field args & $value to the callback.

[288] Fix | Delete

[289] Fix | Delete

call_user_func_array( $function_name, [ $args ] );

[290] Fix | Delete

}

[291] Fix | Delete

}

[292] Fix | Delete

[293] Fix | Delete

/**

[294] Fix | Delete

* @param PUM_Form $form

[295] Fix | Delete

[296] Fix | Delete

public static function render_form_fields( $form ) {

[297] Fix | Delete

[298] Fix | Delete

$tabs = $form->get_tabs();

[299] Fix | Delete

$sections = $form->get_sections();

[300] Fix | Delete

$fields = $form->get_fields();

[301] Fix | Delete

[302] Fix | Delete

if ( $form->has_tabs() ) {

[303] Fix | Delete

if ( $form->has_sections() ) {

[304] Fix | Delete

foreach ( $tabs as $tab_id => $tab_label ) {

[305] Fix | Delete

foreach ( $sections as $section_id => $section_label ) {

[306] Fix | Delete

foreach ( $fields[ $tab_id ][ $section_id ] as $field_id => $field_args ) {

[307] Fix | Delete

static::render_field( $field_args );

[308] Fix | Delete

}

[309] Fix | Delete

}

[310] Fix | Delete

}

[311] Fix | Delete

} else {

[312] Fix | Delete

foreach ( $tabs as $tab_id => $label ) {

[313] Fix | Delete

foreach ( $fields[ $tab_id ] as $field_id => $field_args ) {

[314] Fix | Delete

static::render_field( $field_args );

[315] Fix | Delete

}

[316] Fix | Delete

}

[317] Fix | Delete

}

[318] Fix | Delete

} else {

[319] Fix | Delete

foreach ( $fields as $field_id => $field_args ) {

[320] Fix | Delete

static::render_field( $field_args );

[321] Fix | Delete

}

[322] Fix | Delete

}

[323] Fix | Delete

[324] Fix | Delete

}

[325] Fix | Delete

[326] Fix | Delete

/**

[327] Fix | Delete

* Sanitizes an array of field values.

[328] Fix | Delete

[329] Fix | Delete

* @param $fields

[330] Fix | Delete

* @param $values

[331] Fix | Delete

[332] Fix | Delete

* @return mixed

[333] Fix | Delete

[334] Fix | Delete

public static function sanitize_fields( $values, $fields = [] ) {

[335] Fix | Delete

[336] Fix | Delete

foreach ( $values as $key => $value ) {

[337] Fix | Delete

if ( is_string( $value ) ) {

[338] Fix | Delete

$values[ $key ] = sanitize_text_field( $value );

[339] Fix | Delete

}

[340] Fix | Delete

[341] Fix | Delete

$field = self::get_field( $fields, $key );

[342] Fix | Delete

[343] Fix | Delete

if ( $field ) {

[344] Fix | Delete

$values[ $key ] = self::sanitize_field( $field, $value );

[345] Fix | Delete

}

[346] Fix | Delete

}

[347] Fix | Delete

[348] Fix | Delete

return $values;

[349] Fix | Delete

}

[350] Fix | Delete

[351] Fix | Delete

/**

[352] Fix | Delete

* @param array $args

[353] Fix | Delete

* @param mixed $value

[354] Fix | Delete

* @param array $fields

[355] Fix | Delete

* @param array $values

[356] Fix | Delete

[357] Fix | Delete

* @return mixed|null

[358] Fix | Delete

[359] Fix | Delete

public static function sanitize_field( $args, $value = null, $fields = [], $values = [] ) {

[360] Fix | Delete

[361] Fix | Delete

// If no type default to text.

[362] Fix | Delete

$type = ! empty( $args['type'] ) ? $args['type'] : 'text';

[363] Fix | Delete

[364] Fix | Delete

/**

[365] Fix | Delete

* Check if any actions hooked to this type of field and load run those.

[366] Fix | Delete

[367] Fix | Delete

if ( has_filter( "pum_{$type}_sanitize" ) ) {

[368] Fix | Delete

$value = apply_filters( "pum_{$type}_sanitize", $value, $args, $fields, $values );

[369] Fix | Delete

} else {

[370] Fix | Delete

/**

[371] Fix | Delete

* Check if override or custom function exists and load that.

[372] Fix | Delete

[373] Fix | Delete

if ( function_exists( "pum_{$type}_sanitize" ) ) {

[374] Fix | Delete

$function_name = "pum_{$type}_sanitize";

[375] Fix | Delete

} /**

[376] Fix | Delete

* Check if core method exists and load that.

[377] Fix | Delete

*/ elseif ( method_exists( 'PUM_Utils_Sanitize', $type ) ) {

[378] Fix | Delete

$function_name = [ 'PUM_Utils_Sanitize', $type ];

[379] Fix | Delete

} else {

[380] Fix | Delete

$function_name = null;

[381] Fix | Delete

}

[382] Fix | Delete

[383] Fix | Delete

if ( $function_name ) {

[384] Fix | Delete

/**

[385] Fix | Delete

* Call the determined method, passing the field args & $value to the callback.

[386] Fix | Delete

[387] Fix | Delete

$value = call_user_func_array( $function_name, [ $value, $args, $fields, $values ] );

[388] Fix | Delete

}

[389] Fix | Delete

}

[390] Fix | Delete

[391] Fix | Delete

$value = apply_filters( 'pum_settings_sanitize', $value, $args, $fields, $values );

[392] Fix | Delete

[393] Fix | Delete

return $value;

[394] Fix | Delete

}

[395] Fix | Delete

}

[396] Fix | Delete

[397] Fix | Delete