page, array( $this, 'do_settings_form' ) ); add_action( 'admin_init', array( $this, 'register_settings' ) ); add_action( "load-appearance_page_{$this->page}", array( $this, 'build_settings_page' ) ); } /** * Build out the settings page sections/fields. */ public function build_settings_page() { $sections = include 'sections.php'; $this->fields = $this->get_fields(); $this->add_sections( $sections ); $this->add_fields( $this->fields, $sections ); include_once 'class-displayfeaturedimagegenesis-helptabs.php'; $help = new Display_Featured_Image_Genesis_HelpTabs(); $help->help(); } /** * Get the settings fields. * @return array */ protected function get_fields() { $fields = array(); $files = array( 'main', 'style', 'cpt', 'advanced', ); foreach ( $files as $file ) { $fields = array_merge( $fields, include "fields-{$file}.php" ); } return $fields; } /** * 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 '
'; settings_fields( $this->page ); do_settings_sections( $this->page . '_' . $active_tab ); wp_nonce_field( $this->page . '_save-settings', $this->page . '_nonce', false ); submit_button(); settings_errors(); 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( $this->page, false ); if ( ! $previous_user ) { update_option( "{$this->page}_updatedterms", true ); return; } include_once plugin_dir_path( __FILE__ ) . 'class-displayfeaturedimagegenesis-settings-terms.php'; $terms = new Display_Featured_Image_Genesis_Settings_Terms(); $terms->maybe_update_terms(); } /** * Output tabs. * * @param $active_tab * * @return string * @since 2.5.0 */ protected function do_tabs( $active_tab ) { $tabs = include 'tabs.php'; $output = ''; return $output; } /** * Settings for options screen * * @since 1.1.0 */ public function register_settings() { register_setting( $this->page, $this->page, array( $this, 'do_validation_things' ) ); } /** * Section description * * @since 1.1.0 */ public function main_section_description() { return __( 'Use these settings to modify the plugin behavior throughout your site. Check the Help tab for more information. ', 'display-featured-image-genesis' ); } /** * Style section description */ public function style_section_description() { return __( 'These settings modify the output style/methods for the banner image.', 'display-featured-image-genesis' ); } /** * Section description * * @since 1.1.0 */ public function cpt_section_description() { $description = __( 'Optional: set a custom image for search results and 404 (no results found) pages.', 'display-featured-image-genesis' ); $post_types = $this->get_content_types(); unset( $post_types['post'] ); if ( $post_types ) { $description .= __( ' Additionally, since you have custom post types with archives, you might like to set a featured image for each of them.', 'display-featured-image-genesis' ); } return $description; } /** * Description for the advanced settings section/tab. * * @return string */ public function advanced_section_description() { return __( 'Optionally, change the hook location and priority of the featured image output. Use with caution. Note: this will change the hook/priority of the featured image sitewide. If you need to make changes based on content type, check the readme for code examples.', 'display-featured-image-genesis' ); } /** * @return array */ public function pick_center() { return array( 1 => __( 'Center', 'display-featured-image-genesis' ), 0 => __( 'Do Not Center', 'display-featured-image-genesis' ), ); } /** * Get the post types as options. * @return array */ protected function get_post_types() { $post_types = $this->get_content_types_built_in(); $options = array(); foreach ( $post_types as $post_type ) { $object = get_post_type_object( $post_type ); $options[ $post_type ] = $object->label; } /** * Add a filter on the list of post types which can be assigned a featured image, etc. * * @param array $options * * @since 3.1.0 */ return apply_filters( 'displayfeaturedimagegenesis_get_post_types', $options ); } /** * Get the hooks for the large image. * * @return array */ protected function large_hook_options() { $hooks = array( 'genesis_before_loop' => 'genesis_before_loop ' . __( '(default)', 'display-featured-image-genesis' ), 'genesis_after_header' => 'genesis_after_header', 'genesis_before_content_sidebar_wrap' => 'genesis_before_content_sidebar_wrap', ); $html5 = genesis_html5() ? array( 'genesis_before_entry' => 'genesis_before_entry ' . __( '(HTML5 themes)', 'display-featured-image-genesis' ), 'genesis_entry_header' => 'genesis_entry_header ' . __( '(HTML5 themes)', 'display-featured-image-genesis' ), 'genesis_entry_content' => 'genesis_entry_content ' . __( '(HTML5 themes)', 'display-featured-image-genesis' ), ) : array(); return array_merge( $hooks, $html5 ); } /** * validate all inputs * * @param $new_value array * * @return array * * @since 1.4.0 */ public function do_validation_things( $new_value ) { $action = $this->page . '_save-settings'; $nonce = $this->page . '_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 ); include_once 'class-displayfeaturedimagegenesis-settings-validate.php'; $validation = new Display_Featured_Image_Genesis_Settings_Validate( $this->get_fields(), $this->setting ); return $validation->validate( $new_value ); } /** * Check whether terms need to be updated * @return boolean true if on 4.4 and wp_options for terms exist; false otherwise * * @since 2.4.0 */ protected function terms_have_been_updated() { $updated = get_option( "{$this->page}_updatedterms", false ); return (bool) $updated; } }