genesis-simple-sidebars/includes/class-genesis-simple-sidebars-admin.php

<?php
/**
 * Controls the creation, deletion, and editing of Simple Sidebar.
 *
 * @author StudioPress
 * @package genesis-simple-sidebars
 */

/**
 * Registers a new admin page, providing content and corresponding menu item
 * for the Genesis Simple Sidebars plugin.
 *
 * @since 1.0.0
 */
class Genesis_Simple_Sidebars_Admin extends Genesis_Admin_Basic {

	/**
	 * Settings field.
	 *
	 * @var string
	 *
	 * @since 2.1.0
	 */
	public $settings_field;

	/**
	 * Constructor.
	 */
	public function __construct() {

		$this->settings_field = Genesis_Simple_Sidebars()->settings_field;

		// For backward compatibility.
		define( 'SS_SETTINGS_FIELD', $this->settings_field );

	}

	/**
	 * Create an admin menu item and settings page.
	 *
	 * @since 1.0.0
	 *
	 * @uses Genesis_Admin::create() Register the admin page
	 *
	 * @see Genesis_Admin_Import_Export::actions() Handle creating, editing, and deleting sidebars.
	 */
	public function admin_menu() {

		$page_id = 'simple-sidebars';

		$menu_ops = array(
			'submenu' => array(
				'parent_slug' => 'genesis',
				'page_title'  => __( 'Genesis - Simple Sidebars', 'genesis-simple-sidebars' ),
				'menu_title'  => __( 'Simple Sidebars', 'genesis-simple-sidebars' ),
			),
		);

		// Empty, as we'll be building the page manually.
		$page_ops = array();

		$this->create( $page_id, $menu_ops, $page_ops, $this->settings_field );

		// Simpe Sidebar actions (create, edit, or delete).
		add_action( 'admin_init', array( $this, 'actions' ) );

	}

	/**
	 * Callback for displaying the Simple Sidebars admin page.
	 *
	 * Echoes out HTML.
	 *
	 * @since 1.0.0
	 */
	public function admin() {

		echo '<div class="wrap">';

		// phpcs:ignore WordPress.Security.NonceVerification.NoNonceVerification
		if ( isset( $_REQUEST['action'] ) && 'edit' === $_REQUEST['action'] ) {
			require_once GENESIS_SIMPLE_SIDEBARS_PLUGIN_DIR . '/includes/views/admin-edit.php';
		} else {
			require_once GENESIS_SIMPLE_SIDEBARS_PLUGIN_DIR . '/includes/views/admin-main.php';
		}

		echo '</div>';

	}

	/**
	 * Display sidebar table rows.
	 *
	 * Displays table rows of sidebars for viewing and editing on the main admin page.
	 *
	 * @since 1.0.0
	 */
	public function table_rows() {

		global $wp_registered_sidebars;

		$_sidebars = $wp_registered_sidebars;

		$alt = true;

		foreach ( (array) $_sidebars as $id => $info ) :

			$is_editable = isset( $info['editable'] ) && $info['editable'] ? true : false;

			?>

			<tr
			<?php
			if ( $alt ) {
				echo 'class="alternate"';
				$alt = false;
			} else {
				$alt = true; }
			?>
			>
				<td class="name column-name">
					<?php
					if ( $is_editable ) {
						printf( '<a class="row-title" href="%s" title="Edit %s">%s</a>', esc_url( admin_url( 'admin.php?page=simple-sidebars&amp;action=edit&amp;id=' . esc_html( $id ) ) ), esc_html( $info['name'] ), esc_html( $info['name'] ) );
					} else {
						printf( '<strong class="row-title">%s</strong>', esc_html( $info['name'] ) );
					}
					?>

					<?php if ( $is_editable ) : ?>
					<br />
					<div class="row-actions">
						<span class="edit"><a href="<?php echo esc_attr( admin_url( 'admin.php?page=simple-sidebars&amp;action=edit&amp;id=' . esc_html( $id ) ) ); ?>"><?php esc_html_e( 'Edit', 'genesis-simple-sidebars' ); ?></a> | </span>
						<span class="delete"><a class="delete-tag" href="<?php echo esc_attr( wp_nonce_url( admin_url( 'admin.php?page=simple-sidebars&amp;action=delete&amp;id=' . esc_html( $id ) ), 'simple-sidebars-action_delete-sidebar' ) ); ?>"><?php esc_html_e( 'Delete', 'genesis-simple-sidebars' ); ?></a></span>
					</div>
					<?php endif; ?>

				</td>
				<td class="slug column-slug"><?php echo esc_html( $id ); ?></td>
				<td class="description column-description"><?php echo esc_html( $info['description'] ); ?></td>
			</tr>

			<?php
		endforeach;

	}

	/**
	 * Action handler.
	 *
	 * Depending on what action was intended by the user, this method calls the appropriate action method.
	 *
	 * @since 1.0.0
	 */
	public function actions() {

		if ( ! genesis_is_menu_page( 'simple-sidebars' ) ) {
			return;
		}

		/**
		 * This section handles the data if a new sidebar is created
		 */
		// phpcs:disable WordPress.Security.NonceVerification.NoNonceVerification
		if ( isset( $_REQUEST['action'] ) && 'create' === $_REQUEST['action'] && isset( $_POST['new_sidebar'] ) ) {
			$this->create_sidebar( array_map( 'sanitize_text_field', wp_unslash( $_POST['new_sidebar'] ) ) );
		}

		/**
		 * This section will handle the data if a sidebar is deleted
		 */
		// phpcs:disable WordPress.Security.NonceVerification.NoNonceVerification
		if ( isset( $_REQUEST['action'] ) && 'delete' === $_REQUEST['action'] && isset( $_REQUEST['id'] ) ) {
			$this->delete_sidebar( sanitize_text_field( wp_unslash( $_REQUEST['id'] ) ) );
		}

		/**
		 * This section will handle the data if a sidebar is to be modified
		 */
		if ( isset( $_REQUEST['action'] ) && 'edit' === $_REQUEST['action'] && ! isset( $_REQUEST['id'] ) && isset( $_POST['edit_sidebar'] ) ) {
			$this->edit_sidebar( array_map( 'sanitize_text_field', wp_unslash( $_POST['edit_sidebar'] ) ) );
		}
		// phpcs:enable
	}

	/**
	 * Add custom notices that display when you successfully create, edit, or delete a sidebar.
	 *
	 * @since 1.0.0
	 *
	 * @return null Returns null if not on the correct admin page.
	 */
	public function notices() {

		if ( ! genesis_is_menu_page( 'simple-sidebars' ) ) {
			return;
		}

		$pattern = '<div id="message" class="updated"><p><strong>%s</strong></p></div>';

		// phpcs:disable WordPress.Security.NonceVerification.NoNonceVerification
		if ( isset( $_REQUEST['created'] ) && 'true' === $_REQUEST['created'] ) {
			printf( wp_kses_post( $pattern ), esc_html__( 'New sidebar successfully created!', 'genesis-simple-sidebars' ) );
			return;
		}

		if ( isset( $_REQUEST['edited'] ) && 'true' === $_REQUEST['edited'] ) {
			printf( wp_kses_post( $pattern ), esc_html__( 'Sidebar successfully edited!', 'genesis-simple-sidebars' ) );
			return;
		}

		if ( isset( $_REQUEST['deleted'] ) && 'true' === $_REQUEST['deleted'] ) {
			printf( wp_kses_post( $pattern ), esc_html__( 'Sidebar successfully deleted.', 'genesis-simple-sidebars' ) );
			return;
		}

	}

	/**
	 * Create a sidebar.
	 *
	 * @param array $args Arguments.
	 *
	 * @since 1.0.0
	 */
	protected function create_sidebar( $args = array() ) {
		if ( empty( $args['name'] ) ) {
			wp_die( esc_html( $this->error( 1 ) ) );
			exit;
		}

		// nonce verification.
		check_admin_referer( 'simple-sidebars-action_create-sidebar' );

		$db = (array) get_option( $this->settings_field );

		// Change empty or numeric IDs to the name, lowercased and separated by dashes.
		if ( empty( $args['id'] ) || is_numeric( $args['id'] ) ) {
			$args['id'] = $args['name'];
		}

		// Strip all but alphanumeric, sanitize with dashes.
		$id = preg_replace( '/[^a-zA-Z0-9 -]+/', '', sanitize_title_with_dashes( $args['id'] ) );

		// Preface numeric IDs with 'sidebar-'.
		$id = is_numeric( $id ) ? 'gss-sidebar-' . $id : $id;

		// If empty after all the sanitizing ...
		if ( ! $id || is_registered_sidebar( $id ) ) {
			$n = count( $db ) + 1;
			do {
				$n  = $n++;
				$id = 'gss-sidebar-' . $n;
			} while ( is_registered_sidebar( $id ) );
		}

		$new = array(
			$id => array(
				'name'        => esc_html( $args['name'] ),
				'description' => esc_html( $args['description'] ),
			),
		);

		if ( array_key_exists( $id, $db ) ) {
			wp_die( esc_html( $this->error( 2 ) ) );
			exit;
		}

		$_sidebars = wp_parse_args( $new, $db );

		update_option( $this->settings_field, $_sidebars );
		wp_safe_redirect( admin_url( 'admin.php?page=simple-sidebars&created=true' ) );
		exit;

	}

	/**
	 * Edit a sidebar.
	 *
	 * @param array $args Arguments.
	 * @since 1.0.0
	 */
	protected function edit_sidebar( $args = array() ) {

		if ( empty( $args['name'] ) || empty( $args['id'] ) ) {
			wp_die( esc_html( $this->error( 3 ) ) );
			exit;
		}

		// nonce verification.
		check_admin_referer( 'simple-sidebars-action_edit-sidebar' );

		$db  = (array) get_option( $this->settings_field );
		$new = array(
			$args['id'] => array(
				'name'        => esc_html( $args['name'] ),
				'description' => esc_html( $args['description'] ),
			),
		);

		if ( ! array_key_exists( $args['id'], $db ) ) {
			wp_die( esc_html( $this->error( 3 ) ) );
			exit;
		}

		$_sidebars = wp_parse_args( $new, $db );

		update_option( $this->settings_field, $_sidebars );
		wp_safe_redirect( admin_url( 'admin.php?page=simple-sidebars&edited=true' ) );
		exit;

	}

	/**
	 * Delete a sidebar.
	 *
	 * @param string $id Id.
	 * @since 1.0.0
	 */
	protected function delete_sidebar( $id = '' ) {
		if ( empty( $id ) ) {
			wp_die( esc_html( $this->error( 4 ) ) );
			exit;
		}

		// nonce verification.
		check_admin_referer( 'simple-sidebars-action_delete-sidebar' );

		$_sidebars = (array) get_option( $this->settings_field );

		if ( ! isset( $_sidebars[ $id ] ) ) {
			wp_die( esc_html( $this->error( 4 ) ) );
			exit;
		}

		unset( $_sidebars[ $id ] );

		update_option( $this->settings_field, $_sidebars );
		wp_safe_redirect( admin_url( 'admin.php?page=simple-sidebars&deleted=true' ) );
		exit;

	}

	/**
	 * Returns an error message by ID.
	 *
	 * @param bool $error Error id.
	 *
	 * @since 1.0.0
	 *
	 * @return string Returns an error string based on an error ID.
	 */
	protected function error( $error = false ) {

		if ( ! $error ) {
			return false;
		}

		switch ( (int) $error ) {

			case 1:
				return __( 'Oops! Please choose a valid Name for this sidebar', 'genesis-simple-sidebars' );
			case 2:
				return __( 'Oops! That sidebar ID already exists', 'genesis-simple-sidebars' );
			case 3:
				return __( 'Oops! You are trying to edit a sidebar that does not exist, or is not editable', 'genesis-simple-sidebars' );
			case 4:
				return __( 'Oops! You are trying to delete a sidebar that does not exist, or cannot be deleted', 'genesis-simple-sidebars' );
			default:
				return __( 'Oops! Something went wrong. Try again.', 'genesis-simple-sidebars' );

		}

	}

}