ALNP_Customizer

Complexity

Total Complexity

36

Size/Duplication

Total Lines	538
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
C	alnp_init_customizer()	0	118	9
A	alnp_remove_widgets_panel()	0	14	5
A	alnp_remove_default_customizer_panels()	0	15	1
A	alnp_is_customizer()	0	3	2
A	alnp_get_customizer_sections()	0	24	1
B	alnp_get_customizer_settings()	0	89	1
B	alnp_get_customizer_controls()	0	89	1
A	alnp_validate_content_container_selector()	0	7	2
A	alnp_validate_post_title_selector()	0	7	2
A	alnp_validate_post_navigation_selector()	0	7	2
A	alnp_get_settings()	0	17	1
A	is_page_alnp_ready()	0	13	6
A	sanitize_checkbox()	0	3	2

<?php
/**
 * Auto Load Next Post: Theme Customizer
 *
 * @since    1.5.0
 * @version  1.6.0
 * @author   Sébastien Dumont
 * @category Classes
 * @package  Auto Load Next Post/Classes/Customizer
 * @license  GPL-2.0+
 */

// Exit if accessed directly.
if ( ! defined( 'ABSPATH' ) ) {
	exit;
}

if ( ! class_exists( 'ALNP_Customizer' ) ) {

	class ALNP_Customizer {

		/**
		 * Constructor.
		 *
		 * @access public
		 * @since  1.5.0
		 */
		public function __construct() {
			add_action( 'customize_register', array( $this, 'alnp_init_customizer' ), 50 );
			add_filter( 'customize_loaded_components', array( $this, 'alnp_remove_widgets_panel' ) );
		}

		/**
		 * Initialize the Customizer.
		 *
		 * @access public
		 * @since  1.5.0
		 * @param  WP_Customize_Manager $wp_customize The Customizer object.
		 */
		public function alnp_init_customizer( $wp_customize ) {
			/**
			 * Dont add settings to the customizer if the user does
			 * not have permission to make changes to the theme.
			 */
			if ( ! current_user_can( 'edit_theme_options' ) ) {
				return;
			}

			// Load custom controllers.
			require_once( dirname( __FILE__ ) . '/class-alnp-arbitrary-controller.php' );
			//require_once( dirname( __FILE__ ) . '/class-alnp-display-video-controller.php' );

			// Auto Load Next Post Panel.
			$panel = array( 'panel' => 'alnp' );

			/**
			 * Add the main panel and sections.
			 *
			 * Only shows if viewing a singular post.
			 */
			$wp_customize->add_panel(
				'alnp', array(
					'title'           => esc_html__( 'Auto Load Next Post', 'auto-load-next-post' ),
					'capability'      => 'edit_theme_options',
					'description'     => sprintf( esc_html__( '%s increases your pageviews by engaging the site viewers to keep reading your content rather than increasing your bounce rate.', 'auto-load-next-post' ), esc_html__( 'Auto Load Next Post', 'auto-load-next-post' ) ),
					'priority'        => 160,
					'active_callback' => array( $this, 'is_page_alnp_ready' )
				)
			);

			// Get the sections.
			$sections = $this->alnp_get_customizer_sections();

			// Add each section.
			foreach ( $sections as $section => $args ) {
				/**
				 * If we are not only viewing Auto Load Next Post customizer sections
				 * then move them under our own panel.
				 */
				if ( ! $this->alnp_is_customizer() ) {
					$args = array_merge( $args, $panel );
				}

				$wp_customize->add_section( $section, $args );
			}

			// Get plugin settings.
			$settings = $this->alnp_get_customizer_settings();

			// Add each setting.
			foreach ( $settings as $setting => $args ) {
				$wp_customize->add_setting( $setting, $args );
			}

			/**
			 * Let other plugins register extra customizer options for Auto Load Next Post.
			 *
			 * @since 1.5.0
			 * @param WP_Customize_Manager $wp_customize The Customizer object.
			 */
			do_action( 'alnp_customizer_register', $wp_customize );

			$controls = $this->alnp_get_customizer_controls();

			foreach ( $controls as $control => $args ) {
				$wp_customize->add_control( new $args['class']( $wp_customize, $control, $args ) );
			}

			if ( $this->alnp_is_customizer() ) {
				$this->alnp_remove_default_customizer_panels( $wp_customize ); // Remove controls from the customizer.
			}

			// Video Help - Coming Soon
			/*$wp_customize->add_setting( 'alnp_video_theme_selectors', array(
				'default' => '', // The video ID
				'type'    => 'theme_mod',
			) );

			$wp_customize->add_control( new ALNP_Display_Video_Controller( $wp_customize, 'alnp_video_theme_selectors', array(
				'label'    => __( 'Video: How to find your theme selectors', 'auto-load-next-post' ),
				'section'  => 'auto_load_next_post_theme_selectors',
				'settings' => 'alnp_video_theme_selectors',
				'type'     => 'alnp-display-video',
				'priority' => 1,
			) ) );*/

			/**
			 * If Auto Load Next Post Pro is not installed, display a new section
			 * to tell users about the pro version, what comes with it
			 * and link to product page.
			 */
			if ( ! is_alnp_pro_version_installed() ) {
				include_once( dirname( __FILE__ ) . '/class-alnp-pro-preview-controller.php' );

				$preview_args = array(
					'title'    => esc_html__( 'More?', 'auto-load-next-post' ),
					'priority' => 999,
				);

				if ( ! $this->alnp_is_customizer() ) {
					$preview_args = array_merge( $preview_args, $panel );
				}

				$wp_customize->add_section( 'alnp_pro_preview', $preview_args );

				$wp_customize->add_setting( 'alnp_pro_preview', array(
					'default' => null,
				) );

				$wp_customize->add_control( new ALNP_Pro_Preview_Controller( $wp_customize, 'alnp_pro_preview', array(
					'label'    => __( 'Looking for more options?', 'auto-load-next-post' ),
					'section'  => 'alnp_pro_preview',
					'settings' => 'alnp_pro_preview',
					'priority' => 1,
				) ) );
			}
		} // END alnp_init_customizer()

		/**
		 * Removes the core 'Navigation Menu' and 'Widgets' panel from the Customizer.
		 *
		 * @access public
		 * @since  1.5.0
		 * @param  array $components Core Customizer components list.
		 * @return array (Maybe) modified components list.
		 */
		public function alnp_remove_widgets_panel( $components ) {
			if ( $this->alnp_is_customizer() ) {
				foreach( $components as $key => $component ) {
					if ( $component == 'widgets' ) {
						unset( $components[ 'widgets' ] );
					}
					if ( $component == 'nav_menus' ) {
						unset( $components[ 'nav_menus' ] );
					}
				}
			}

			return $components;
		} // END alnp_remove_widgets_panel()

		/**
		 * Remove any unwanted default conrols.
		 *
		 * @access public
		 * @since  1.5.0
		 * @global $wp_cutomize
		 * @param  object $wp_customize
		 * @return boolean
		 */
		public function alnp_remove_default_customizer_panels( $wp_customize ) {
			global $wp_customize;

			$wp_customize->remove_section("themes");
			$wp_customize->remove_control("active_theme");
			$wp_customize->remove_section("title_tagline");
			$wp_customize->remove_section("colors");
			$wp_customize->remove_section("header_image");
			$wp_customize->remove_section("background_image");
			$wp_customize->remove_section("static_front_page");
			$wp_customize->remove_section("custom_css");
			$wp_customize->remove_section("theme_options");

			return true;
		} // END alnp_remove_default_customizer_panels()

		/**
		 * Are we looking at the Auto Load Next Post customizer?
		 *
		 * @access public
		 * @since  1.5.0
		 * @return boolean
		 */
		public function alnp_is_customizer() {
			return isset( $_GET['alnp-customizer'] ) && $_GET['alnp-customizer'] === 'yes';
		} // END alnp_is_customizer()

		/**
		 * Get Customizer sections for Auto Load Next Post.
		 *
		 * @access public
		 * @since  1.5.0
		 * @return array
		 */
		public function alnp_get_customizer_sections() {
			/**
			 * Filter Customizer sections for Auto Load Next Post.
			 *
			 * @param array $sections Customizer sections to add.
			 */
			return apply_filters( 'alnp_get_customizer_sections', array(
				'auto_load_next_post_theme_selectors' => array(
					'capability'  => 'edit_theme_options',
					'title'       => esc_html__( 'Theme Selectors', 'auto-load-next-post' ),
					'description' => sprintf( __( 'Set the theme selectors below according to the theme. %1$sHow to find my theme selectors?%2$s', 'auto-load-next-post' ), '<a href="' . esc_url( 'https://github.com/autoloadnextpost/alnp-documentation/blob/master/en_US/theme-selectors.md#how-to-find-your-theme-selectors' ) . '" target="_blank">', '</a>' ),
				),
				'auto_load_next_post_misc' => array(
					'capability'  => 'edit_theme_options',
					'title'       => esc_html__( 'Misc Settings', 'auto-load-next-post' ),
					'description' => sprintf( __( 'Here you can set if you want to track pageviews, remove comments and load %s javascript in the footer and disable for mobile users.', 'auto-load-next-post' ), esc_html__( 'Auto Load Next Post', 'auto-load-next-post' ) ),
				),
				'auto_load_next_post_events' => array(
					'capability'  => 'edit_theme_options',
					'title'       => esc_html__( 'Events', 'auto-load-next-post' ),
					'description' => sprintf( __( 'Below you can enter external JavaScript events to be triggered alongside %1$s native events. Separate each event like so: %2$s', 'auto-load-next-post' ), esc_html__( 'Auto Load Next Post', 'auto-load-next-post' ), '<code>event1, event2,</code>' ),
				),
			) );
		} // END alnp_get_customizer_sections()

		/**
		 * Get Customizer settings for Auto Load Next Post.
		 *
		 * @access  public
		 * @since   1.5.0
		 * @version 1.6.0
		 * @return  array
		 */
		public function alnp_get_customizer_settings() {
			$settings = $this->alnp_get_settings();

			/**
			 * Filter Customizer settings for Auto Load Next Post.
			 *
			 * @param array $settings Customizer settings to add.
			 */
			return apply_filters( 'alnp_get_customizer_settings', array(
				'auto_load_next_post_content_container' => array(
					'capability'        => 'edit_theme_options',
					'default'           => $settings['alnp_content_container'],
					'sanitize_callback' => 'wp_filter_post_kses',
					'validate_callback' => array( $this, 'alnp_validate_content_container_selector' ),
					'transport'         => 'postMessage',
					'type'              => 'option',
				),
				'auto_load_next_post_title_selector' => array(
					'capability'        => 'edit_theme_options',
					'default'           => $settings['alnp_title_selector'],
					'sanitize_callback' => 'wp_filter_post_kses',
					'validate_callback' => array( $this, 'alnp_validate_post_title_selector' ),
					'transport'         => 'postMessage',
					'type'              => 'option',
				),
				'auto_load_next_post_navigation_container' => array(
					'capability'        => 'edit_theme_options',
					'default'           => $settings['alnp_navigation_container'],
					'sanitize_callback' => 'wp_filter_post_kses',
					'validate_callback' => array( $this, 'alnp_validate_post_navigation_selector' ),
					'transport'         => 'postMessage',
					'type'              => 'option',
				),
				'auto_load_next_post_previous_post_selector' => array(
					'capability'        => 'edit_theme_options',
					'default'           => $settings['alnp_previous_post_selector'],
					'sanitize_callback' => 'wp_filter_post_kses',
					'transport'         => 'postMessage',
					'type'              => 'option',
				),
				'auto_load_next_post_comments_container' => array(
					'capability'        => 'edit_theme_options',
					'default'           => $settings['alnp_comments_container'],
					'sanitize_callback' => 'wp_filter_post_kses',
					'transport'         => 'postMessage',
					'type'              => 'option',
				),
				'auto_load_next_post_remove_comments' => array(
					'capability'        => 'edit_theme_options',
					'sanitize_callback' => array( $this, 'sanitize_checkbox' ),
					'default'           => 'yes',
					'transport'         => 'refresh',
					'type'              => 'option',
				),
				'auto_load_next_post_google_analytics' => array(
					'capability'        => 'edit_theme_options',
					'sanitize_callback' => array( $this, 'sanitize_checkbox' ),
					'default'           => 'no',
					'transport'         => 'refresh',
					'type'              => 'option',
				),
				'auto_load_next_post_load_js_in_footer' => array(
					'capability'        => 'edit_theme_options',
					'sanitize_callback' => array( $this, 'sanitize_checkbox' ),
					'default'           => 'no',
					'transport'         => 'refresh',
					'type'              => 'option',
				),
				'auto_load_next_post_disable_on_mobile' => array(
					'capability'        => 'edit_theme_options',
					'sanitize_callback' => array( $this, 'sanitize_checkbox' ),
					'default'           => 'no',
					'type'              => 'option',
					'transport'         => 'refresh',
				),
				'auto_load_next_post_on_load_event' => array(
					'capability'        => 'edit_theme_options',
					'default'           => $settings['alnp_on_load_event'],
					'transport'         => 'postMessage',
					'type'              => 'option',
				),
				'auto_load_next_post_on_entering_event' => array(
					'capability'        => 'edit_theme_options',
					'default'           => $settings['alnp_on_entering_event'],
					'transport'         => 'postMessage',
					'type'              => 'option',
				),
			) );
		} // END alnp_get_customizer_settings()

		/**
		 * Get Customizer controls for Auto Load Next Post.
		 *
		 * @access  public
		 * @since   1.5.0
		 * @version 1.6.0
		 * @return  array
		 */
		public function alnp_get_customizer_controls() {
			/**
			 * Filter Customizer controls for Auto Load Next Post.
			 *
			 * @param array $controls Customizer controls to add.
			 */
			return apply_filters( 'alnp_get_customizer_controls', array(
				'alnp_content_container' => array(
					'class'       => 'WP_Customize_Control',
					'label'       => esc_html__( 'Content Container', 'auto-load-next-post' ),
					'description' => sprintf( __( 'The primary container where the post content is loaded in. Default: %s', 'auto-load-next-post' ), '<code>main.site-main</code>' ),
					'section'     => 'auto_load_next_post_theme_selectors',
					'settings'    => 'auto_load_next_post_content_container',
					'type'        => 'text',
				),
				'alnp_title_selector' => array(
					'class'       => 'WP_Customize_Control',
					'label'       => esc_html__( 'Post Title Selector', 'auto-load-next-post' ),
					'description' => sprintf( __( 'Used to identify which article the user is reading and track should Google Analytics or other analytics be enabled. Default: %s', 'auto-load-next-post' ), '<code>h1.entry-title</code>' ),
					'section'     => 'auto_load_next_post_theme_selectors',
					'settings'    => 'auto_load_next_post_title_selector',
					'type'        => 'text',
				),
				'alnp_navigation_container' => array(
					'class'       => 'WP_Customize_Control',
					'label'       => esc_html__( 'Post Navigation Container', 'auto-load-next-post' ),
					'description' => sprintf( __( 'Used to identify which post to load next if any. Default: %s', 'auto-load-next-post' ), '<code>nav.post-navigation</code>' ),
					'section'     => 'auto_load_next_post_theme_selectors',
					'settings'    => 'auto_load_next_post_navigation_container',
					'type'        => 'text',
				),
				'alnp_comments_container' => array(
					'class'       => 'WP_Customize_Control',
					'label'       => esc_html__( 'Comments Container', 'auto-load-next-post' ),
					'description' => sprintf( __( 'Used to remove comments if enabled under %1$sMisc%2$s settings. Default: %3$s', 'auto-load-next-post' ), '<strong><a href="javascript:wp.customize.section( \'auto_load_next_post_misc\' ).focus();">', '</a></strong>', '<code>div#comments</code>' ),
					'section'     => 'auto_load_next_post_theme_selectors',
					'settings'    => 'auto_load_next_post_comments_container',
					'type'        => 'text',
				),
				'alnp_remove_comments' => array(
					'class'       => 'WP_Customize_Control',
					'label'       => esc_html__( 'Remove Comments', 'auto-load-next-post' ),
					'description' => esc_html__( 'Enable to remove comments when each post loads including the initial post.', 'auto-load-next-post' ),
					'section'     => 'auto_load_next_post_misc',
					'settings'    => 'auto_load_next_post_remove_comments',
					'type'        => 'checkbox',
				),
				'alnp_google_analytics' => array(
					'class'       => 'WP_Customize_Control',
					'label'       => esc_html__( 'Update Google Analytics', 'auto-load-next-post' ),
					'description' => esc_html__( 'Enable to track each post the visitor is reading. This will count as a pageview. You must already have Google Analytics setup.', 'auto-load-next-post' ),
					'section'     => 'auto_load_next_post_misc',
					'settings'    => 'auto_load_next_post_google_analytics',
					'type'        => 'checkbox',
				),
				'alnp_js_footer' => array(
					'class'       => 'WP_Customize_Control',
					'label'       => esc_html__( 'JavaScript in Footer?', 'auto-load-next-post' ),
					'description' => esc_html__( 'Enable to load Auto Load Next Post in the footer instead of the header. Can be useful to optimize your site.', 'auto-load-next-post' ),
					'section'     => 'auto_load_next_post_misc',
					'settings'    => 'auto_load_next_post_load_js_in_footer',
					'type'        => 'checkbox',
				),
				'alnp_disable_on_mobile' => array(
					'class'       => 'WP_Customize_Control',
					'label'       => esc_html__( 'Disable for Mobile?', 'auto-load-next-post' ),
					'description' => sprintf( esc_html__( 'Enable to disable %s from running on mobile devices.', 'auto-load-next-post' ), esc_html__( 'Auto Load Next Post', 'auto-load-next-post' ) ),
					'section'     => 'auto_load_next_post_misc',
					'settings'    => 'auto_load_next_post_disable_on_mobile',
					'type'        => 'checkbox',
				),
				'alnp_on_load_event' => array(
					'class'       => 'WP_Customize_Control',
					'label'       => esc_html__( 'Post loaded', 'auto-load-next-post' ),
					'description' => esc_html__( 'Events listed here will be triggered after a new post has loaded.', 'auto-load-next-post' ),
					'section'     => 'auto_load_next_post_events',
					'settings'    => 'auto_load_next_post_on_load_event',
					'type'        => 'textarea',
				),
				'alnp_on_entering_event' => array(
					'class'       => 'WP_Customize_Control',
					'label'       => esc_html__( 'Entering a Post', 'auto-load-next-post' ),
					'description' => esc_html__( 'Events listed here will be triggered when entering a post.', 'auto-load-next-post' ),
					'section'     => 'auto_load_next_post_events',
					'settings'    => 'auto_load_next_post_on_entering_event',
					'type'        => 'textarea',
				),
			) );
		} // END alnp_get_customizer_controls()

		/**
		 * Validates the content container theme selector to not be empty.
		 *
		 * @access public
		 * @since  1.5.0
		 * @param  WP_Error $validity Validity.
		 * @param  string   $value    Value, normally pre-sanitized.
		 * @return WP_Error $validity
		 */
		public function alnp_validate_content_container_selector( $validity, $value ) {
			if ( empty( $value ) ) {
				$validity->add( 'required', esc_html__( 'The content container selector is empty. Will not know where to load posts without it.', 'auto-load-next-post' ) );
			}

			return $validity;
		} // END alnp_validate_content_container_selector()

		/**
		 * Validates the post title theme selector to not be empty.
		 *
		 * @access public
		 * @since  1.5.0
		 * @param  WP_Error $validity Validity.
		 * @param  string   $value    Value, normally pre-sanitized.
		 * @return WP_Error $validity
		 */
		public function alnp_validate_post_title_selector( $validity, $value ) {
			if ( empty( $value ) ) {
				$validity->add( 'required', esc_html__( 'The post title selector is empty. Will not be able to identify which article the user is reading.', 'auto-load-next-post' ) );
			}

			return $validity;
		} // END alnp_validate_post_title_selector()

		/**
		 * Validates the post navigation theme selector to not be empty.
		 *
		 * @access public
		 * @since  1.5.0
		 * @param  WP_Error $validity Validity.
		 * @param  string   $value    Value, normally pre-sanitized.
		 * @return WP_Error $validity
		 */
		public function alnp_validate_post_navigation_selector( $validity, $value ) {
			if ( empty( $value ) ) {
				$validity->add( 'required', esc_html__( 'The post navigation container selector is empty. Required so ALNP can look up the next post to load.', 'auto-load-next-post' ) );
			}

			return $validity;
		} // END alnp_validate_post_navigation_selector()

		/**
		 * Return Auto Load Next Post settings.
		 *
		 * @access  public
		 * @since   1.5.0
		 * @version 1.6.0
		 * @return  array $args
		 */
		public function alnp_get_settings() {
			$args = array(
				'alnp_content_container'      => get_option( 'auto_load_next_post_content_container' ),
				'alnp_title_selector'         => get_option( 'auto_load_next_post_title_selector' ),
				'alnp_navigation_container'   => get_option( 'auto_load_next_post_navigation_container' ),
				'alnp_previous_post_selector' => get_option( 'auto_load_next_post_previous_post_selector' ),
				'alnp_comments_container'     => get_option( 'auto_load_next_post_comments_container' ),
				'alnp_remove_comments'        => get_option( 'auto_load_next_post_remove_comments' ),
				'alnp_google_analytics'       => get_option( 'auto_load_next_post_google_analytics' ),
				'alnp_js_footer'              => get_option( 'auto_load_next_post_load_js_in_footer' ),
				'alnp_disable_on_mobile'      => get_option( 'auto_load_next_post_disable_on_mobile' ),
				'alnp_on_load_event'          => get_option( 'auto_load_next_post_on_load_event' ),
				'alnp_on_entering_event'      => get_option( 'auto_load_next_post_on_entering_event' ),
			);

			return $args;
		} // END alnp_get_settings()

		/**
		 * Returns true or false if the page is ready for Auto Load Next Post
		 * panel to show in the customizer.
		 *
		 * @access public
		 * @since  1.5.0
		 * @return boolean
		 */
		public function is_page_alnp_ready() {
			if ( is_front_page() && is_home() ) {
				return false;
			} elseif ( is_front_page() ) {
				return false;
			} elseif ( is_home() ) {
				return true;
			} elseif ( is_singular( apply_filters( 'alnp_customizer_posts_ready', array( 'post' ) ) ) ) {
				return true;
			}

			return true;
		} // END is_page_alnp_ready()

		/**
		 * Sanitize the checkbox options.
		 *
		 * @access public
		 * @since  1.6.0
		 * @param  bool $input
		 * @return string
		 */
		public function sanitize_checkbox( $input ) {
			return ( $input === true ) ? 'yes' : 'no';
		} // END sansitize_checkbox()

	} // END Class

} // END if class

new ALNP_Customizer();