settings_errors = (array) $errors;
}
/**
* Displays a text input setting field.
*
* @param array $args
* @param string $type Type attribute
*/
public function callback_text( $args ) {
$args['size'] = ( isset( $args['size'] ) && $args['size'] ) ? $args['size'] : 'regular';
$type = !empty( $args['text_type'] ) ? esc_attr( $args['text_type'] ) : 'text';
$args = $this->get_arguments( $args ); // escapes all attributes
$value = (string) esc_attr( $this->get_option( $args ) );
$error = $this->get_setting_error( $args['id'] );
$html = sprintf( '', $args['section'], $args['id'], $value, $args['attr'], $error, $type );
echo $args['before'] . $html . $args['after'] . $this->description( $args['desc'] );
}
/**
* Displays a textarea.
*
* @param array $args
*/
public function callback_textarea( $args ) {
$size = ( isset( $args['size'] ) && $args['size'] ) ? $args['size'] : 'regular';
$args = $this->get_arguments( $args ); // escapes all attributes
$value = (string) esc_textarea( $this->get_option( $args ) );
$error = $this->get_setting_error( $args['id'] );
$html = sprintf( '', $args['section'], $args['id'], $value, $args['attr'], $error );
echo $args['before'] . $html . $args['after'] . $this->description( $args['desc'] );
}
/**
* Displays a select dropdown.
*
* @param array $args
*/
public function callback_select( $args ) {
$args = $this->get_arguments( $args ); // escapes all attributes
$value = array_map( 'esc_attr', array_values( (array) $this->get_option( $args ) ) );
$multiple = ( preg_match( '/multiple="multiple"/', strtolower( $args['attr'] ) ) ) ? '[]' : '';
$value = ( '[]' === $multiple ) ? $value : $value[0];
$html = sprintf( '' );
echo $args['before'] . $html . $args['after'] . $this->description( $args['desc'] );
}
/**
* Displays a single checkbox.
*
* @param array $args
*/
public function callback_checkbox( $args ) {
$args = $this->get_arguments( $args ); // escapes all attributes
$value = (string) esc_attr( $this->get_option( $args ) );
$error = $this->get_setting_error( $args['id'], ' style="border: 1px solid red; padding: 2px 1em 2px 0; "' );
$html = '';
$input = sprintf( '', $args['section'], $args['id'], $value, checked( $value, 'on', false ), $args['attr'] );
$html .= sprintf( '', $args['section'], $args['id'], $input, $args['desc'], $error );
echo $html . '';
}
/**
* Displays multiple checkboxes.
*
* @param array $args
*/
public function callback_multicheckbox( $args ) {
$args = $this->get_arguments( $args ); // escapes all attributes
$value = array_map( 'esc_attr', array_values( (array) $this->get_option( $args ) ) );
$count = count( $args['options'] );
$html = '' . $this->description( $args['desc'] );
}
/**
* Displays radio buttons.
*
* @param array $args
*/
public function callback_radio( $args ) {
$args = $this->get_arguments( $args ); // escapes all attributes
$value = (string) esc_attr( $this->get_option( $args ) );
$options = array_keys( (array) $args['options'] );
// make sure one radio button is checked
if ( empty( $value ) && ( isset( $options[0] ) && $options[0] ) ) {
$value = $options[0];
} elseif ( !empty( $value ) && ( isset( $options[0] ) && $options[0] ) ) {
if ( !in_array( $value, $options ) )
$value = $options[0];
}
$html = '' . $html . $this->description( $args['desc'] );
}
/**
* Displays type 'content' field.
*
* @param array $args
*/
public function callback_content( $args ) {
if ( isset( $args['content'] ) )
echo $args['content'];
if ( isset( $args['desc'] ) )
echo $this->description( $args['desc'] );
}
/**
* Displays field with the action hook '{$page_hook}_add_extra_field'.
*
* @param array $args
*/
function callback_extra_field( $args ) {
if ( isset( $args['callback'] ) && $args['callback'] ) {
if ( isset( $args['page_hook'] ) && $args['page_hook'] )
do_action( $args['page_hook'] . '_add_extra_field', $args );
}
}
/**
* Returns a field description.
*
* @param string $desc Description of field.
*/
public function description( $desc = '' ) {
if ( $desc ) {
return sprintf( '%s
', $desc );
}
}
/**
* Returns validation errors for a settings field.
*
* @param string $setting_id Settings field ID.
* @param string $style Style to override the default error style.
* @return string Empty string or inline style attribute.
*/
protected function get_setting_error( $setting_id, $attr = '' ) {
$display_error = '';
if ( !empty( $this->settings_errors ) ) {
foreach ( $this->settings_errors as $error ) {
if ( isset( $error['setting'] ) && $error['setting'] === $setting_id ) {
if ( '' === $attr ) {
// todo: don't use inline styles
$display_error = ' style="border: 1px solid red;"';
} else {
$display_error = $attr;
}
}
}
}
return $display_error;
}
/**
* Escapes and creates additional attributes for a setting field.
*
* @param string|array $args Arguments of a setting field.
* @param string $input Type of field.
* @param string $size Size of field (class name).
* @return array All arguments and attributes
*/
protected function get_arguments( $args = '', $class = false ) {
// escape section, id and options used in attributes
$args['section'] = esc_attr( $args['section'] );
$args['id'] = esc_attr( $args['id'] );
if ( isset( $args['options'] ) && $args['options'] ) {
$options = array();
foreach ( (array) $args['options'] as $key => $value ) {
$options[ esc_attr( $key ) ] = $value;
}
$args['options'] = $options;
}
// additional parameters
$attr_string = '';
$defaults = $attr = array();
if ( isset( $args['attr'] ) && $args['attr'] ) {
$attr = $args['attr'];
}
// set defaults for a textarea field
if ( 'textarea' === $args['type'] ) {
$defaults = array( 'rows' => '5', 'cols' => '55' );
}
// todo: add action to add additional defaults
$attr['class'] = isset( $attr['class'] ) ? trim( $attr['class'] ) : '';
if ( isset( $args['size'] ) && $args['size'] ) {
if ( 'text' === $args['type'] || 'textarea' === $args['type'] ) {
$attr['class'] .= sprintf( ' %1$s-%2$s', $args['size'], $args['type'] );
}
}
if ( $class ) {
if ( !preg_match( '/\s' . preg_quote( (string) $class, '/' ) . '\s/', $attr['class'] ) ) {
$attr['class'] = ' ' . (string) $class;
}
}
if ( '' === $attr['class'] ) {
unset( $attr['class'] );
}
// create attribute string
foreach ( $attr as $key => $arg ) {
$arg = ( 'class' === $arg ) ? sanitize_html_class( $arg ) : esc_attr( $arg );
$attr_string .= ' '. trim( $key ) . '="' . trim( $arg ) . '"';
}
$args['attr'] = $attr_string;
return $args;
}
/**
* Returns the value of a setting field.
*
* @param array $args Arguments of setting field
* @return string
*/
public function get_option( $args ) {
if ( isset( $args['value'] ) ) {
return $args['value'];
}
// get the value for the setting field from the database
$options = get_option( $args['section'] );
// return the value if it exists
if ( isset( $options[ $args['id'] ] ) ) {
return $options[ $args['id'] ];
}
// return the default value
return ( isset( $args['default'] ) ) ? $args['default'] : '';
}
} // class
} // class exists