2013-07-26 14:36:28 +00:00
< ? php
/**
2015-11-03 13:53:50 +00:00
* WooCommerce Admin Settings Class
2013-07-26 14:36:28 +00:00
*
2017-11-09 12:57:54 +00:00
* @ author Automattic
2015-05-15 19:12:11 +00:00
* @ category Admin
* @ package WooCommerce / Admin
2017-11-09 12:57:54 +00:00
* @ version 3.3 . 0
2013-07-26 14:36:28 +00:00
*/
2014-09-12 00:40:30 +00:00
if ( ! defined ( 'ABSPATH' ) ) {
2016-03-04 09:41:31 +00:00
exit ;
2014-09-12 00:40:30 +00:00
}
2013-07-26 14:36:28 +00:00
2017-02-16 11:46:01 +00:00
if ( ! class_exists ( 'WC_Admin_Settings' , false ) ) :
2013-07-26 14:36:28 +00:00
2016-01-05 15:37:28 +00:00
/**
2017-11-09 12:57:54 +00:00
* WC_Admin_Settings Class .
2016-01-05 15:37:28 +00:00
*/
2017-11-09 12:57:54 +00:00
class WC_Admin_Settings {
/**
* Setting pages .
*
* @ var array
*/
private static $settings = array ();
/**
* Error messages .
*
* @ var array
*/
private static $errors = array ();
/**
* Update messages .
*
* @ var array
*/
private static $messages = array ();
/**
* Include the settings page classes .
*/
public static function get_settings_pages () {
if ( empty ( self :: $settings ) ) {
$settings = array ();
include_once ( dirname ( __FILE__ ) . '/settings/class-wc-settings-page.php' );
$settings [] = include ( 'settings/class-wc-settings-general.php' );
$settings [] = include ( 'settings/class-wc-settings-products.php' );
$settings [] = include ( 'settings/class-wc-settings-tax.php' );
$settings [] = include ( 'settings/class-wc-settings-shipping.php' );
$settings [] = include ( 'settings/class-wc-settings-checkout.php' );
$settings [] = include ( 'settings/class-wc-settings-accounts.php' );
$settings [] = include ( 'settings/class-wc-settings-emails.php' );
$settings [] = include ( 'settings/class-wc-settings-integrations.php' );
2017-11-09 13:00:11 +00:00
$settings [] = include ( 'settings/class-wc-settings-rest-api.php' );
2017-11-09 12:57:54 +00:00
self :: $settings = apply_filters ( 'woocommerce_get_settings_pages' , $settings );
}
2013-07-26 14:36:28 +00:00
2017-11-09 12:57:54 +00:00
return self :: $settings ;
2014-01-03 14:13:07 +00:00
}
2014-09-12 00:40:30 +00:00
2017-11-09 12:57:54 +00:00
/**
* Save the settings .
*/
public static function save () {
global $current_tab ;
2013-07-26 14:36:28 +00:00
2017-11-09 12:57:54 +00:00
check_admin_referer ( 'woocommerce-settings' );
2013-07-26 14:36:28 +00:00
2017-11-09 12:57:54 +00:00
// Trigger actions.
do_action ( 'woocommerce_settings_save_' . $current_tab );
do_action ( 'woocommerce_update_options_' . $current_tab );
do_action ( 'woocommerce_update_options' );
2013-07-26 14:36:28 +00:00
2017-11-09 12:57:54 +00:00
self :: add_message ( __ ( 'Your settings have been saved.' , 'woocommerce' ) );
self :: check_download_folder_protection ();
2013-07-26 14:36:28 +00:00
2017-11-09 12:57:54 +00:00
// Clear any unwanted data and flush rules.
2017-12-07 20:21:52 +00:00
add_option ( 'woocommerce_queue_flush_rewrite_rules' , 'true' );
2017-11-09 12:57:54 +00:00
WC () -> query -> init_query_vars ();
WC () -> query -> add_endpoints ();
2013-09-03 15:14:56 +00:00
2017-11-09 12:57:54 +00:00
do_action ( 'woocommerce_settings_saved' );
}
2013-07-26 14:36:28 +00:00
2017-11-09 12:57:54 +00:00
/**
* Add a message .
*
* @ param string $text Message .
*/
public static function add_message ( $text ) {
self :: $messages [] = $text ;
}
2013-07-26 14:36:28 +00:00
2017-11-09 12:57:54 +00:00
/**
* Add an error .
*
* @ param string $text Message .
*/
public static function add_error ( $text ) {
self :: $errors [] = $text ;
}
2013-07-26 14:36:28 +00:00
2017-11-09 12:57:54 +00:00
/**
* Output messages + errors .
*/
public static function show_messages () {
if ( count ( self :: $errors ) > 0 ) {
foreach ( self :: $errors as $error ) {
echo '<div id="message" class="error inline"><p><strong>' . esc_html ( $error ) . '</strong></p></div>' ;
}
} elseif ( count ( self :: $messages ) > 0 ) {
foreach ( self :: $messages as $message ) {
echo '<div id="message" class="updated inline"><p><strong>' . esc_html ( $message ) . '</strong></p></div>' ;
}
2014-09-12 00:40:30 +00:00
}
2013-07-26 14:36:28 +00:00
}
2017-11-09 12:57:54 +00:00
/**
* Settings page .
*
* Handles the display of the main woocommerce settings page in admin .
*/
public static function output () {
global $current_section , $current_tab ;
2013-07-26 14:36:28 +00:00
2017-11-09 12:57:54 +00:00
$suffix = defined ( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ? '' : '.min' ;
2014-11-13 08:57:09 +00:00
2017-11-09 12:57:54 +00:00
do_action ( 'woocommerce_settings_start' );
2013-07-26 14:36:28 +00:00
2017-11-09 12:57:54 +00:00
wp_enqueue_script ( 'woocommerce_settings' , WC () -> plugin_url () . '/assets/js/admin/settings' . $suffix . '.js' , array ( 'jquery' , 'jquery-ui-datepicker' , 'jquery-ui-sortable' , 'iris' , 'selectWoo' ), WC () -> version , true );
2013-07-26 14:36:28 +00:00
2017-11-09 12:57:54 +00:00
wp_localize_script ( 'woocommerce_settings' , 'woocommerce_settings_params' , array (
'i18n_nav_warning' => __ ( 'The changes you made will be lost if you navigate away from this page.' , 'woocommerce' ),
) );
2013-07-26 14:36:28 +00:00
2017-11-09 12:57:54 +00:00
// Get tabs for the settings page.
$tabs = apply_filters ( 'woocommerce_settings_tabs_array' , array () );
2013-07-26 14:36:28 +00:00
2017-11-09 12:57:54 +00:00
include ( dirname ( __FILE__ ) . '/views/html-admin-settings.php' );
}
2013-07-26 14:36:28 +00:00
2017-11-09 12:57:54 +00:00
/**
* Get a setting from the settings API .
*
* @ param string $option_name Option name .
* @ param mixed $default Default value .
* @ return mixed
*/
public static function get_option ( $option_name , $default = '' ) {
// Array value.
if ( strstr ( $option_name , '[' ) ) {
2013-07-26 14:36:28 +00:00
2017-11-09 12:57:54 +00:00
parse_str ( $option_name , $option_array );
2013-07-26 14:36:28 +00:00
2017-11-09 12:57:54 +00:00
// Option name is first key.
$option_name = current ( array_keys ( $option_array ) );
2013-07-26 14:36:28 +00:00
2017-11-09 12:57:54 +00:00
// Get value.
$option_values = get_option ( $option_name , '' );
2013-07-26 14:36:28 +00:00
2017-11-09 12:57:54 +00:00
$key = key ( $option_array [ $option_name ] );
2013-07-26 14:36:28 +00:00
2017-11-09 12:57:54 +00:00
if ( isset ( $option_values [ $key ] ) ) {
$option_value = $option_values [ $key ];
} else {
$option_value = null ;
}
2014-09-12 00:40:30 +00:00
} else {
2017-11-09 12:57:54 +00:00
// Single value.
$option_value = get_option ( $option_name , null );
2014-09-12 00:40:30 +00:00
}
2013-07-26 14:36:28 +00:00
2017-11-09 12:57:54 +00:00
if ( is_array ( $option_value ) ) {
$option_value = array_map ( 'stripslashes' , $option_value );
} elseif ( ! is_null ( $option_value ) ) {
$option_value = stripslashes ( $option_value );
}
2013-07-26 14:36:28 +00:00
2017-11-09 12:57:54 +00:00
return ( null === $option_value ) ? $default : $option_value ;
2014-09-12 00:40:30 +00:00
}
2013-07-26 14:36:28 +00:00
2017-11-09 12:57:54 +00:00
/**
* Output admin fields .
*
* Loops though the woocommerce options array and outputs each field .
*
2017-12-07 20:21:52 +00:00
* @ param array [] $options Opens array to output .
2017-11-09 12:57:54 +00:00
*/
public static function output_fields ( $options ) {
foreach ( $options as $value ) {
if ( ! isset ( $value [ 'type' ] ) ) {
continue ;
}
if ( ! isset ( $value [ 'id' ] ) ) {
$value [ 'id' ] = '' ;
}
if ( ! isset ( $value [ 'title' ] ) ) {
$value [ 'title' ] = isset ( $value [ 'name' ] ) ? $value [ 'name' ] : '' ;
}
if ( ! isset ( $value [ 'class' ] ) ) {
$value [ 'class' ] = '' ;
}
if ( ! isset ( $value [ 'css' ] ) ) {
$value [ 'css' ] = '' ;
}
if ( ! isset ( $value [ 'default' ] ) ) {
$value [ 'default' ] = '' ;
}
if ( ! isset ( $value [ 'desc' ] ) ) {
$value [ 'desc' ] = '' ;
}
if ( ! isset ( $value [ 'desc_tip' ] ) ) {
$value [ 'desc_tip' ] = false ;
}
if ( ! isset ( $value [ 'placeholder' ] ) ) {
$value [ 'placeholder' ] = '' ;
}
2017-11-16 14:20:22 +00:00
if ( ! isset ( $value [ 'suffix' ] ) ) {
$value [ 'suffix' ] = '' ;
}
2014-09-12 00:40:30 +00:00
2017-11-09 12:57:54 +00:00
// Custom attribute handling.
$custom_attributes = array ();
2013-07-26 14:36:28 +00:00
2017-11-09 12:57:54 +00:00
if ( ! empty ( $value [ 'custom_attributes' ] ) && is_array ( $value [ 'custom_attributes' ] ) ) {
foreach ( $value [ 'custom_attributes' ] as $attribute => $attribute_value ) {
$custom_attributes [] = esc_attr ( $attribute ) . '="' . esc_attr ( $attribute_value ) . '"' ;
}
2014-09-12 00:40:30 +00:00
}
2013-07-26 14:36:28 +00:00
2017-11-09 12:57:54 +00:00
// Description handling.
$field_description = self :: get_field_description ( $value );
$description = $field_description [ 'description' ];
$tooltip_html = $field_description [ 'tooltip_html' ];
// Switch based on type.
switch ( $value [ 'type' ] ) {
// Section Titles.
case 'title' :
if ( ! empty ( $value [ 'title' ] ) ) {
echo '<h2>' . esc_html ( $value [ 'title' ] ) . '</h2>' ;
}
if ( ! empty ( $value [ 'desc' ] ) ) {
echo wp_kses_post ( wpautop ( wptexturize ( $value [ 'desc' ] ) ) );
}
echo '<table class="form-table">' . " \n \n " ;
if ( ! empty ( $value [ 'id' ] ) ) {
do_action ( 'woocommerce_settings_' . sanitize_title ( $value [ 'id' ] ) );
}
break ;
2013-07-26 14:36:28 +00:00
2017-11-09 12:57:54 +00:00
// Section Ends.
case 'sectionend' :
if ( ! empty ( $value [ 'id' ] ) ) {
do_action ( 'woocommerce_settings_' . sanitize_title ( $value [ 'id' ] ) . '_end' );
}
echo '</table>' ;
if ( ! empty ( $value [ 'id' ] ) ) {
do_action ( 'woocommerce_settings_' . sanitize_title ( $value [ 'id' ] ) . '_after' );
}
break ;
2014-09-12 00:40:30 +00:00
2017-11-09 12:57:54 +00:00
// Standard text inputs and subtypes like 'number'.
case 'text' :
case 'email' :
case 'number' :
case 'password' :
$option_value = self :: get_option ( $value [ 'id' ], $value [ 'default' ] );
?> <tr valign="top">
< th scope = " row " class = " titledesc " >
< label for = " <?php echo esc_attr( $value['id'] ); ?> " >< ? php echo esc_html ( $value [ 'title' ] ); ?> </label>
< ? php echo $tooltip_html ; // WPCS: XSS ok. ?>
</ th >
< td class = " forminp forminp-<?php echo esc_attr( sanitize_title( $value['type'] ) ); ?> " >
< input
name = " <?php echo esc_attr( $value['id'] ); ?> "
id = " <?php echo esc_attr( $value['id'] ); ?> "
type = " <?php echo esc_attr( $value['type'] ); ?> "
style = " <?php echo esc_attr( $value['css'] ); ?> "
value = " <?php echo esc_attr( $option_value ); ?> "
class = " <?php echo esc_attr( $value['class'] ); ?> "
placeholder = " <?php echo esc_attr( $value['placeholder'] ); ?> "
< ? php echo implode ( ' ' , $custom_attributes ); // WPCS: XSS ok. ?>
2017-11-16 14:20:22 +00:00
/>< ? php echo esc_html ( $value [ 'suffix' ] ); ?> <?php echo $description; // WPCS: XSS ok. ?>
2017-11-09 12:57:54 +00:00
</ td >
</ tr >
< ? php
break ;
2014-09-12 00:40:30 +00:00
2017-11-09 12:57:54 +00:00
// Color picker.
case 'color' :
$option_value = self :: get_option ( $value [ 'id' ], $value [ 'default' ] );
?>
< tr valign = " top " >
< th scope = " row " class = " titledesc " >
< label for = " <?php echo esc_attr( $value['id'] ); ?> " >< ? php echo esc_html ( $value [ 'title' ] ); ?> </label>
< ? php echo $tooltip_html ; // WPCS: XSS ok. ?>
</ th >
< td class = " forminp forminp-<?php echo esc_attr( sanitize_title( $value['type'] ) ); ?> " >& lrm ;
< span class = " colorpickpreview " style = " background: <?php echo esc_attr( $option_value ); ?> " ></ span >
< input
name = " <?php echo esc_attr( $value['id'] ); ?> "
id = " <?php echo esc_attr( $value['id'] ); ?> "
type = " text "
dir = " ltr "
style = " <?php echo esc_attr( $value['css'] ); ?> "
value = " <?php echo esc_attr( $option_value ); ?> "
class = " <?php echo esc_attr( $value['class'] ); ?>colorpick "
placeholder = " <?php echo esc_attr( $value['placeholder'] ); ?> "
< ? php echo implode ( ' ' , $custom_attributes ); // WPCS: XSS ok. ?>
/>& lrm ; < ? php echo $description ; // WPCS: XSS ok. ?>
< div id = " colorPickerDiv_<?php echo esc_attr( $value['id'] ); ?> " class = " colorpickdiv " style = " z-index: 100;background:#eee;border:1px solid #ccc;position:absolute;display:none; " ></ div >
</ td >
</ tr >
< ? php
break ;
// Textarea.
case 'textarea' :
$option_value = self :: get_option ( $value [ 'id' ], $value [ 'default' ] );
?>
< tr valign = " top " >
< th scope = " row " class = " titledesc " >
< label for = " <?php echo esc_attr( $value['id'] ); ?> " >< ? php echo esc_html ( $value [ 'title' ] ); ?> </label>
< ? php echo $tooltip_html ; // WPCS: XSS ok. ?>
</ th >
< td class = " forminp forminp-<?php echo esc_attr( sanitize_title( $value['type'] ) ); ?> " >
< ? php echo $description ; // WPCS: XSS ok. ?>
< textarea
name = " <?php echo esc_attr( $value['id'] ); ?> "
id = " <?php echo esc_attr( $value['id'] ); ?> "
style = " <?php echo esc_attr( $value['css'] ); ?> "
class = " <?php echo esc_attr( $value['class'] ); ?> "
placeholder = " <?php echo esc_attr( $value['placeholder'] ); ?> "
< ? php echo implode ( ' ' , $custom_attributes ); // WPCS: XSS ok. ?>
>< ? php echo esc_textarea ( $option_value ); // WPCS: XSS ok. ?></textarea>
</ td >
</ tr >
< ? php
break ;
// Select boxes.
case 'select' :
case 'multiselect' :
$option_value = self :: get_option ( $value [ 'id' ], $value [ 'default' ] );
?>
< tr valign = " top " >
< th scope = " row " class = " titledesc " >
< label for = " <?php echo esc_attr( $value['id'] ); ?> " >< ? php echo esc_html ( $value [ 'title' ] ); ?> </label>
< ? php echo $tooltip_html ; // WPCS: XSS ok. ?>
</ th >
< td class = " forminp forminp-<?php echo esc_attr( sanitize_title( $value['type'] ) ); ?> " >
< select
name = " <?php echo esc_attr( $value['id'] ); ?><?php echo ( 'multiselect' === $value['type'] ) ? '[]' : ''; ?> "
id = " <?php echo esc_attr( $value['id'] ); ?> "
style = " <?php echo esc_attr( $value['css'] ); ?> "
class = " <?php echo esc_attr( $value['class'] ); ?> "
< ? php echo implode ( ' ' , $custom_attributes ); // WPCS: XSS ok. ?>
< ? php echo 'multiselect' === $value [ 'type' ] ? 'multiple="multiple"' : '' ; ?>
>
< ? php
2014-09-12 00:40:30 +00:00
foreach ( $value [ 'options' ] as $key => $val ) {
?>
2017-11-09 12:57:54 +00:00
< option value = " <?php echo esc_attr( $key ); ?> "
< ? php
2014-09-12 00:40:30 +00:00
if ( is_array ( $option_value ) ) {
2017-11-09 12:57:54 +00:00
selected ( in_array ( $key , $option_value , true ), true );
2014-09-12 00:40:30 +00:00
} else {
selected ( $option_value , $key );
}
2017-11-09 12:57:54 +00:00
?>
>
< ? php echo esc_html ( $val ); ?> </option>
2014-09-12 00:40:30 +00:00
< ? php
}
2017-11-09 12:57:54 +00:00
?>
</ select > < ? php echo $description ; // WPCS: XSS ok. ?>
</ td >
</ tr >
< ? php
break ;
// Radio inputs.
case 'radio' :
$option_value = self :: get_option ( $value [ 'id' ], $value [ 'default' ] );
?>
< tr valign = " top " >
< th scope = " row " class = " titledesc " >
< label for = " <?php echo esc_attr( $value['id'] ); ?> " >< ? php echo esc_html ( $value [ 'title' ] ); ?> </label>
< ? php echo $tooltip_html ; // WPCS: XSS ok. ?>
</ th >
< td class = " forminp forminp-<?php echo esc_attr( sanitize_title( $value['type'] ) ); ?> " >
< fieldset >
< ? php echo $description ; // WPCS: XSS ok. ?>
< ul >
< ? php
2014-09-12 00:40:30 +00:00
foreach ( $value [ 'options' ] as $key => $val ) {
?>
< li >
< label >< input
name = " <?php echo esc_attr( $value['id'] ); ?> "
2017-11-09 12:57:54 +00:00
value = " <?php echo esc_attr( $key ); ?> "
2014-09-12 00:40:30 +00:00
type = " radio "
style = " <?php echo esc_attr( $value['css'] ); ?> "
class = " <?php echo esc_attr( $value['class'] ); ?> "
2017-11-09 12:57:54 +00:00
< ? php echo implode ( ' ' , $custom_attributes ); // WPCS: XSS ok. ?>
2014-09-12 00:40:30 +00:00
< ? php checked ( $key , $option_value ); ?>
2017-11-09 12:57:54 +00:00
/> < ? php echo esc_html ( $val ); ?> </label>
2014-09-12 00:40:30 +00:00
</ li >
< ? php
}
2017-11-09 12:57:54 +00:00
?>
</ ul >
</ fieldset >
</ td >
</ tr >
< ? php
break ;
2013-07-26 14:36:28 +00:00
2017-11-09 12:57:54 +00:00
// Checkbox input.
case 'checkbox' :
$option_value = self :: get_option ( $value [ 'id' ], $value [ 'default' ] );
$visibility_class = array ();
if ( ! isset ( $value [ 'hide_if_checked' ] ) ) {
$value [ 'hide_if_checked' ] = false ;
}
if ( ! isset ( $value [ 'show_if_checked' ] ) ) {
$value [ 'show_if_checked' ] = false ;
}
if ( 'yes' === $value [ 'hide_if_checked' ] || 'yes' === $value [ 'show_if_checked' ] ) {
$visibility_class [] = 'hidden_option' ;
}
if ( 'option' === $value [ 'hide_if_checked' ] ) {
$visibility_class [] = 'hide_options_if_checked' ;
}
if ( 'option' === $value [ 'show_if_checked' ] ) {
$visibility_class [] = 'show_options_if_checked' ;
}
if ( ! isset ( $value [ 'checkboxgroup' ] ) || 'start' === $value [ 'checkboxgroup' ] ) {
?>
< tr valign = " top " class = " <?php echo esc_attr( implode( ' ', $visibility_class ) ); ?> " >
< th scope = " row " class = " titledesc " >< ? php echo esc_html ( $value [ 'title' ] ); ?> </th>
< td class = " forminp forminp-checkbox " >
< fieldset >
< ? php
} else {
?>
< fieldset class = " <?php echo esc_attr( implode( ' ', $visibility_class ) ); ?> " >
< ? php
}
if ( ! empty ( $value [ 'title' ] ) ) {
?>
< legend class = " screen-reader-text " >< span >< ? php echo esc_html ( $value [ 'title' ] ); ?> </span></legend>
< ? php
}
2013-07-26 14:36:28 +00:00
2014-09-12 00:40:30 +00:00
?>
2017-11-09 12:57:54 +00:00
< label for = " <?php echo esc_attr( $value['id'] ); ?> " >
< input
name = " <?php echo esc_attr( $value['id'] ); ?> "
id = " <?php echo esc_attr( $value['id'] ); ?> "
type = " checkbox "
class = " <?php echo esc_attr( isset( $value['class'] ) ? $value['class'] : '' ); ?> "
value = " 1 "
< ? php checked ( $option_value , 'yes' ); ?>
< ? php echo implode ( ' ' , $custom_attributes ); // WPCS: XSS ok. ?>
/> < ? php echo $description ; // WPCS: XSS ok. ?>
</ label > < ? php echo $tooltip_html ; // WPCS: XSS ok. ?>
2013-07-26 14:36:28 +00:00
< ? php
2014-09-12 00:40:30 +00:00
2017-11-09 12:57:54 +00:00
if ( ! isset ( $value [ 'checkboxgroup' ] ) || 'end' === $value [ 'checkboxgroup' ] ) {
?>
</ fieldset >
</ td >
</ tr >
< ? php
} else {
?>
</ fieldset >
< ? php
}
break ;
2017-11-16 14:20:22 +00:00
// Image width settings. @todo deprecate and remove in 4.0. No longer needed by core.
2017-11-09 12:57:54 +00:00
case 'image_width' :
$image_size = str_replace ( '_image_size' , '' , $value [ 'id' ] );
$size = wc_get_image_size ( $image_size );
$width = isset ( $size [ 'width' ] ) ? $size [ 'width' ] : $value [ 'default' ][ 'width' ];
$height = isset ( $size [ 'height' ] ) ? $size [ 'height' ] : $value [ 'default' ][ 'height' ];
$crop = isset ( $size [ 'crop' ] ) ? $size [ 'crop' ] : $value [ 'default' ][ 'crop' ];
$disabled_attr = '' ;
$disabled_message = '' ;
if ( has_filter ( 'woocommerce_get_image_size_' . $image_size ) ) {
$disabled_attr = 'disabled="disabled"' ;
$disabled_message = '<p><small>' . esc_html__ ( 'The settings of this image size have been disabled because its values are being overwritten by a filter.' , 'woocommerce' ) . '</small></p>' ;
}
2014-09-12 00:40:30 +00:00
?>
2017-11-09 12:57:54 +00:00
< tr valign = " top " >
< th scope = " row " class = " titledesc " >< ? php echo esc_html ( $value [ 'title' ] ); ?> <?php echo $tooltip_html . $disabled_message; // WPCS: XSS ok. ?></th>
< td class = " forminp image_width_settings " >
< input name = " <?php echo esc_attr( $value['id'] ); ?>[width] " < ? php echo $disabled_attr ; // WPCS: XSS ok. ?> id="<?php echo esc_attr( $value['id'] ); ?>-width" type="text" size="3" value="<?php echo esc_attr( $width ); ?>" /> × <input name="<?php echo esc_attr( $value['id'] ); ?>[height]" <?php echo $disabled_attr; // WPCS: XSS ok. ?> id="<?php echo esc_attr( $value['id'] ); ?>-height" type="text" size="3" value="<?php echo esc_attr( $height ); ?>" />px
< label >< input name = " <?php echo esc_attr( $value['id'] ); ?>[crop] " < ? php echo $disabled_attr ; // WPCS: XSS ok. ?> id="<?php echo esc_attr( $value['id'] ); ?>-crop" type="checkbox" value="1" <?php checked( 1, $crop ); ?> /> <?php esc_html_e( 'Hard crop?', 'woocommerce' ); ?></label>
2014-09-12 00:40:30 +00:00
2014-01-22 15:22:58 +00:00
</ td >
2017-11-09 12:57:54 +00:00
</ tr >
2013-07-26 14:36:28 +00:00
< ? php
2017-11-09 12:57:54 +00:00
break ;
2014-09-12 00:40:30 +00:00
2017-11-09 12:57:54 +00:00
// Single page selects.
case 'single_select_page' :
$args = array (
'name' => $value [ 'id' ],
'id' => $value [ 'id' ],
'sort_column' => 'menu_order' ,
'sort_order' => 'ASC' ,
'show_option_none' => ' ' ,
'class' => $value [ 'class' ],
'echo' => false ,
'selected' => absint ( self :: get_option ( $value [ 'id' ] ) ),
);
if ( isset ( $value [ 'args' ] ) ) {
$args = wp_parse_args ( $value [ 'args' ], $args );
}
2014-09-12 00:40:30 +00:00
2017-11-09 12:57:54 +00:00
?>
< tr valign = " top " class = " single_select_page " >
< th scope = " row " class = " titledesc " >< ? php echo esc_html ( $value [ 'title' ] ); ?> <?php echo $tooltip_html; // WPCS: XSS ok. ?></th>
< td class = " forminp " >
< ? php echo str_replace ( ' id=' , " data-placeholder=' " . esc_attr__ ( 'Select a page…' , 'woocommerce' ) . " ' style=' " . $value [ 'css' ] . " ' class=' " . $value [ 'class' ] . " ' id= " , wp_dropdown_pages ( $args ) ); // WPCS: XSS ok. ?> <?php echo $description; // WPCS: XSS ok. ?>
</ td >
</ tr >
< ? php
break ;
2014-09-12 00:40:30 +00:00
2017-11-09 12:57:54 +00:00
// Single country selects.
case 'single_select_country' :
$country_setting = ( string ) self :: get_option ( $value [ 'id' ] );
if ( strstr ( $country_setting , ':' ) ) {
$country_setting = explode ( ':' , $country_setting );
$country = current ( $country_setting );
$state = end ( $country_setting );
} else {
$country = $country_setting ;
$state = '*' ;
}
?>
< tr valign = " top " >
< th scope = " row " class = " titledesc " >
< label for = " <?php echo esc_attr( $value['id'] ); ?> " >< ? php echo esc_html ( $value [ 'title' ] ); ?> </label>
< ? php echo $tooltip_html ; // WPCS: XSS ok. ?>
</ th >
< td class = " forminp " >< select name = " <?php echo esc_attr( $value['id'] ); ?> " style = " <?php echo esc_attr( $value['css'] ); ?> " data - placeholder = " <?php esc_attr_e( 'Choose a country…', 'woocommerce' ); ?> " aria - label = " <?php esc_attr_e( 'Country', 'woocommerce' ); ?> " class = " wc-enhanced-select " >
< ? php WC () -> countries -> country_dropdown_options ( $country , $state ); ?>
</ select > < ? php echo $description ; // WPCS: XSS ok. ?>
2014-09-12 00:40:30 +00:00
</ td >
2017-11-09 12:57:54 +00:00
</ tr >
< ? php
break ;
2014-09-12 00:40:30 +00:00
2017-11-09 12:57:54 +00:00
// Country multiselects.
case 'multi_select_countries' :
$selections = ( array ) self :: get_option ( $value [ 'id' ] );
if ( ! empty ( $value [ 'options' ] ) ) {
$countries = $value [ 'options' ];
} else {
$countries = WC () -> countries -> countries ;
}
2013-08-02 15:54:28 +00:00
2017-11-09 12:57:54 +00:00
asort ( $countries );
?>
< tr valign = " top " >
< th scope = " row " class = " titledesc " >
< label for = " <?php echo esc_attr( $value['id'] ); ?> " >< ? php echo esc_html ( $value [ 'title' ] ); ?> </label>
< ? php echo $tooltip_html ; // WPCS: XSS ok. ?>
</ th >
< td class = " forminp " >
< select multiple = " multiple " name = " <?php echo esc_attr( $value['id'] ); ?>[] " style = " width:350px " data - placeholder = " <?php esc_attr_e( 'Choose countries…', 'woocommerce' ); ?> " aria - label = " <?php esc_attr_e( 'Country', 'woocommerce' ); ?> " class = " wc-enhanced-select " >
< ? php
2015-04-01 13:33:56 +00:00
if ( ! empty ( $countries ) ) {
2014-09-12 00:40:30 +00:00
foreach ( $countries as $key => $val ) {
2017-11-09 12:57:54 +00:00
echo '<option value="' . esc_attr ( $key ) . '" ' . selected ( in_array ( $key , $selections , true ), true , false ) . '>' . esc_html ( $val ) . '</option>' ;
2014-09-12 00:40:30 +00:00
}
}
2017-11-09 12:57:54 +00:00
?>
</ select > < ? php echo ( $description ) ? $description : '' ; // WPCS: XSS ok. ?> <br /><a class="select_all button" href="#"><?php esc_html_e( 'Select all', 'woocommerce' ); ?></a> <a class="select_none button" href="#"><?php esc_html_e( 'Select none', 'woocommerce' ); ?></a>
</ td >
</ tr >
< ? php
break ;
2014-10-17 15:24:21 +00:00
2017-11-09 12:57:54 +00:00
// Default: run an action.
default :
do_action ( 'woocommerce_admin_field_' . $value [ 'type' ], $value );
break ;
}
}
2014-09-23 22:27:15 +00:00
}
2017-11-09 12:57:54 +00:00
/**
* Helper function to get the formatted description and tip HTML for a
* given form field . Plugins can call this when implementing their own custom
* settings types .
*
* @ param array $value The form field value array .
* @ return array The description and tip as a 2 element array .
*/
public static function get_field_description ( $value ) {
$description = '' ;
$tooltip_html = '' ;
if ( true === $value [ 'desc_tip' ] ) {
$tooltip_html = $value [ 'desc' ];
} elseif ( ! empty ( $value [ 'desc_tip' ] ) ) {
$description = $value [ 'desc' ];
$tooltip_html = $value [ 'desc_tip' ];
} elseif ( ! empty ( $value [ 'desc' ] ) ) {
$description = $value [ 'desc' ];
}
2014-09-23 22:27:15 +00:00
2017-11-09 12:57:54 +00:00
if ( $description && in_array ( $value [ 'type' ], array ( 'textarea' , 'radio' ), true ) ) {
$description = '<p style="margin-top:0">' . wp_kses_post ( $description ) . '</p>' ;
} elseif ( $description && in_array ( $value [ 'type' ], array ( 'checkbox' ), true ) ) {
$description = wp_kses_post ( $description );
} elseif ( $description ) {
$description = '<span class="description">' . wp_kses_post ( $description ) . '</span>' ;
}
2014-09-23 22:27:15 +00:00
2017-11-09 12:57:54 +00:00
if ( $tooltip_html && in_array ( $value [ 'type' ], array ( 'checkbox' ), true ) ) {
$tooltip_html = '<p class="description">' . $tooltip_html . '</p>' ;
} elseif ( $tooltip_html ) {
$tooltip_html = wc_help_tip ( $tooltip_html );
}
2013-07-26 14:36:28 +00:00
2017-11-09 12:57:54 +00:00
return array (
'description' => $description ,
'tooltip_html' => $tooltip_html ,
);
2014-09-12 00:40:30 +00:00
}
2013-07-26 14:36:28 +00:00
2017-11-09 12:57:54 +00:00
/**
* Save admin fields .
*
* Loops though the woocommerce options array and outputs each field .
*
* @ param array $options Options array to output .
* @ param array $data Optional . Data to use for saving . Defaults to $_POST .
* @ return bool
*/
public static function save_fields ( $options , $data = null ) {
if ( is_null ( $data ) ) {
$data = $_POST ; // WPCS: input var okay, CSRF ok.
2014-09-12 00:40:30 +00:00
}
2017-11-09 12:57:54 +00:00
if ( empty ( $data ) ) {
return false ;
2014-06-25 15:30:47 +00:00
}
2013-07-26 14:36:28 +00:00
2017-11-09 12:57:54 +00:00
// Options to update will be stored here and saved later.
$update_options = array ();
2014-09-12 00:40:30 +00:00
2017-11-09 12:57:54 +00:00
// Loop options and get values to save.
foreach ( $options as $option ) {
if ( ! isset ( $option [ 'id' ] ) || ! isset ( $option [ 'type' ] ) ) {
continue ;
}
2015-07-06 14:31:43 +00:00
2017-11-09 12:57:54 +00:00
// Get posted value.
if ( strstr ( $option [ 'id' ], '[' ) ) {
parse_str ( $option [ 'id' ], $option_name_array );
$option_name = current ( array_keys ( $option_name_array ) );
$setting_name = key ( $option_name_array [ $option_name ] );
$raw_value = isset ( $data [ $option_name ][ $setting_name ] ) ? wp_unslash ( $data [ $option_name ][ $setting_name ] ) : null ;
} else {
$option_name = $option [ 'id' ];
$setting_name = '' ;
$raw_value = isset ( $data [ $option [ 'id' ] ] ) ? wp_unslash ( $data [ $option [ 'id' ] ] ) : null ;
}
2015-07-06 14:31:43 +00:00
2017-11-09 12:57:54 +00:00
// Format the value based on option type.
switch ( $option [ 'type' ] ) {
case 'checkbox' :
$value = '1' === $raw_value || 'yes' === $raw_value ? 'yes' : 'no' ;
break ;
case 'textarea' :
$value = wp_kses_post ( trim ( $raw_value ) );
break ;
case 'multiselect' :
case 'multi_select_countries' :
$value = array_filter ( array_map ( 'wc_clean' , ( array ) $raw_value ) );
break ;
case 'image_width' :
$value = array ();
if ( isset ( $raw_value [ 'width' ] ) ) {
$value [ 'width' ] = wc_clean ( $raw_value [ 'width' ] );
$value [ 'height' ] = wc_clean ( $raw_value [ 'height' ] );
$value [ 'crop' ] = isset ( $raw_value [ 'crop' ] ) ? 1 : 0 ;
} else {
$value [ 'width' ] = $option [ 'default' ][ 'width' ];
$value [ 'height' ] = $option [ 'default' ][ 'height' ];
$value [ 'crop' ] = $option [ 'default' ][ 'crop' ];
}
break ;
case 'select' :
2017-12-15 11:39:05 +00:00
$allowed_values = empty ( $option [ 'options' ] ) ? array () : array_map ( 'strval' , array_keys ( $option [ 'options' ] ) );
2017-11-09 12:57:54 +00:00
if ( empty ( $option [ 'default' ] ) && empty ( $allowed_values ) ) {
$value = null ;
break ;
}
$default = ( empty ( $option [ 'default' ] ) ? $allowed_values [ 0 ] : $option [ 'default' ] );
2017-12-15 11:39:05 +00:00
$value = in_array ( $raw_value , $allowed_values , true ) ? $raw_value : $default ;
2017-11-09 12:57:54 +00:00
break ;
default :
$value = wc_clean ( $raw_value );
break ;
}
2015-07-06 14:31:43 +00:00
2017-11-09 12:57:54 +00:00
/**
* Fire an action when a certain 'type' of field is being saved .
*
* @ deprecated 2.4 . 0 - doesn ' t allow manipulation of values !
*/
if ( has_action ( 'woocommerce_update_option_' . sanitize_title ( $option [ 'type' ] ) ) ) {
wc_deprecated_function ( 'The woocommerce_update_option_X action' , '2.4.0' , 'woocommerce_admin_settings_sanitize_option filter' );
do_action ( 'woocommerce_update_option_' . sanitize_title ( $option [ 'type' ] ), $option );
continue ;
}
2014-09-12 00:40:30 +00:00
2017-11-09 12:57:54 +00:00
/**
* Sanitize the value of an option .
*
* @ since 2.4 . 0
*/
$value = apply_filters ( 'woocommerce_admin_settings_sanitize_option' , $value , $option , $raw_value );
/**
* Sanitize the value of an option by option name .
*
* @ since 2.4 . 0
*/
$value = apply_filters ( " woocommerce_admin_settings_sanitize_option_ $option_name " , $value , $option , $raw_value );
if ( is_null ( $value ) ) {
continue ;
2015-07-06 14:31:43 +00:00
}
2017-11-09 12:57:54 +00:00
// Check if option is an array and handle that differently to single values.
if ( $option_name && $setting_name ) {
if ( ! isset ( $update_options [ $option_name ] ) ) {
$update_options [ $option_name ] = get_option ( $option_name , array () );
}
if ( ! is_array ( $update_options [ $option_name ] ) ) {
$update_options [ $option_name ] = array ();
}
$update_options [ $option_name ][ $setting_name ] = $value ;
} else {
$update_options [ $option_name ] = $value ;
2014-09-12 00:40:30 +00:00
}
2017-11-09 12:57:54 +00:00
/**
* Fire an action before saved .
*
* @ deprecated 2.4 . 0 - doesn ' t allow manipulation of values !
*/
do_action ( 'woocommerce_update_option' , $option );
2013-07-26 14:36:28 +00:00
}
2017-11-09 12:57:54 +00:00
// Save all options in our array.
foreach ( $update_options as $name => $value ) {
update_option ( $name , $value );
}
2013-07-26 14:36:28 +00:00
2017-11-09 12:57:54 +00:00
return true ;
2014-09-12 00:40:30 +00:00
}
2013-07-26 14:36:28 +00:00
2017-11-09 12:57:54 +00:00
/**
* Checks which method we ' re using to serve downloads .
*
* If using force or x - sendfile , this ensures the . htaccess is in place .
*/
public static function check_download_folder_protection () {
$upload_dir = wp_upload_dir ();
$downloads_url = $upload_dir [ 'basedir' ] . '/woocommerce_uploads' ;
$download_method = get_option ( 'woocommerce_file_download_method' );
if ( 'redirect' === $download_method ) {
// Redirect method - don't protect.
if ( file_exists ( $downloads_url . '/.htaccess' ) ) {
unlink ( $downloads_url . '/.htaccess' ); // @codingStandardsIgnoreLine
}
} else {
2013-08-06 15:56:15 +00:00
2017-11-09 12:57:54 +00:00
// Force method - protect, add rules to the htaccess file.
if ( ! file_exists ( $downloads_url . '/.htaccess' ) ) {
$file_handle = @ fopen ( $downloads_url . '/.htaccess' , 'w' ); // @codingStandardsIgnoreLine
if ( $file_handle ) {
fwrite ( $file_handle , 'deny from all' ); // @codingStandardsIgnoreLine
fclose ( $file_handle ); // @codingStandardsIgnoreLine
}
2013-08-06 15:56:15 +00:00
}
}
}
}
2013-07-26 14:36:28 +00:00
2013-11-03 23:55:34 +00:00
endif ;