* @license GPL-2.0+
* @link https://robincornett.com
* @copyright 2014-2017 Robin Cornett Creative, LLC
*/
class Display_Featured_Image_Genesis_Settings extends Display_Featured_Image_Genesis_Helper {
/**
* The common plugin class.
* @var $commmon Display_Featured_Image_Genesis_Common
*/
protected $common;
/**
* The plugin admin page.
* @var $page string
*/
protected $page = 'displayfeaturedimagegenesis';
/**
* The plugin setting.
* @var $setting string
*/
protected $setting;
/**
* Public post types on the site.
* @var $post_types array
*/
protected $post_types;
/**
* The plugin settings fields.
* @var $fields array
*/
protected $fields;
/**
* The db query for old term options.
* @var $term_option_query
*/
protected $term_option_query = array();
/**
* add a submenu page under Appearance
* @since 1.4.0
*/
public function do_submenu_page() {
$this->common = new Display_Featured_Image_Genesis_Common();
$this->setting = $this->get_display_setting();
$this->post_types = $this->get_content_types();
add_theme_page(
__( 'Display Featured Image for Genesis', 'display-featured-image-genesis' ),
__( 'Display Featured Image for Genesis', 'display-featured-image-genesis' ),
'manage_options',
$this->page,
array( $this, 'do_settings_form' )
);
add_action( 'admin_init', array( $this, 'register_settings' ) );
$sections = $this->register_sections();
$this->fields = $this->register_fields();
$this->add_sections( $sections );
$this->add_fields( $this->fields, $sections );
}
/**
* create settings form
*
* @since 1.4.0
*/
public function do_settings_form() {
$page_title = get_admin_page_title();
echo '';
printf( '
%s
', esc_attr( $page_title ) );
$this->check_and_maybe_update_terms();
$active_tab = $this->get_active_tab();
echo $this->do_tabs( $active_tab );
echo '';
echo '';
}
/**
* Check if term images need to be updated because they were added before WP 4.4 and this plugin 2.4.
* @since 2.6.1
*/
protected function check_and_maybe_update_terms() {
if ( ! function_exists( 'get_term_meta' ) ) {
return;
}
if ( $this->terms_have_been_updated() ) {
return;
}
$previous_user = get_option( 'displayfeaturedimagegenesis', false );
if ( ! $previous_user ) {
update_option( 'displayfeaturedimagegenesis_updatedterms', true );
return;
}
$this->term_option_query = $this->check_term_images();
if ( $this->term_option_query ) {
$this->update_delete_term_meta();
$this->term_meta_notice();
} else {
update_option( 'displayfeaturedimagegenesis_updatedterms', true );
}
}
/**
* Output tabs.
* @return string
* @since 2.5.0
*/
protected function do_tabs( $active_tab ) {
$tabs = $this->define_tabs();
$output = '';
$output .= sprintf( '
%s
', __( 'Settings Tabs', 'display-featured-image-genesis' ) );
$output .= '
';
foreach ( $tabs as $tab ) {
$class = $active_tab === $tab['id'] ? ' nav-tab-active' : '';
$output .= sprintf( '- %s
', $this->page, $tab['id'], $class, $tab['tab'] );
}
$output .= '
';
$output .= '
';
$this->do_checkbox( $fallback_args );
echo '
';
}
$id = $this->setting['post_type'][ $post_type ];
$name = 'displayfeaturedimagegenesis[post_type][' . esc_attr( $post_type ) . ']';
if ( $id ) {
echo wp_kses_post( $this->render_image_preview( $id, $post_type ) );
}
$this->render_buttons( $id, $name );
if ( empty( $id ) || ! is_object( $args['post_type'] ) ) {
return;
}
$description = sprintf( __( 'View your %2$s archive.', 'display-featured-image-genesis' ),
esc_url( get_post_type_archive_link( $post_type ) ),
esc_attr( $args['post_type']->label )
);
printf( '%s
', wp_kses_post( $description ) );
}
/**
* @return array
*/
public function pick_center() {
return array(
1 => __( 'Center', 'display-featured-image-genesis' ),
0 => __( 'Do Not Center', 'display-featured-image-genesis' ),
);
}
/**
* validate all inputs
* @param string $new_value various settings
* @return string number or URL
*
* @since 1.4.0
*/
public function do_validation_things( $new_value ) {
$action = 'displayfeaturedimagegenesis_save-settings';
$nonce = 'displayfeaturedimagegenesis_nonce';
// If the user doesn't have permission to save, then display an error message
if ( ! $this->user_can_save( $action, $nonce ) ) {
wp_die( esc_attr__( 'Something unexpected happened. Please try again.', 'display-featured-image-genesis' ) );
}
check_admin_referer( $action, $nonce );
$new_value = array_merge( $this->setting, $new_value );
// validate all checkbox fields
foreach ( $this->fields as $field ) {
if ( 'do_checkbox' === $field['callback'] ) {
$new_value[ $field['id'] ] = $this->one_zero( $new_value[ $field['id'] ] );
} elseif ( 'do_number' === $field['callback'] ) {
if ( 'max_height' === $field['id'] && empty( $new_value[ $field['id'] ] ) ) {
continue;
}
$new_value[ $field['id'] ] = $this->check_value( $new_value[ $field['id'] ], $this->setting[ $field['id'] ], $field['args']['min'], $field['args']['max'] );
} elseif ( 'do_radio_buttons' === $field['callback'] ) {
$new_value[ $field['id'] ] = absint( $new_value[ $field['id'] ] );
}
}
// extra variables to pass through to image validation
$size_to_check = $this->common->minimum_backstretch_width();
// validate default image
$new_value['default'] = $this->validate_image( $new_value['default'], $this->setting['default'], __( 'Default', 'display-featured-image-genesis' ), $size_to_check );
// search/404
$size_to_check = get_option( 'medium_size_w' );
$custom_pages = array(
array(
'id' => 'search',
'label' => __( 'Search Results', 'display-featured-image-genesis' ),
),
array(
'id' => 'fourohfour',
'label' => __( '404 Page', 'display-featured-image-genesis' ),
),
);
foreach ( $custom_pages as $page ) {
$setting_to_check = isset( $this->setting['post_type'][ $page['id'] ] ) ? $this->setting['post_type'][ $page['id'] ] : '';
if ( isset( $new_value['post_type'][ $page ['id'] ] ) ) {
$new_value['post_type'][ $page ['id'] ] = $this->validate_image( $new_value['post_type'][ $page['id'] ], $setting_to_check, $page['label'], $size_to_check );
}
}
foreach ( $this->post_types as $post_type ) {
$object = get_post_type_object( $post_type );
$old_value = isset( $this->setting['post_type'][ $object->name ] ) ? $this->setting['post_type'][ $object->name ] : '';
$label = $object->label;
if ( isset( $new_value['post_type'][ $post_type ] ) ) {
$new_value['post_type'][ $post_type ] = $this->validate_image( $new_value['post_type'][ $post_type ], $old_value, $label, $size_to_check );
}
if ( isset( $new_value['fallback'][ $post_type ] ) ) {
$new_value['fallback'][ $post_type ] = $this->one_zero( $new_value['fallback'][ $post_type ] );
}
}
$post_types = $this->get_content_types_built_in();
foreach ( $post_types as $post_type ) {
$new_value['skip'][ $post_type ] = isset( $new_value['skip'][ $post_type ] ) ? $this->one_zero( $new_value['skip'][ $post_type ] ) : 0;
}
return $new_value;
}
/**
* Check the numeric value against the allowed range. If it's within the range, return it; otherwise, return the old value.
* @param $new_value int new submitted value
* @param $old_value int old setting value
* @param $min int minimum value
* @param $max int maximum value
*
* @return int
*/
protected function check_value( $new_value, $old_value, $min, $max ) {
if ( $new_value >= $min && $new_value <= $max ) {
return (int) $new_value;
}
return (int) $old_value;
}
/**
* For 4.4, output a notice explaining that old term options can be updated to term_meta.
* Options are to update all terms or to ignore, and do by hand.
* @since 2.4.0
*/
protected function term_meta_notice() {
$screen = get_current_screen();
if ( 'appearance_page_displayfeaturedimagegenesis' !== $screen->id ) {
return;
}
$updated_terms = get_option( 'displayfeaturedimagegenesis_updatedterms', false );
if ( $updated_terms ) {
return;
}
$rows = $this->term_option_query;
if ( ! $rows ) {
update_option( 'displayfeaturedimagegenesis_updatedterms', true );
return;
}
$message = sprintf( '%s
', __( 'WordPress 4.4 introduces term metadata for categories, tags, and other taxonomies. This is your opportunity to optionally update all impacted terms on your site to use the new metadata.', 'display-featured-image-genesis' ) );
$message .= sprintf( '%s
', __( 'This will modify your database (potentially many entries at once), so if you\'d rather do it yourself, you can. Here\'s a list of the affected terms:', 'display-featured-image-genesis' ) );
$message .= '';
foreach ( $rows as $row ) {
$term_id = str_replace( 'displayfeaturedimagegenesis_', '', $row );
$term = get_term( (int) $term_id );
if ( ! is_wp_error( $term ) && ! is_null( $term ) ) {
$message .= edit_term_link( $term->name, '- ', '
', $term, false );
}
}
$message .= '
';
$message .= sprintf( '%s
', __( 'To get rid of this notice, you can 1) update your terms by hand; 2) click the update button (please check your terms afterward); or 3) click the dismiss button.', 'display-featured-image-genesis' ) );
$faq = sprintf( __( 'For more information, please visit the plugin\'s Frequently Asked Questions on WordPress.org.', 'display-featured-image-genesis' ), esc_url( 'https://wordpress.org/plugins/display-featured-image-genesis/faq/' ) );
$message .= sprintf( '%s
', $faq );
echo '' . wp_kses_post( $message );
echo '
';
echo '