Files
genesis-simple-sidebars/plugin.php
T

240 lines
6.2 KiB
PHP
Raw Normal View History

2013-08-09 13:05:55 -04:00
<?php
/*
Plugin Name: Genesis Simple Sidebars
Plugin URI: http://www.studiopress.com/plugins/simple-sidebars
Description: Genesis Simple Sidebars allows you to easily create and use new sidebar widget areas.
Author: Nathan Rice
Author URI: http://www.nathanrice.net/
2013-08-09 13:11:17 -04:00
2013-08-09 13:07:35 -04:00
Text Domain: ss
Domain Path: /languages/
2013-08-09 13:11:17 -04:00
2013-08-09 13:43:39 -04:00
Version: 2.0.0
2013-08-09 13:11:17 -04:00
License: GNU General Public License v2.0 (or later)
License URI: http://www.opensource.org/licenses/gpl-license.php
2013-08-09 13:05:55 -04:00
*/
2013-08-09 13:11:17 -04:00
/** Define our constants */
define( 'SS_SETTINGS_FIELD', 'ss-settings' );
define( 'SS_PLUGIN_DIR', dirname( __FILE__ ) );
2013-08-09 13:05:55 -04:00
2013-08-09 13:11:17 -04:00
register_activation_hook( __FILE__, 'ss_activation_check' );
/**
* Activation hook callback.
*
* This functions runs when the plugin is activated. It checks to make sure the user is running
* a minimum Genesis version, so there are no conflicts or fatal errors.
*
* @since 0.9.0
*/
function ss_activation_check() {
2013-08-09 13:05:55 -04:00
2013-08-09 13:38:26 -04:00
if ( ! defined( 'PARENT_THEME_VERSION' ) || ! version_compare( PARENT_THEME_VERSION, '2.0.0', '>=' ) )
ss_deactivate( '2.0.0', '3.6' );
2013-08-09 13:05:55 -04:00
}
2013-08-09 13:07:35 -04:00
/**
2013-08-09 13:11:17 -04:00
* Deactivate Simple Sidebars.
*
* This function deactivates Simple Sidebars.
*
* @since 1.0.0
2013-08-09 13:07:35 -04:00
*/
2013-08-09 13:11:17 -04:00
function ss_deactivate( $genesis_version = '1.8.0', $wp_version = '3.3' ) {
deactivate_plugins( plugin_basename( __FILE__ ) );
2013-08-20 03:40:55 +01:00
wp_die( sprintf( __( 'Sorry, you cannot run Simple Sidebars without WordPress %s and <a href="%s">Genesis %s</a>, or greater.', 'ss' ), $wp_version, 'http://my.studiopress.com/?download_id=91046d629e74d525b3f2978e404e7ffa', $genesis_version ) );
2013-08-09 13:11:17 -04:00
}
2013-08-09 13:07:35 -04:00
add_action( 'genesis_init', 'ss_genesis_init', 12 );
2013-08-09 13:11:17 -04:00
/**
* Plugin initialization.
*
* Initialize the plugin, set the constants, hook callbacks to actions, and include the plugin library.
*
* @since 0.9.0
*/
2013-08-09 13:07:35 -04:00
function ss_genesis_init() {
2013-08-09 13:05:55 -04:00
2013-08-09 13:35:43 -04:00
//* Deactivate if not running Genesis 1.8.0 or greater
2013-08-09 13:11:17 -04:00
if ( ! class_exists( 'Genesis_Admin_Boxes' ) )
add_action( 'admin_init', 'ss_deactivate', 10, 0 );
2013-08-09 13:35:43 -04:00
//* Load translations
2013-08-09 13:11:17 -04:00
load_plugin_textdomain( 'ss', false, 'genesis-simple-sidebars/languages' );
2013-08-09 13:35:43 -04:00
//* required hooks
2013-08-09 13:07:35 -04:00
add_action( 'get_header', 'ss_sidebars_init' );
add_action( 'widgets_init', 'ss_register_sidebars' );
2013-08-09 13:11:17 -04:00
2013-08-09 13:35:43 -04:00
//* The rest is admin stuff, so load only if we're in the admin area
2013-08-09 13:11:17 -04:00
if ( ! is_admin() )
2013-08-09 13:07:35 -04:00
return;
2013-08-09 13:05:55 -04:00
2013-08-09 13:35:43 -04:00
//* Include admin files
2013-08-09 13:11:17 -04:00
require_once( SS_PLUGIN_DIR . '/includes/admin.php' );
require_once( SS_PLUGIN_DIR . '/includes/inpost.php' );
require_once( SS_PLUGIN_DIR . '/includes/term.php' );
2013-08-09 13:35:43 -04:00
//* let the child theme hook the genesis_simple_sidebars_taxonomies filter before hooking term edit
2013-08-09 13:07:35 -04:00
add_action( 'init', 'ss_term_edit_init' );
2013-08-09 13:11:17 -04:00
2013-08-09 13:07:35 -04:00
}
2013-08-09 13:05:55 -04:00
/**
2013-08-09 13:11:17 -04:00
* Register widget areas.
*
* This function registers the created sidebars as widget areas
*
* @since 0.9.0
2013-08-09 13:05:55 -04:00
*/
function ss_register_sidebars() {
2013-08-09 13:11:17 -04:00
2013-08-09 13:05:55 -04:00
$_sidebars = stripslashes_deep( get_option( SS_SETTINGS_FIELD ) );
2013-08-09 13:11:17 -04:00
2013-08-09 13:35:43 -04:00
//* If no sidebars have been created, do nothing
2013-08-09 13:11:17 -04:00
if ( ! $_sidebars )
return;
2013-08-09 13:35:43 -04:00
//* Cycle through created sidebars, register them as widget areas
2013-08-09 13:11:17 -04:00
foreach ( (array) $_sidebars as $id => $info ) {
2013-08-09 13:35:43 -04:00
genesis_register_sidebar( array(
'name' => esc_html( $info['name'] ),
'id' => $id,
2013-08-09 13:05:55 -04:00
'description' => esc_html( $info['description'] ),
2013-08-09 13:35:43 -04:00
'editable' => 1,
2013-08-09 13:11:17 -04:00
) );
2013-08-09 13:05:55 -04:00
}
2013-08-09 13:11:17 -04:00
}
2013-08-09 13:05:55 -04:00
/**
2013-08-09 13:11:17 -04:00
* Use custom sidebars.
*
2013-08-09 13:05:55 -04:00
* Remove the default sidebars, run some conditional logic,
* use alternate sidebars if necessary, else fallback on default sidebars.
2013-08-09 13:11:17 -04:00
*
* @since 0.9.0
2013-08-09 13:05:55 -04:00
*/
function ss_sidebars_init() {
2013-08-09 13:11:17 -04:00
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' );
2013-08-09 13:05:55 -04:00
}
2013-08-09 13:11:17 -04:00
/**
* Display primary sidebar.
*
* Display custom sidebar if one exists, else display default primary sidebar.
*
* @since 0.9.0
*/
2013-08-09 13:05:55 -04:00
function ss_do_sidebar() {
2013-08-09 13:07:35 -04:00
if ( ! ss_do_one_sidebar( '_ss_sidebar' ) )
genesis_do_sidebar();
2013-08-09 13:05:55 -04:00
}
2013-08-09 13:11:17 -04:00
/**
* Display secondary sidebar.
*
* Display custom sidebar if one exists, else display default secondary sidebar.
*
* @since 0.9.0
*/
2013-08-09 13:05:55 -04:00
function ss_do_sidebar_alt() {
2013-08-09 13:07:35 -04:00
if ( ! ss_do_one_sidebar( '_ss_sidebar_alt' ) )
genesis_do_sidebar_alt();
}
2013-08-09 13:11:17 -04:00
/**
* 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' ) {
2013-08-09 13:07:35 -04:00
static $taxonomies = null;
2013-08-09 13:11:17 -04:00
if ( is_singular() && $sidebar_key = genesis_get_custom_field( $sidebar_key ) ) {
if ( dynamic_sidebar( $sidebar_key ) ) return true;
2013-08-09 13:05:55 -04:00
}
2013-08-09 13:11:17 -04:00
2013-08-09 13:05:55 -04:00
if ( is_category() ) {
2013-08-09 13:11:17 -04:00
$term = get_term( get_query_var( 'cat' ), 'category' );
if ( isset( $term->meta[$sidebar_key] ) && dynamic_sidebar( $term->meta[$sidebar_key] ) ) return true;
2013-08-09 13:05:55 -04:00
}
2013-08-09 13:11:17 -04:00
2013-08-09 13:05:55 -04:00
if ( is_tag() ) {
2013-08-09 13:11:17 -04:00
$term = get_term( get_query_var( 'tag_id' ), 'post_tag' );
if ( isset( $term->meta[$sidebar_key] ) && dynamic_sidebar( $term->meta[$sidebar_key] ) ) return true;
2013-08-09 13:07:35 -04:00
}
2013-08-09 13:11:17 -04:00
2013-08-09 13:07:35 -04:00
if ( is_tax() ) {
2013-08-09 13:11:17 -04:00
if ( null === $taxonomies )
2013-08-09 13:09:21 -04:00
$taxonomies = ss_get_taxonomies();
2013-08-09 13:11:17 -04:00
foreach ( $taxonomies as $tax ) {
if ( 'post_tag' == $tax || 'category' == $tax )
2013-08-09 13:07:35 -04:00
continue;
2013-08-09 13:11:17 -04:00
if ( is_tax( $tax ) ) {
2013-08-09 13:07:35 -04:00
$obj = get_queried_object();
$term = get_term( $obj->term_id, $tax );
2013-08-09 13:11:17 -04:00
if ( isset( $term->meta[$sidebar_key] ) && dynamic_sidebar( $term->meta[$sidebar_key] ) ) return true;
2013-08-09 13:07:35 -04:00
break;
}
}
2013-08-09 13:05:55 -04:00
}
2013-08-09 13:11:17 -04:00
2013-08-09 13:07:35 -04:00
return false;
2013-08-09 13:11:17 -04:00
2013-08-09 13:07:35 -04:00
}
2013-08-09 13:09:21 -04:00
2013-08-09 13:11:17 -04:00
/**
* Return taxonomy ids.
*
* Helper function to return the array keys from a taxonomy query.
*
* @since 0.9.0
*/
2013-08-09 13:09:21 -04:00
function ss_get_taxonomies() {
$taxonomies = get_taxonomies( array( 'show_ui' => true, 'public' => true ) );
return apply_filters( 'genesis_simple_sidebars_taxonomies', array_keys( $taxonomies ) );
}
2013-08-09 13:11:17 -04:00
/**
* 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
*/
2013-08-09 13:09:21 -04:00
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' ) );
2013-08-09 13:11:17 -04:00
2013-08-09 13:09:21 -04:00
return ! empty( $_3_column );
}