| Dir : /home/trave494/v1world.us/wp-content/themes/neve/globals/ |
| Server: Linux ngx353.inmotionhosting.com 4.18.0-553.22.1.lve.1.el8.x86_64 #1 SMP Tue Oct 8 15:52:54 UTC 2024 x86_64 IP: 209.182.202.254 |
| Dir : //home/trave494/v1world.us/wp-content/themes/neve/globals/sanitize-functions.php |
<?php
/**
*
* Sanitize functions.
*
* Author: Andrei Baicus <andrei@themeisle.com>
* Created on: 20/08/2018
*
* @package Neve\Globals
*/
/**
* Function to sanitize alpha color.
*
* @param string $value Hex or RGBA color.
*
* @return string
*/
function neve_sanitize_colors( $value ) {
$is_var = ( strpos( $value, 'var' ) !== false );
if ( $is_var ) {
return sanitize_text_field( $value );
}
// Is this an rgba color or a hex?
$mode = ( false === strpos( $value, 'rgba' ) ) ? 'hex' : 'rgba';
if ( 'rgba' === $mode ) {
return neve_sanitize_rgba( $value );
} else {
return sanitize_hex_color( $value );
}
}
/**
* Sanitize rgba color.
*
* @param string $value Color in rgba format.
*
* @return string
*/
function neve_sanitize_rgba( $value ) {
$red = 'rgba(0,0,0,0)';
$green = 'rgba(0,0,0,0)';
$blue = 'rgba(0,0,0,0)';
$alpha = 'rgba(0,0,0,0)'; // If empty or an array return transparent
if ( empty( $value ) || is_array( $value ) ) {
return '';
}
// By now we know the string is formatted as an rgba color so we need to further sanitize it.
$value = str_replace( ' ', '', $value );
sscanf( $value, 'rgba(%d,%d,%d,%f)', $red, $green, $blue, $alpha );
return 'rgba(' . $red . ',' . $green . ',' . $blue . ',' . $alpha . ')';
}
/**
* Sanitize checkbox output.
*
* @param bool $value value to be sanitized.
*
* @return string
*/
function neve_sanitize_checkbox( $value ) {
return isset( $value ) && true === (bool) $value;
}
/**
* Check if a string is in json format
*
* @param string $string Input.
*
* @return bool
* @since 1.1.38
*/
function neve_is_json( $string ) {
return is_string( $string ) && is_array( json_decode( $string, true ) );
}
/**
* Sanitize values for range inputs.
*
* @param string $input Control input.
*
* @return float
*/
function neve_sanitize_range_value( $input ) {
if ( ! neve_is_json( $input ) ) {
return floatval( $input );
}
$range_value = json_decode( $input, true );
$range_value['desktop'] = isset( $range_value['desktop'] ) && is_numeric( $range_value['desktop'] ) ? floatval( $range_value['desktop'] ) : '';
$range_value['tablet'] = isset( $range_value['tablet'] ) && is_numeric( $range_value['tablet'] ) ? floatval( $range_value['tablet'] ) : '';
$range_value['mobile'] = isset( $range_value['mobile'] ) && is_numeric( $range_value['mobile'] ) ? floatval( $range_value['mobile'] ) : '';
return wp_json_encode( $range_value );
}
/**
* Sanitize font weight values.
*
* @param string $value font-weight value.
*
* @return string
*/
function neve_sanitize_font_weight( $value ) {
$allowed = array( '100', '200', '300', '400', '500', '600', '700', '800', '900' );
if ( ! in_array( (string) $value, $allowed, true ) ) {
return '300';
}
return $value;
}
/**
* Sanitize font weight values.
*
* @param string $value font-weight value.
*
* @return string
*/
function neve_sanitize_text_transform( $value ) {
$allowed = array( 'none', 'capitalize', 'uppercase', 'lowercase' );
if ( ! in_array( $value, $allowed, true ) ) {
return 'none';
}
return $value;
}
/**
* Sanitize the background control.
*
* @param array $value input value.
*
* @return WP_Error | array
*/
function neve_sanitize_background( $value ) {
if ( ! is_array( $value ) ) {
return new WP_Error();
}
if ( ! isset( $value['type'] ) || ! in_array( $value['type'], array( 'image', 'color' ), true ) ) {
return new WP_Error();
}
return $value;
}
/**
* Sanitize the button appearance control.
*
* @param array $value the control value.
*
* @return array
*/
function neve_sanitize_button_appearance( $value ) {
if ( is_array( $value ) ) {
return $value;
}
return $value;
}
/**
* Sanitize the typography control.
*
* @param array $value the control value.
*
* @return array
*/
function neve_sanitize_typography_control( $value ) {
$keys = [
'lineHeight',
'letterSpacing',
'fontWeight',
'fontSize',
'textTransform',
];
// Approve Keys.
foreach ( $value as $key => $values ) {
if ( ! in_array( $key, $keys, true ) ) {
unset( $value[ $key ] );
}
}
// Font Weight.
if ( ! in_array( $value['fontWeight'], [ '100', '200', '300', '400', '500', '600', '700', '800', '900' ], true ) ) {
$value['fontWeight'] = '300';
}
// Text Transform.
if ( ! in_array( $value['textTransform'], [ 'none', 'uppercase', 'lowercase', 'capitalize' ], true ) ) {
$value['textTransform'] = 'none';
}
// Make sure we deal with arrays.
foreach ( [ 'letterSpacing', 'lineHeight', 'fontSize' ] as $value_type ) {
if ( ! is_array( $value[ $value_type ] ) ) {
$value[ $value_type ] = [];
}
}
return $value;
}
/**
* Sanitize alignment.
*
* @param array $input alignment responsive array.
*
* @return array
*/
function neve_sanitize_alignment( $input ) {
$default = [
'mobile' => 'left',
'tablet' => 'left',
'desktop' => 'left',
];
$allowed = [ 'left', 'center', 'right', 'justify' ];
if ( ! is_array( $input ) ) {
return $default;
}
foreach ( $input as $device => $alignment ) {
if ( ! in_array( $alignment, $allowed ) ) {
$input[ $device ] = 'left';
}
}
return $input;
}
/**
* Sanitize position.
*
* @param array $input alignment responsive array.
*
* @return array
*/
function neve_sanitize_position( $input ) {
$default = [
'mobile' => 'center',
'tablet' => 'center',
'desktop' => 'center',
];
$allowed = [ 'flex-start', 'center', 'flex-end' ];
if ( ! is_array( $input ) ) {
return $default;
}
foreach ( $input as $device => $alignment ) {
if ( ! in_array( $alignment, $allowed ) ) {
$input[ $device ] = 'center';
}
}
return $input;
}
/**
* Sanitize meta order control.
*/
function neve_sanitize_meta_ordering( $value ) {
$allowed = array(
'author',
'category',
'date',
'comments',
'reading',
);
if ( empty( $value ) ) {
return $allowed;
}
$decoded = json_decode( $value, true );
foreach ( $decoded as $val ) {
if ( ! in_array( $val, $allowed, true ) ) {
return $allowed;
}
}
return $value;
}
/**
* Sanitize blend mode option.
*
* @param string $input Control input.
*
* @return string
*/
function neve_sanitize_blend_mode( $input ) {
$blend_mode_options = [ 'normal', 'multiply', 'screen', 'overlay', 'darken', 'lighten', 'color-dodge', 'saturation', 'color', 'difference', 'exclusion', 'hue', 'luminosity' ];
if ( ! in_array( $input, $blend_mode_options, true ) ) {
return 'normal';
}
return $input;
}
/**
* Sanitize the container layout value
*
* @param string $value value from the control.
*
* @return bool
*/
function neve_sanitize_container_layout( $value ) {
$allowed_values = array( 'contained', 'full-width' );
if ( ! in_array( $value, $allowed_values, true ) ) {
return 'contained';
}
return esc_html( $value );
}
/**
* Sanitize Button Type option.
*
* @param string $value the control value.
*
* @return string
*/
function neve_sanitize_button_type( $value ) {
if ( ! in_array( $value, [ 'primary', 'secondary' ], true ) ) {
return 'primary';
}
return $value;
}