diff --git a/includes/admin.php b/includes/admin.php new file mode 100644 index 0000000..d55d0bb --- /dev/null +++ b/includes/admin.php @@ -0,0 +1,349 @@ + array( + 'parent_slug' => 'genesis', + 'page_title' => __( 'Genesis - Simple Sidebars', 'ss' ), + 'menu_title' => __( 'Simple Sidebars', 'ss' ) + ) + ); + + //* Empty, as we'll be building the page manually + $page_ops = array(); + + $settings_field = SS_SETTINGS_FIELD; + + $this->create( $page_id, $menu_ops, $page_ops, $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() { + + $_sidebars = get_option( $this->settings_field ); + + echo '
'; + + if ( isset( $_REQUEST['action'] ) && 'edit' == $_REQUEST['action'] ) + require_once( SS_PLUGIN_DIR . '/includes/views/edit.php' ); + else + require_once( SS_PLUGIN_DIR . '/includes/views/main.php' ); + + echo '
'; + + } + + /** + * 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; + + ?> + + > + + %s', admin_url('admin.php?page=simple-sidebars&action=edit&id=' . esc_html( $id ) ), esc_html( $info['name'] ), esc_html( $info['name'] ) ); + } else { + printf( '%s', esc_html( $info['name'] ) ); + } + ?> + + +
+
+ | + +
+ + + + + + + + create_sidebar( $_POST['new_sidebar'] ); + } + + /** + * This section will handle the data if a sidebar is deleted + */ + if ( isset( $_REQUEST['action'] ) && 'delete' == $_REQUEST['action'] && isset( $_REQUEST['id'] ) ) { + $this->delete_sidebar( $_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'] ) ) { + $this->edit_sidebar( $_POST['edit_sidebar'] ); + } + + } + + /** + * 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 = '

%s

'; + + if ( isset( $_REQUEST['created'] ) && 'true' === $_REQUEST['created'] ) { + printf( $pattern, __( 'New sidebar successfully created!', 'ss' ) ); + return; + } + + if ( isset( $_REQUEST['edited'] ) && 'true' === $_REQUEST['edited'] ) { + printf( $pattern, __( 'Sidebar successfully edited!', 'ss' ) ); + return; + } + + if ( isset( $_REQUEST['deleted'] ) && 'true' === $_REQUEST['deleted'] ) { + printf( $pattern, __( 'Sidebar successfully deleted.', 'ss' ) ); + return; + } + + return; + + } + + /** + * Create a sidebar. + * + * @since 1.0.0 + * + */ + protected function create_sidebar( $args = array() ) { + + if ( empty( $args['name'] ) || empty( $args['id'] ) ) { + wp_die( $this->error( 1 ) ); + exit; + } + + //* nonce verification + check_admin_referer( 'simple-sidebars-action_create-sidebar' ); + + //* WP changes a numeric sidebar id to sidebar-id which makes it inaccessible to the user + if ( is_numeric( $args['id'] ) ) + $args['id'] = sanitize_title_with_dashes( $args['name'] ); + + $db = (array) get_option( SS_SETTINGS_FIELD ); + $new = array( + sanitize_title_with_dashes( $args['id'] ) => array( + 'name' => esc_html( $args['name'] ), + 'description' => esc_html( $args['description'] ) + ) + ); + + if ( array_key_exists( $args['id'], $db ) ) { + wp_die( $this->error( 2 ) ); + exit; + } + + $_sidebars = wp_parse_args( $new, $db ); + + update_option( SS_SETTINGS_FIELD, $_sidebars ); + wp_redirect( admin_url( 'admin.php?page=simple-sidebars&created=true' ) ); + exit; + + } + + /** + * Edit a sidebar. + * + * @since 1.0.0 + * + */ + protected function edit_sidebar( $args = array() ) { + + if ( empty( $args['name'] ) || empty( $args['id'] ) ) { + wp_die( $this->error( 3 ) ); + exit; + } + + //* nonce verification + check_admin_referer( 'simple-sidebars-action_edit-sidebar' ); + + //* WP changes a numeric sidebar id to sidebar-id which makes it inaccessible to the user + if ( is_numeric( $args['id'] ) ) + $args['id'] = sanitize_title_with_dashes( $args['name'] ); + + $db = (array) get_option( SS_SETTINGS_FIELD ); + $new = array( + sanitize_title_with_dashes( $args['id'] ) => array( + 'name' => esc_html( $args['name'] ), + 'description' => esc_html( $args['description'] ) + ) + ); + + if ( ! array_key_exists( $args['id'], $db ) ) { + wp_die( $this->error( 3 ) ); + exit; + } + + $_sidebars = wp_parse_args( $new, $db ); + + update_option( SS_SETTINGS_FIELD, $_sidebars ); + wp_redirect( admin_url( 'admin.php?page=simple-sidebars&edited=true' ) ); + exit; + + } + + /** + * Delete a sidebar. + * + * @since 1.0.0 + * + */ + protected function delete_sidebar( $id = '' ) { + + if ( empty( $id ) ) { + wp_die( $this->error( 4 ) ); + exit; + } + + //* nonce verification + check_admin_referer( 'simple-sidebars-action_delete-sidebar' ); + + $_sidebars = (array) get_option( SS_SETTINGS_FIELD ); + + if ( ! isset( $_sidebars[$id] ) ) { + wp_die( $this->error( 4 ) ); + exit; + } + + unset( $_sidebars[$id] ); + + update_option( SS_SETTINGS_FIELD, $_sidebars ); + wp_redirect( admin_url( 'admin.php?page=simple-sidebars&deleted=true' ) ); + exit; + + } + + /** + * Returns an error message by 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 and ID for this sidebar', 'ss' ); + break; + case 2: + return __( 'Oops! That sidebar ID already exists', 'ss' ); + break; + case 3: + return __( 'Oops! You are trying to edit a sidebar that does not exist, or is not editable', 'ss' ); + break; + case 4: + return __( 'Oops! You are trying to delete a sidebar that does not exist, or cannot be deleted', 'ss' ); + break; + default: + return __( 'Oops! Something went wrong. Try again.', 'ss' ); + + } + + } + +} + +add_action( 'genesis_admin_menu', 'simplesidebars_settings_menu' ); +/** + * Instantiate the class to create the menu. + * + * @since 1.0.0 + */ +function simplesidebars_settings_menu() { + + new Genesis_Simple_Sidebars_Admin; + +} diff --git a/includes/inpost.php b/includes/inpost.php new file mode 100644 index 0000000..c1fb2ce --- /dev/null +++ b/includes/inpost.php @@ -0,0 +1,102 @@ + true ) ) as $type ) { + + if ( post_type_supports( $type, 'genesis-simple-sidebars' ) || $type == 'post' || $type == 'page' ) { + add_meta_box( 'ss_inpost_metabox', __( 'Sidebar Selection', 'ss' ), 'ss_inpost_metabox', $type, 'side', 'low' ); + } + + } + +} + +function ss_inpost_metabox() { + + $_sidebars = stripslashes_deep( get_option( SS_SETTINGS_FIELD ) ); + global $wp_registered_sidebars; + +?> + + + + + +

+ + +

+ +

+ + +

+ +ID; + + //* don't try to save the data under autosave, ajax, or future post. + if ( defined('DOING_AUTOSAVE') && DOING_AUTOSAVE ) return; + if ( defined('DOING_AJAX') && DOING_AJAX ) return; + if ( defined('DOING_CRON') && DOING_CRON ) return; + + //* is the user allowed to edit the post or page? + if ( ( 'page' == $_POST['post_type'] && ! current_user_can( 'edit_page', $post->ID ) ) || ! current_user_can( 'edit_post', $post->ID ) ) + return $post->ID; + + $_sidebars = array( + '_ss_sidebar' => $_POST['_ss_sidebar'], + '_ss_sidebar_alt' => $_POST['_ss_sidebar_alt'], + ); + + //* store the custom fields + foreach ( $_sidebars as $key => $value ) { + + //* don't try to store data during revision save + if ( 'revision' === $post->post_type ) + return; + + if ( $value ) { + update_post_meta($post->ID, $key, $value); + } else { + delete_post_meta($post->ID, $key); + } + + } + +} diff --git a/includes/term.php b/includes/term.php new file mode 100644 index 0000000..c11332e --- /dev/null +++ b/includes/term.php @@ -0,0 +1,69 @@ +meta = wp_parse_args( $tag->meta, array( '_ss_sidebar' => '', '_ss_sidebar_alt' => '' ) ); + + // Pull custom sidebars + $_sidebars = stripslashes_deep( get_option( SS_SETTINGS_FIELD ) ); + +?> + +

+ + + + + + + + + + + + +
+ +
+ +
+ + +

+ +
+ + + + + + + + + + + + + + + + + + + +
+

+ + +

+ +

+ +
diff --git a/includes/views/main.php b/includes/views/main.php new file mode 100644 index 0000000..721676e --- /dev/null +++ b/includes/views/main.php @@ -0,0 +1,70 @@ + +

+ +
+ +
+
+ +

+ + + + + + + + + + + + + + + + + + + + table_rows(); ?> + + +
+ +
+
+ +
+
+ + +
+

+ +
+ + +
+ + +

+
+ +
+ + +

+
+ +
+ + +
+ +

+
+ +
+
+ +
\ No newline at end of file diff --git a/plugin.php b/plugin.php new file mode 100644 index 0000000..e06e240 --- /dev/null +++ b/plugin.php @@ -0,0 +1,239 @@ +=' ) ) + ss_deactivate( '2.0.0', '3.6' ); + +} + +/** + * Deactivate Simple Sidebars. + * + * This function deactivates Simple Sidebars. + * + * @since 1.0.0 + */ +function ss_deactivate( $genesis_version = '1.8.0', $wp_version = '3.3' ) { + + deactivate_plugins( plugin_basename( __FILE__ ) ); + wp_die( sprintf( __( 'Sorry, you cannot run Simple Sidebars without WordPress %s and Genesis %s, or greater.', 'ss' ), $wp_version, 'http://my.studiopress.com/?download_id=91046d629e74d525b3f2978e404e7ffa', $genesis_version ) ); + +} + +add_action( 'genesis_init', 'ss_genesis_init', 12 ); +/** + * Plugin initialization. + * + * Initialize the plugin, set the constants, hook callbacks to actions, and include the plugin library. + * + * @since 0.9.0 + */ +function ss_genesis_init() { + + //* Deactivate if not running Genesis 1.8.0 or greater + if ( ! class_exists( 'Genesis_Admin_Boxes' ) ) + add_action( 'admin_init', 'ss_deactivate', 10, 0 ); + + //* Load translations + load_plugin_textdomain( 'ss', false, 'genesis-simple-sidebars/languages' ); + + //* required hooks + add_action( 'get_header', 'ss_sidebars_init' ); + add_action( 'widgets_init', 'ss_register_sidebars' ); + + //* The rest is admin stuff, so load only if we're in the admin area + if ( ! is_admin() ) + return; + + //* Include admin files + require_once( SS_PLUGIN_DIR . '/includes/admin.php' ); + require_once( SS_PLUGIN_DIR . '/includes/inpost.php' ); + require_once( SS_PLUGIN_DIR . '/includes/term.php' ); + + //* let the child theme hook the genesis_simple_sidebars_taxonomies filter before hooking term edit + add_action( 'init', 'ss_term_edit_init' ); + +} +/** + * Register widget areas. + * + * This function registers the created sidebars as widget areas + * + * @since 0.9.0 + */ +function ss_register_sidebars() { + + $_sidebars = stripslashes_deep( get_option( SS_SETTINGS_FIELD ) ); + + //* If no sidebars have been created, do nothing + if ( ! $_sidebars ) + return; + + //* Cycle through created sidebars, register them as widget areas + foreach ( (array) $_sidebars as $id => $info ) { + + genesis_register_sidebar( array( + 'name' => esc_html( $info['name'] ), + 'id' => $id, + 'description' => esc_html( $info['description'] ), + 'editable' => 1, + ) ); + + } + +} + +/** + * Use custom sidebars. + * + * Remove the default sidebars, run some conditional logic, + * use alternate sidebars if necessary, else fallback on default sidebars. + * + * @since 0.9.0 + */ +function ss_sidebars_init() { + + remove_action( 'genesis_sidebar', 'genesis_do_sidebar' ); + remove_action( 'genesis_sidebar_alt', 'genesis_do_sidebar_alt' ); + add_action( 'genesis_sidebar', 'ss_do_sidebar' ); + add_action( 'genesis_sidebar_alt', 'ss_do_sidebar_alt' ); + +} + +/** + * Display primary sidebar. + * + * Display custom sidebar if one exists, else display default primary sidebar. + * + * @since 0.9.0 + */ +function ss_do_sidebar() { + + if ( ! ss_do_one_sidebar( '_ss_sidebar' ) ) + genesis_do_sidebar(); + +} + +/** + * Display secondary sidebar. + * + * Display custom sidebar if one exists, else display default secondary sidebar. + * + * @since 0.9.0 + */ +function ss_do_sidebar_alt() { + + if ( ! ss_do_one_sidebar( '_ss_sidebar_alt' ) ) + genesis_do_sidebar_alt(); + +} + +/** + * Sidebar widget area output. + * + * Helper function to show widgets in a particular sidebar. + * + * @param string $sidebar_key sidebar id you wish to output. + * + * @since 0.9.0 + * + */ +function ss_do_one_sidebar( $sidebar_key = '_ss_sidebar' ) { + + static $taxonomies = null; + + if ( is_singular() && $sidebar_key = genesis_get_custom_field( $sidebar_key ) ) { + if ( dynamic_sidebar( $sidebar_key ) ) return true; + } + + if ( is_category() ) { + $term = get_term( get_query_var( 'cat' ), 'category' ); + if ( isset( $term->meta[$sidebar_key] ) && dynamic_sidebar( $term->meta[$sidebar_key] ) ) return true; + } + + if ( is_tag() ) { + $term = get_term( get_query_var( 'tag_id' ), 'post_tag' ); + if ( isset( $term->meta[$sidebar_key] ) && dynamic_sidebar( $term->meta[$sidebar_key] ) ) return true; + } + + if ( is_tax() ) { + if ( null === $taxonomies ) + $taxonomies = ss_get_taxonomies(); + + foreach ( $taxonomies as $tax ) { + if ( 'post_tag' == $tax || 'category' == $tax ) + continue; + + if ( is_tax( $tax ) ) { + $obj = get_queried_object(); + $term = get_term( $obj->term_id, $tax ); + if ( isset( $term->meta[$sidebar_key] ) && dynamic_sidebar( $term->meta[$sidebar_key] ) ) return true; + break; + } + } + } + + return false; + +} + +/** + * Return taxonomy ids. + * + * Helper function to return the array keys from a taxonomy query. + * + * @since 0.9.0 + */ +function ss_get_taxonomies() { + + $taxonomies = get_taxonomies( array( 'show_ui' => true, 'public' => true ) ); + return apply_filters( 'genesis_simple_sidebars_taxonomies', array_keys( $taxonomies ) ); + +} + +/** + * Does this Genesis install have the 3 column layouts deactivated? + * + * This function checks to see if the Genesis install still has active 3 column layouts. Since + * child themes and plugins can deregister layouts, we need to know if they have deregistered the 3 column layouts. + * + * @since 0.9.2 + */ +function ss_has_3_column_layouts() { + + $_layouts = (array) genesis_get_layouts(); + $_layouts = array_keys( $_layouts ); + $_3_column = array_intersect( $_layouts, array( 'content-sidebar-sidebar', 'sidebar-content-sidebar', 'sidebar-sidebar-content' ) ); + + return ! empty( $_3_column ); + +} diff --git a/readme.txt b/readme.txt new file mode 100644 index 0000000..4cb17d4 --- /dev/null +++ b/readme.txt @@ -0,0 +1,73 @@ +=== Plugin Name === +Contributors: nathanrice, wpmuguru +Donate link: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=5553118 +Tags: hooks, genesis, genesiswp, studiopress +Requires at least: 3.6 +Tested up to: 3.6 +Stable tag: 2.0.1 + +This plugin allows you to create multiple, dynamic widget areas, and assign those widget areas to sidebar locations within the Genesis Framework on a per post, per page, or per tag/category archive basis. + +== Description == + +This plugin allows you to create multiple, dynamic widget areas, and assign those widget areas to sidebar locations within the Genesis Framework on a per post, per page, or per tag/category archive basis. + +Creating widget areas programmatically, then using conditional logic to properly assign them to sidebar locations can be a complex task for a beginner. This plugin allows you to do all this from a simple administration menu, and assign widget areas to sidebar locations with simple drop-down menus within the post/page edit screens, or when editing a tag or category. + +== Installation == + +1. Upload the entire `genesis-simple-sidebars` folder to the `/wp-content/plugins/` directory +1. DO NOT change the name of the `genesis-simple-sidebars` folder +1. Activate the plugin through the 'Plugins' menu in WordPress +1. Navigate to the `Genesis > Simple Sidebars` menu +1. Create as many new sidebar widget areas as you need +1. Choose the widget area you want to display by choosing it from the drop-down menu in the post/page or category/tag edit screen. + +== Frequently Asked Questions == + += Can I assign widget areas to locations other than the sidebars? = + +No. You can only assign them to the primary and secondary sidebars, using the plugin. + +However, once a widget area has been created, you can use hooks to programmatically display those widget areas throughout the theme. But if you're going to do that, it's very unlikely that you would want to use the plugin to create the widget areas. You might as well just create the widget areas programmatically too. + += Does this plugin give me the option of creating an entirely NEW sidebar? = + +Not in the way you're probably thinking. The markup surrounding the widget area never changes. The only thing that changes is the dynamic content that displays within the pre-existing sidebar locations. + +== Changelog == + += 0.1 = +* Initial Alpha Release + += 0.9 = +* Fixed "is not array" errors reported by users +* Added nonce verification for security purposes +* Added error and success messages +* Bump to pre-release 0.9 branch + += 0.9.1 = +* Added support for custom post types + += 0.9.2 = +* Added support for custom taxonomies +* Added translation support +* bug fix to prevent invalid sidebar creation + += 0.9.2.1 = +* Restore default tag/category support +* Default custom taxonomy support to on for public taxonomies +* Remove secondary selection when no 3 column layouts are enabled + += 1.0.0 = +* Reorganize theme files +* Standards + += 2.0.0 = +* Compatibility with Genesis 2.0 +* Standards + += 2.0.1 = +* Genesis 2.0.1 compatibility with term meta keys +* Use actual sidebar name, instead of hard coded names +* Fix incorrect textdomain \ No newline at end of file