PHP Classes

File: admin/options-framework/inc/class-options-sanitization.php

Recommend this page to a friend!
  Classes of Joko Prasetyo   kciaotime WordPress Theme   admin/options-framework/inc/class-options-sanitization.php   Download  
File: admin/options-framework/inc/class-options-sanitization.php
Role: Auxiliary script
Content type: text/plain
Description: Auxiliary script
Class: kciaotime WordPress Theme
WordPress theme to customize different page parts
Author: By
Last change:
Date: 1 year ago
Size: 11,884 bytes
 

Contents

Class file image Download
<?php /** * @package Options_Framework * @author Devin Price <devin@wptheming.com> * @license GPL-2.0+ * @link http://wptheming.com * @copyright 2010-2014 WP Theming */ /** * Sanitization for text input * * @link http://developer.wordpress.org/reference/functions/sanitize_text_field/ */ add_filter( 'of_sanitize_text', 'sanitize_text_field' ); /** * Sanitization for password input * * @link http://developer.wordpress.org/reference/functions/sanitize_text_field/ */ add_filter( 'of_sanitize_password', 'sanitize_text_field' ); /** * Sanitization for select input * * Validates that the selected option is a valid option. */ add_filter( 'of_sanitize_select', 'of_sanitize_enum', 10, 2 ); /** * Sanitization for radio input * * Validates that the selected option is a valid option. */ add_filter( 'of_sanitize_radio', 'of_sanitize_enum', 10, 2 ); /** * Sanitization for image selector * * Validates that the selected option is a valid option. */ add_filter( 'of_sanitize_images', 'of_sanitize_enum', 10, 2 ); /** * Sanitization for textarea field * * @param $input string * @return $output sanitized string */ function of_sanitize_textarea( $input ) { global $allowedposttags; $output = wp_kses( $input, $allowedposttags ); return $output; } add_filter( 'of_sanitize_textarea', 'of_sanitize_textarea' ); /** * Sanitization for checkbox input * * @param $input string (1 or empty) checkbox state * @return $output '1' or false */ function of_sanitize_checkbox( $input ) { if ( $input ) { $output = '1'; } else { $output = false; } return $output; } add_filter( 'of_sanitize_checkbox', 'of_sanitize_checkbox' ); /** * Sanitization for multicheck * * @param array of checkbox values * @return array of sanitized values ('1' or false) */ function of_sanitize_multicheck( $input, $option ) { $output = ''; if ( is_array( $input ) ) { foreach( $option['options'] as $key => $value ) { $output[$key] = false; } foreach( $input as $key => $value ) { if ( array_key_exists( $key, $option['options'] ) && $value ) { $output[$key] = '1'; } } } return $output; } add_filter( 'of_sanitize_multicheck', 'of_sanitize_multicheck', 10, 2 ); /** * File upload sanitization. * * Returns a sanitized filepath if it has a valid extension. * * @param string $input filepath * @returns string $output filepath */ function of_sanitize_upload( $input ) { $output = ''; $filetype = wp_check_filetype( $input ); if ( $filetype["ext"] ) { $output = esc_url( $input ); } return $output; } add_filter( 'of_sanitize_upload', 'of_sanitize_upload' ); /** * Sanitization for editor input. * * Returns unfiltered HTML if user has permissions. * * @param string $input * @returns string $output */ function of_sanitize_editor( $input ) { if ( current_user_can( 'unfiltered_html' ) ) { $output = $input; } else { global $allowedposttags; $output = wpautop( wp_kses( $input, $allowedposttags ) ); } return $output; } add_filter( 'of_sanitize_editor', 'of_sanitize_editor' ); /** * Sanitization of input with allowed tags and wpautotop. * * Allows allowed tags in html input and ensures tags close properly. * * @param string $input * @returns string $output */ function of_sanitize_allowedtags( $input ) { global $allowedtags; $output = wpautop( wp_kses( $input, $allowedtags ) ); return $output; } /** * Sanitization of input with allowed post tags and wpautotop. * * Allows allowed post tags in html input and ensures tags close properly. * * @param string $input * @returns string $output */ function of_sanitize_allowedposttags( $input ) { global $allowedposttags; $output = wpautop( wp_kses( $input, $allowedposttags) ); return $output; } /** * Validates that the $input is one of the avilable choices * for that specific option. * * @param string $input * @returns string $output */ function of_sanitize_enum( $input, $option ) { $output = ''; if ( array_key_exists( $input, $option['options'] ) ) { $output = $input; } return $output; } /** * Sanitization for background option. * * @returns array $output */ function of_sanitize_background( $input ) { $output = wp_parse_args( $input, array( 'color' => '', 'image' => '', 'repeat' => 'repeat', 'position' => 'top center', 'attachment' => 'scroll' ) ); $output['color'] = apply_filters( 'of_sanitize_hex', $input['color'] ); $output['image'] = apply_filters( 'of_sanitize_upload', $input['image'] ); $output['repeat'] = apply_filters( 'of_background_repeat', $input['repeat'] ); $output['position'] = apply_filters( 'of_background_position', $input['position'] ); $output['attachment'] = apply_filters( 'of_background_attachment', $input['attachment'] ); return $output; } add_filter( 'of_sanitize_background', 'of_sanitize_background' ); /** * Sanitization for background repeat * * @returns string $value if it is valid */ function of_sanitize_background_repeat( $value ) { $recognized = of_recognized_background_repeat(); if ( array_key_exists( $value, $recognized ) ) { return $value; } return apply_filters( 'of_default_background_repeat', current( $recognized ) ); } add_filter( 'of_background_repeat', 'of_sanitize_background_repeat' ); /** * Sanitization for background position * * @returns string $value if it is valid */ function of_sanitize_background_position( $value ) { $recognized = of_recognized_background_position(); if ( array_key_exists( $value, $recognized ) ) { return $value; } return apply_filters( 'of_default_background_position', current( $recognized ) ); } add_filter( 'of_background_position', 'of_sanitize_background_position' ); /** * Sanitization for background attachment * * @returns string $value if it is valid */ function of_sanitize_background_attachment( $value ) { $recognized = of_recognized_background_attachment(); if ( array_key_exists( $value, $recognized ) ) { return $value; } return apply_filters( 'of_default_background_attachment', current( $recognized ) ); } add_filter( 'of_background_attachment', 'of_sanitize_background_attachment' ); /** * Sanitization for typography option. */ function of_sanitize_typography( $input, $option ) { $output = wp_parse_args( $input, array( 'size' => '', 'face' => '', 'style' => '', 'color' => '' ) ); if ( isset( $option['options']['faces'] ) && isset( $input['face'] ) ) { if ( !( array_key_exists( $input['face'], $option['options']['faces'] ) ) ) { $output['face'] = ''; } } else { $output['face'] = apply_filters( 'of_font_face', $output['face'] ); } $output['size'] = apply_filters( 'of_font_size', $output['size'] ); $output['style'] = apply_filters( 'of_font_style', $output['style'] ); $output['color'] = apply_filters( 'of_sanitize_color', $output['color'] ); return $output; } add_filter( 'of_sanitize_typography', 'of_sanitize_typography', 10, 2 ); /** * Sanitization for font size */ function of_sanitize_font_size( $value ) { $recognized = of_recognized_font_sizes(); $value_check = preg_replace('/px/','', $value); if ( in_array( (int) $value_check, $recognized ) ) { return $value; } return apply_filters( 'of_default_font_size', $recognized ); } add_filter( 'of_font_size', 'of_sanitize_font_size' ); /** * Sanitization for font style */ function of_sanitize_font_style( $value ) { $recognized = of_recognized_font_styles(); if ( array_key_exists( $value, $recognized ) ) { return $value; } return apply_filters( 'of_default_font_style', current( $recognized ) ); } add_filter( 'of_font_style', 'of_sanitize_font_style' ); /** * Sanitization for font face */ function of_sanitize_font_face( $value ) { $recognized = of_recognized_font_faces(); if ( array_key_exists( $value, $recognized ) ) { return $value; } return apply_filters( 'of_default_font_face', current( $recognized ) ); } add_filter( 'of_font_face', 'of_sanitize_font_face' ); /** * Get recognized background repeat settings * * @return array */ function of_recognized_background_repeat() { $default = array( 'no-repeat' => __( 'No Repeat', 'kciao' ), 'repeat-x' => __( 'Repeat Horizontally', 'kciao' ), 'repeat-y' => __( 'Repeat Vertically', 'kciao' ), 'repeat' => __( 'Repeat All', 'kciao' ), ); return apply_filters( 'of_recognized_background_repeat', $default ); } /** * Get recognized background positions * * @return array */ function of_recognized_background_position() { $default = array( 'top left' => __( 'Top Left', 'kciao' ), 'top center' => __( 'Top Center', 'kciao' ), 'top right' => __( 'Top Right', 'kciao' ), 'center left' => __( 'Middle Left', 'kciao' ), 'center center' => __( 'Middle Center', 'kciao' ), 'center right' => __( 'Middle Right', 'kciao' ), 'bottom left' => __( 'Bottom Left', 'kciao' ), 'bottom center' => __( 'Bottom Center', 'kciao' ), 'bottom right' => __( 'Bottom Right', 'kciao') ); return apply_filters( 'of_recognized_background_position', $default ); } /** * Get recognized background attachment * * @return array */ function of_recognized_background_attachment() { $default = array( 'scroll' => __( 'Scroll Normally', 'kciao' ), 'fixed' => __( 'Fixed in Place', 'kciao' ) ); return apply_filters( 'of_recognized_background_attachment', $default ); } /** * Sanitize a color represented in hexidecimal notation. * * @param string Color in hexidecimal notation. "#" may or may not be prepended to the string. * @param string The value that this function should return if it cannot be recognized as a color. * @return string */ function of_sanitize_hex( $hex, $default = '' ) { if ( of_validate_hex( $hex ) ) { return $hex; } return $default; } add_filter( 'of_sanitize_color', 'of_sanitize_hex' ); /** * Get recognized font sizes. * * Returns an indexed array of all recognized font sizes. * Values are integers and represent a range of sizes from * smallest to largest. * * @return array */ function of_recognized_font_sizes() { $sizes = range( 9, 71 ); $sizes = apply_filters( 'of_recognized_font_sizes', $sizes ); $sizes = array_map( 'absint', $sizes ); return $sizes; } /** * Get recognized font faces. * * Returns an array of all recognized font faces. * Keys are intended to be stored in the database * while values are ready for display in in html. * * @return array */ function of_recognized_font_faces() { $default = array( 'arial' => 'Arial', 'verdana' => 'Verdana, Geneva', 'trebuchet' => 'Trebuchet', 'georgia' => 'Georgia', 'times' => 'Times New Roman', 'tahoma' => 'Tahoma, Geneva', 'palatino' => 'Palatino', 'helvetica' => 'Helvetica*' ); return apply_filters( 'of_recognized_font_faces', $default ); } /** * Get recognized font styles. * * Returns an array of all recognized font styles. * Keys are intended to be stored in the database * while values are ready for display in in html. * * @return array */ function of_recognized_font_styles() { $default = array( 'normal' => __( 'Normal', 'kciao' ), 'italic' => __( 'Italic', 'kciao' ), 'bold' => __( 'Bold', 'kciao' ), 'bold italic' => __( 'Bold Italic', 'kciao' ) ); return apply_filters( 'of_recognized_font_styles', $default ); } /** * Is a given string a color formatted in hexidecimal notation? * * @param string Color in hexidecimal notation. "#" may or may not be prepended to the string. * @return bool */ function of_validate_hex( $hex ) { $hex = trim( $hex ); /* Strip recognized prefixes. */ if ( 0 === strpos( $hex, '#' ) ) { $hex = substr( $hex, 1 ); } elseif ( 0 === strpos( $hex, '%23' ) ) { $hex = substr( $hex, 3 ); } /* Regex match. */ if ( 0 === preg_match( '/^[0-9a-fA-F]{6}$/', $hex ) ) { return false; } else { return true; } }