wp-cms-widget-control.php

<?php
/*
 Plugin Name: WP-CMS Widget Control
 Plugin URI: http://wp-cms.com
 Description: Remove any core, theme or plugin widget from the Widgets setting screen.
 Author: Jonny Allbut
 Version: 1.21
 Author URI: http://jonnya.net
*/

/*

/////////  VERSION HISTORY

1.21	- WordPress 4.4 full compatiblity check and text tidying
1.2		- WordPress 4.3.x fix compatibility (also Customizer support)
1.1		- Minor tweaks, fix translation text domain 'wpcms-widget-setting'
1.0		- First release

*/


/**
 *
 * Execute plugin
 *
 */
function wpcms_wc_admin_do() {
	$wpcms_wc_admin_do = ( is_admin() || is_customize_preview() ) ? new wpcms_widget_control : '';
}
add_action( 'after_setup_theme','wpcms_wc_admin_do', 11 );


/**
 *
 * All the widget control functionality
 *
 */
class wpcms_widget_control {


	var $plugin; /* Common plugin definition */
	var $widget_data; /* Saved options */
	var $widgets_available; /* Holds master array of all core WP widget data */


	function __construct() {

		// Setup data
		$this->plugin = 'wpcms-widget-setting';
	    $this->widget_data = get_option( $this->plugin );
		$this->widgets_available = ( isset($GLOBALS['wp_widget_factory']) ) ? $GLOBALS['wp_widget_factory'] : '';

		// Do it
		add_action( 'admin_init', array($this,'settings_init') );
		add_action( 'admin_menu', array($this,'admin_menu') );
		add_action( 'widgets_init', array($this,'unregister_widgets'), 11 );

	}


	/**
	 *
	 * Returns a cleaner array of widget data for use
	 *
	 */
	function get_widgets() {

		$clean_array = '';

		if ( is_array($this->widgets_available->widgets) && !empty($this->widgets_available->widgets) ){
			foreach ( $this->widgets_available->widgets as $key => $value ) {
				$clean_array[$key]['nice_name'] = $value->name;
				$clean_array[$key]['description'] = $value->widget_options['description'];
			}
		}

		return($clean_array);

	}


	/**
	 *
	 * Adds admin menu
	 *
	 */
	function admin_menu() {

	    add_options_page(
	    	esc_html__( 'Widget Control', 'wpcms-widget-setting' ),
	    	esc_html__( 'Widget Control', 'wpcms-widget-setting' ),
	    	'manage_options',
	    	$this->plugin,
	    	array( $this,'admin_page' )
		);

	}


	/**
	 *
	 * Renders admin menu
	 *
	 */
	function admin_page(){

		global $pagenow;


		echo '<div class="wrap">';
		echo '<h2>' . esc_html__( 'WP-CMS Widget Control', 'wpcms-widget-setting' ) . '</h2>';

		echo '<form action="options.php" method="POST">';
		submit_button( esc_html__('Update widget settings', 'wpcms-widget-setting') );
		settings_fields( $this->plugin . 'group1' );
		do_settings_sections( $this->plugin . 'section1' );
		submit_button( esc_html__('Update widget settings', 'wpcms-widget-setting' ) );

		echo '</form>';
		echo '</div>';

	}


	/**
	 *
	 * WP Settings API init
	 *
	 */
	function settings_init() {

		register_setting( $this->plugin . 'group1', $this->plugin, array($this,'sanitize_data') );
	    add_settings_section( 'form-section-one', null, array($this,'section_one_callback'), $this->plugin . 'section1' );

		$widgets = $this->get_widgets();

		if ( !empty($widgets) ){

			foreach ($widgets as $key => $value) {
				add_settings_field(
					$this->plugin . '[' . $key . ']',
					$value['nice_name'],
					array($this,'field_builder'),
					$this->plugin . 'section1',
					'form-section-one',
					array(
						'name' => $value['nice_name'],
						'desc' => ( !empty($value['description']) ) ? $value['description'] : '',
						'def' => $key
					)
				);

			}

		}

	}


	/**
	 *
	 * Settings section intro
	 *
	 */
	function section_one_callback() {

		echo '<p>';
		esc_html_e( 'Tick the relevant checkbox below to REMOVE the selected widget from the widget admin area and theme customizer.', 'wpcms-widget-setting' );
		echo '</p>';
		echo '<p><strong>';
		esc_html_e( 'WARNING - DO NOT REMOVE WIDGETS YOU ARE CURRENTLY USING - you risk deleting them (and their settings) from your site - so PLEASE use this with caution!', 'wpcms-widget-setting' );
		echo '</strong></p>';
	}


	/**
	 *
	 * Common settings field builder
	 *
	 */
	function field_builder($args) {

		$data = ( !empty($this->widget_data) && array_key_exists($args['def'], $this->widget_data) ) ? $this->widget_data[$args['def']] : false;

		echo '<input name="' . $this->plugin . '[' . $args['def'] . ']" ';
		echo 'id="' . esc_attr($args['desc'] ) . '[' . $args['def'] . '" ';
		echo 'type="checkbox" value="1" ' . checked( 1, $data, false ) . ' /> ';
		echo '<span class="description">' . esc_html($args['desc'] ) . '</span>';

	}


	/**
	 *
	 * Sanitize input before saving like any good plugin should!
	 *
	 */
	function sanitize_data($input) {

		$clean_data = array();

		if ( !empty($input) && is_array($input) ){
			foreach ( $input as $key => $value ) {
				$clean_data[$key] = ( $value == 1 ) ? $value : 0;
			}
		}

		return $clean_data;

	}


	/**
	 *
	 * Remove those pesky widgets
	 *
	 */
	function unregister_widgets() {

		global $pagenow;

		if ( (is_customize_preview() || $pagenow == 'widgets.php') && is_array($this->widget_data) ){
			foreach ( $this->widget_data as $widget => $value ) {
				unregister_widget($widget);
			}
		}

	}

}
?>