page . '_' . $section['id'],
$section['title'],
array( $this, 'section_description' ),
$this->page . '_' . $section['tab']
);
}
}
/**
* Generic function to add settings fields
*
* @param $fields
* @param array $sections registered sections
*
* @since 2.4.0
*/
protected function add_fields( $fields, $sections ) {
foreach ( $fields as $field ) {
add_settings_field(
$field['id'],
sprintf( '', $this->page, $field['id'], $field['title'] ),
array( $this, $field['callback'] ),
$this->page . '_' . $sections[ $field['section'] ]['tab'],
$this->page . '_' . $sections[ $field['section'] ]['id'],
$field
);
}
}
/**
* Set which tab is considered active.
* @return string
* @since 2.5.0
*/
protected function get_active_tab() {
$tab = filter_input( INPUT_GET, 'tab', FILTER_SANITIZE_STRING );
return $tab ? $tab : 'main';
}
/**
* Echoes out the section description.
*
* @since 2.3.0
*
* @param $section
*/
public function section_description( $section ) {
$id = str_replace( "{$this->page}_", '', $section['id'] );
$method = "{$id}_section_description";
if ( method_exists( $this, $method ) ) {
echo wp_kses_post( wpautop( $this->$method() ) );
}
}
/**
* Generic callback to create a number field setting.
*
* @since 2.3.0
*
* @param $args
*/
public function do_number( $args ) {
printf( '%6$s',
(int) $args['min'],
(int) $args['max'],
esc_attr( $this->get_field_id( $args ) ),
esc_attr( $this->get_field_value( $args ) ),
esc_attr( $this->get_field_name( $args ) ),
esc_attr( $args['label'] )
);
$this->do_description( $args );
}
/**
* generic checkbox function (for all checkbox settings)
*
* @since 2.3.0
*
* @param $args
*/
public function do_checkbox( $args ) {
$name = $this->get_field_name( $args );
$value = $this->get_field_value( $args );
printf( '', esc_attr( $name ) );
printf( '',
esc_attr( $this->get_field_id( $args ) ),
checked( 1, esc_attr( $value ), false ),
esc_attr( $args['label'] ),
esc_attr( $name )
);
$this->do_description( $args );
}
/**
* Build a checkbox array.
*
* @param $args
*/
public function do_checkbox_array( $args ) {
echo '';
$this->do_description( $args );
}
/**
* radio buttons
* @since 2.6.0
*
* @param $args
*/
public function do_radio_buttons( $args ) {
echo '';
}
/**
* Output a select field.
*
* @param $args
*/
public function do_select( $args ) {
$value = $this->get_field_value( $args );
printf( '';
$this->do_description( $args );
}
/**
* Generic callback to display a field description.
*
* @param $args array
*
* @since 2.3.0
*/
protected function do_description( $args ) {
$description = isset( $args['description'] ) ? $args['description'] : false;
$function = $args['id'] . '_description';
if ( method_exists( $this, $function ) ) {
$description = $this->$function();
}
if ( ! $description ) {
return;
}
printf( '%s
', wp_kses_post( $description ) );
}
/**
* display image preview
*
* @param int $id featured image ID
* @param $alt string description for alt text
*
* @return string
*
* @since 2.3.0
*/
public function render_image_preview( $id, $alt = '' ) {
if ( empty( $id ) ) {
return '';
}
$id = displayfeaturedimagegenesis_check_image_id( $id );
/* translators: the placeholder refers to which featured image */
$alt_text = sprintf( __( '%s featured image', 'display-featured-image-genesis' ), esc_attr( $alt ) );
$preview = wp_get_attachment_image_src( (int) $id, 'medium' );
return sprintf( '', esc_url( $preview[0] ), esc_attr( $alt_text ) );
}
/**
* show image select/delete buttons
*
* @param int $id image ID
* @param string $name name for value/ID/class
*
* @since 2.3.0
*/
public function render_buttons( $id, $name ) {
$id = displayfeaturedimagegenesis_check_image_id( $id );
$id = $id ? (int) $id : '';
printf( '', esc_attr( $name ), esc_attr( $id ) );
printf( '',
esc_attr( $name ),
esc_attr__( 'Select Image', 'display-featured-image-genesis' )
);
if ( ! empty( $id ) ) {
printf( ' ',
esc_attr__( 'Delete Image', 'display-featured-image-genesis' )
);
}
}
/**
* Get all public content types, not including built in.
*
* @since 2.5.0
* @return array
*/
protected function get_content_types() {
$args = array(
'public' => true,
'_builtin' => false,
'has_archive' => true,
);
$output = 'names';
return get_post_types( $args, $output );
}
/**
* Get all public content types, including built in.
*
* @since 2.5.0
* @return array
*/
protected function get_content_types_built_in() {
$built_in = array( 'post', 'page' );
$post_types = $this->get_content_types();
return array_merge( $built_in, $post_types );
}
/**
* Get the current field name.
*
* @param $args
*
* @return string
*/
public function get_field_name( $args ) {
return isset( $args['key'] ) && $args['key'] ? $this->page . '[' . $args['key'] . '][' . $args['setting'] . ']' : $this->page . '[' . $args['id'] . ']';
}
/**
* Get the current field id.
*
* @param $args
*
* @return string
*
*/
public function get_field_id( $args ) {
return isset( $args['key'] ) && $args['key'] ? $this->page . '-' . $args['key'] . '-' . $args['setting'] : $this->page . '-' . $args['id'];
}
/**
* Get the current field value.
*
* @param $args
*
* @return mixed
* @internal param $setting
*
*/
public function get_field_value( $args ) {
if ( isset( $args['key'] ) && $args['key'] ) {
$value = isset( $this->setting[ $args['key'] ][ $args['setting'] ] ) ? $this->setting[ $args['key'] ][ $args['setting'] ] : 0;
} else {
$value = isset( $this->setting[ $args['id'] ] ) ? $this->setting[ $args['id'] ] : '';
}
return $value;
}
/**
* check if file type is image. updated to use WP function.
* @return bool
* @since 1.2.2
* @since 2.5.0
*/
protected function is_valid_img_ext( $file ) {
$valid = wp_check_filetype( $file );
return (bool) in_array( $valid['ext'], $this->allowed_file_types(), true );
}
/**
* Define the array of allowed image/file types.
* @return array
* @since 2.5.0
*/
protected function allowed_file_types() {
$allowed = apply_filters( 'displayfeaturedimage_valid_img_types', array( 'jpg', 'jpeg', 'png', 'gif' ) );
return is_array( $allowed ) ? $allowed : explode( ',', $allowed );
}
/**
* Determines if the user has permission to save the information from the submenu
* page.
*
* @since 2.3.0
* @access protected
*
* @param string $action The name of the action specified on the submenu page
* @param string $nonce The nonce specified on the submenu page
*
* @return bool True if the user has permission to save; false, otherwise.
* @author Tom McFarlin (https://tommcfarlin.com/save-wordpress-submenu-page-options/)
*/
protected function user_can_save( $action, $nonce ) {
$is_nonce_set = isset( $_POST[ $nonce ] );
$is_valid_nonce = false;
if ( $is_nonce_set ) {
$is_valid_nonce = wp_verify_nonce( $_POST[ $nonce ], $action );
}
return ( $is_nonce_set && $is_valid_nonce );
}
}