Commit 72fe35f1 authored by root's avatar root Committed by lechuck
Browse files

added widget logic plugin

parent 91498b56
=== Widget Logic ===
Contributors: alanft
Donate link: http://www.justgiving.com/widgetlogic_cancerresearchuk
Tags: widget, admin, conditional tags, filter, context
Requires at least: 2.5
Tested up to: 3.1
Stable tag: 0.48
Widget Logic lets you control on which pages widgets appear. It uses any of WP's conditional tags. It also adds a 'widget_content' filter.
== Description ==
This plugin gives every widget an extra control field called "Widget logic" that lets you control the pages that the widget will appear on.
The text field lets you use WP's [Conditional Tags](http://codex.wordpress.org/Conditional_Tags), or any general PHP code.
There is also an option to add a wordpress 'widget_content' filter -- this lets you tweak standard widgets to suit your theme without editing plugins and core code.
= Donations =
If you like and use Widget Logic you could consider a small donation to Cancer Research UK. I have a [JustGiving.com donation link](http://www.justgiving.com/widgetlogic_cancerresearchuk) above with the aim of raising 500 UKP in the next 12 months.
== Installation ==
1. Upload `widget-logic.php` to the `/wp-content/plugins/` directory
2. Activate the plugin through the 'Plugins' menu in WordPress
3. That's it. All the configuring is in the usual widget admin interface.
== Frequently Asked Questions ==
= Why isn't it working? =
Try switching to the WP default theme - if the problem goes away, there is something specific to your theme that may be interfering with the WP conditional tags.
The most common sources of problems are:
* The logic text on one of your widgets is invalid PHP
* Your theme doesn't call wp_head()
* Your theme performs custom queries before calling the dynamic sidebar -- if so, try ticking the `wp_reset_query` option.
= Widgets appear when they shouldn't =
It might be that your theme performs custom queries before calling the sidebar. Try the `wp_reset_query` option.
Alternatively you may have not defined your logic tightly enough. For example when the sidebar is being processed, in_category('cheese') will be true if the last post on an archive page is in the 'cheese' category.
Tighten up your definitions with PHPs 'logical AND' &&, for example:
`is_single() && in_category('cheese')`
Another source of confusion is the difference between the [Main Page and the front page](http://codex.wordpress.org/Conditional_Tags#The_Main_Page). If you have set your front page to be a static page, use is_front_page() instead of is_page(x).
= How do I get a widget to appear both on a category page and on single posts within that category? =
Again, take care with your conditional tags. There is both an `in_category` and `is_category` tag. One is used to tell if the 'current' post is IN a category, and the other is used to tell if the page showing IS for that category (same goes for tags etc). What you want is the case when:
`(this page IS category X) OR (this is a single post AND this post is IN category X)`
which in proper PHP is:
`is_category(X) || (is_single() && in_category(X))`
See also: 'Writing Logic Code' in the [Other Notes](../other_notes/) section.
== Screenshots ==
1. The 'Widget logic' field at work in standard widgets.
2. The `widget_content` filter and `wp_reset_query` options are at the foot of the widget admin page. (Both are off by default.)
== Writing Logic Code ==
The text in the 'Widget logic' field can be full PHP code and should return 'true' when you need the widget to appear. Make good use of [WP's own conditional tags](http://codex.wordpress.org/Conditional_Tags).
If there is no 'return' in the text, an implicit 'return' is added to the start and a ';' is added on the end.
Try variations on the examples given below. Use `!` (NOT) in front of a conditional tag to reverse the logic, eg !is_home() to show a widget on any page except the home page.
Use `||` (OR), `&&` (AND) to make more complex conditions. There are lots of great code examples on the WP forums, and on WP sites across the net. But the WP Codex is also full of good examples to adapt, such as [Test if post is in a descendent category](http://codex.wordpress.org/Template_Tags/in_category#Testing_if_a_post_is_in_a_descendant_category).
Remember -- the code runs even if the widget doesn't appear. (Even if it never appears!)
Examples:
* `is_home()` -- just the main blog page
* `!is_page('about')` -- everywhere EXCEPT this specific WP 'page'
* `is_category(array(5,9,10,11))` -- category page of one of the given category IDs
* `is_single() && in_category('baked-goods')` -- single post that's in the category with this slug
* `current_user_can('level_10')` -- admin only widget
* `strpos($_SERVER['HTTP_REFERER'], "google.com")!=false` -- widget to show when clicked through from a google search
* `is_category() && in_array($cat, get_term_children( 5, 'category'))` -- category page that's a descendent of category 5
* `global $post; return (in_array(77,get_post_ancestors($post)));` -- WP page that is a child of page 77
* `global $post; return (is_page('home') || ($post->post_parent=="13"));` -- home page OR the page that's a child of page 13
Note the extra ';' on the end where there is an explicit 'return'.
== The 'widget_content' filter ==
When this option is active (tick the option tickbox at the foot of the widget admin page) you can modify the text displayed by ANY widget from your own theme's functions.php file. Hook into the filter with:
`add_filter('widget_content', 'your_filter_function', [priority], 2);`
where `[priority]` is the optional priority parameter for the [add_filter](http://codex.wordpress.org/Function_Reference/add_filter) function. The filter function can take a second parameter (if you provde that last parameter '2') like this:
`function your_filter_function($content='', $widget_id='')`
The second parameter ($widget_id) can be used to target specific widgets if needed.
_Example filters_
I was motivated to make this filter in order to render all widget titles with the excellent [ttftitles plugin](http://templature.com/2007/10/18/ttftitles-wordpress-plugin/) like this:
`add_filter('widget_content', 'ttftext_widget_title');
function ttftext_widget_title($content='')
{ preg_match("/<h2[^>]*>([^<]+)/",$content, $matches);
$heading=$matches[1];
$insert_img=the_ttftext( $heading, false );
$content=preg_replace("/(<h2[^>]*>)[^<]+/","$1$insert_img",$content,1);
return $content;
}`
People often ask for a way to give widgets alternating styles. This filter inserts widget_style_a/widget_style_b into the class="widget ..." text usually found in a widget's main definition:
`add_filter('widget_content', 'make_alternating_widget_styles');
function make_alternating_widget_styles($content='')
{ global $wl_make_alt_ws;
$wl_make_alt_ws=($wl_make_alt_ws=="style_a")?"style_b":"style_a";
return preg_replace('/(class="widget )/', "$1 widget_${wl_make_alt_ws} ", $content);
}`
== Changelog ==
= 0.48 =
Kill some poor coding practices that throws debug notices - thanks to John James Jacoby.
= 0.47 =
FINALLY tracked down the elusive 'wp_reset_query' option resetting bug.
= 0.46 =
Fix to work with new WP2.8 admin ajax. With bonus fixes.
= 0.44 =
Officially works with 2.7 now. Documentation changes and minor bug fixes.
= 0.43 =
simple bug fix (form data was being lost when 'Cancel'ing widgets)
= 0.42 =
WP 2.5+ only now. WP's widget admin has changed so much and I was getting tied up in knots trying to make it work with them both.
= 0.4 =
Brings WP 2.5 compatibility. I am trying to make it back compatible. If you have trouble using WL with WP 2.1--2.3 let me know the issue. Thanks to Kjetil Flekkoy for reporting and helping to diagnose errors in this version
= 0.31 =
Last WP 2.3 only version
== Upgrade Notice ==
= 0.46 =
Required with WP2.8 cos of changes in Widget admin AJAX
= 0.44 =
Updated for WP2.7 with extra bug fixes
<?php
/*
Plugin Name: Widget Logic
Plugin URI: http://freakytrigger.co.uk/wordpress-setup/
Description: Control widgets with WP's conditional tags is_home etc
Author: Alan Trewartha
Version: 0.48
Author URI: http://freakytrigger.co.uk/author/alan/
*/
add_filter( 'widget_update_callback', 'widget_logic_widget_update_callback', 10, 3);
add_filter( "plugin_action_links", "wl_charity", 10, 2);
function wl_charity($links, $file) {
if ($file == plugin_basename(__FILE__))
array_push($links, '<a href="http://www.justgiving.com/widgetlogic_cancerresearchuk/">Charity Donation</a>');
return $links;
}
// new in 2.8 - ajaxy update of a single widget
function widget_logic_widget_update_callback($instance, $new_instance, $this_widget)
{ $widget_id=$this_widget->id;
if ( isset($_POST[$widget_id.'-widget_logic']))
{ if((!$wl_options = get_option('widget_logic')) || !is_array($wl_options) ) $wl_options = array();
$wl_options[$widget_id]=$_POST[$widget_id.'-widget_logic'];
update_option('widget_logic', $wl_options);
}
return $instance;
}
add_action( 'sidebar_admin_setup', 'widget_logic_expand_control');
function widget_logic_expand_control()
{ global $wp_registered_widgets, $wp_registered_widget_controls;
if((!$wl_options = get_option('widget_logic')) || !is_array($wl_options) ) $wl_options = array();
// if we're just updating the widgets, just read in the widget logic settings - makes this WP2.5+ only i think
if ( 'post' == strtolower($_SERVER['REQUEST_METHOD']) )
{ foreach ( (array) $_POST['widget-id'] as $widget_number => $widget_id )
if (isset($_POST[$widget_id.'-widget_logic']))
$wl_options[$widget_id]=$_POST[$widget_id.'-widget_logic'];
// clean up empty options (in PHP5 use array_intersect_key)
$regd_plus_new=array_merge(array_keys($wp_registered_widgets),array_values((array) $_POST['widget-id']),array('widget_logic-options-filter', 'widget_logic-options-wp_reset_query'));
foreach (array_keys($wl_options) as $key)
if (!in_array($key, $regd_plus_new))
unset($wl_options[$key]);
}
foreach ( $wp_registered_widgets as $id => $widget )
{ if (!$wp_registered_widget_controls[$id])
wp_register_widget_control($id,$widget['name'], 'widget_logic_empty_control');
if (!array_key_exists(0,$wp_registered_widget_controls[$id]['params']) || is_array($wp_registered_widget_controls[$id]['params'][0]))
$wp_registered_widget_controls[$id]['params'][0]['id_for_wl']=$id;
else
{ // some older widgets put number in to params directly (which messes up the 'templates' in WP2.5)
array_push($wp_registered_widget_controls[$id]['params'],$id);
$wp_registered_widget_controls[$id]['height']+=40; // this is really a pre2.5 thing - discard?
}
// do the redirection
$wp_registered_widget_controls[$id]['callback_wl_redirect']=$wp_registered_widget_controls[$id]['callback'];
$wp_registered_widget_controls[$id]['callback']='widget_logic_extra_control';
}
// check the 'widget content' filter option
if ( isset($_POST['widget_logic-options-submit']) )
{ $wl_options['widget_logic-options-filter']=$_POST['widget_logic-options-filter'];
$wl_options['widget_logic-options-wp_reset_query']=$_POST['widget_logic-options-wp_reset_query'];
}
update_option('widget_logic', $wl_options);
}
add_action( 'sidebar_admin_page', 'widget_logic_options_filter');
function widget_logic_options_filter()
{
if((!$wl_options = get_option('widget_logic')) || !is_array($wl_options) ) $wl_options = array();
?><div class="wrap">
<form method="POST">
<h2>Widget Logic options</h2>
<p style="line-height: 30px;">
<label for="widget_logic-options-filter" title="Adds a new WP filter you can use in your own code. Not needed for main Widget Logic functionality.">Use 'widget_content' filter
<input id="widget_logic-options-filter" name="widget_logic-options-filter" type="checkbox" value="checked" class="checkbox" <?php echo $wl_options['widget_logic-options-filter'] ?> /></label>
&nbsp;&nbsp;
<label for="widget_logic-options-wp_reset_query" title="Resets a theme's custom queries before your Widget Logic is checked.">Use 'wp_reset_query' fix
<input id="widget_logic-options-wp_reset_query" name="widget_logic-options-wp_reset_query" type="checkbox" value="checked" class="checkbox" <?php echo $wl_options['widget_logic-options-wp_reset_query'] ?> /></label>
<span class="submit"><input type="submit" name="widget_logic-options-submit" id="widget_logic-options-submit" value="Save" /></span></p>
</form>
</div>
<?php
}
function widget_logic_empty_control() {}
function widget_logic_extra_control()
{ global $wp_registered_widget_controls;
$params=func_get_args();
// find the widget id that we have sneaked into the params
$id=(is_array($params[0]))?$params[0]['id_for_wl']:array_pop($params);
$id_disp=$id;
if((!$wl_options = get_option('widget_logic')) || !is_array($wl_options) ) $wl_options = array();
$callback=$wp_registered_widget_controls[$id]['callback_wl_redirect'];
if (is_callable($callback))
call_user_func_array($callback, $params); // go to the original control function
$value = !empty( $wl_options[$id ] ) ? htmlspecialchars( stripslashes( $wl_options[$id ] ),ENT_QUOTES ) : '';
// dealing with multiple widgets - get the number. if -1 this is the 'template' for the admin interface
if (is_array($params[0]) && isset($params[0]['number'])) $number=$params[0]['number'];
if ($number==-1) {$number="%i%"; $value="";}
if (isset($number)) $id_disp=$wp_registered_widget_controls[$id]['id_base'].'-'.$number;
// output our extra widget logic field
echo "<p><label for='".$id_disp."-widget_logic'>Widget logic <input type='text' name='".$id_disp."-widget_logic' id='".$id_disp."-widget_logic' value='".$value."' /></label></p>";
}
// intercept registered widgets - redirect them and put each ID on the end of the params
// perhaps there is a way to just intercept the ones that are used??
add_action('wp_head', 'widget_logic_redirect_callback');
function widget_logic_redirect_callback()
{ global $wp_registered_widgets;
foreach ( $wp_registered_widgets as $id => $widget )
{ if ( empty( $wp_registered_widgets[$id]['callback_wl_redirect'] ) )
{ array_push($wp_registered_widgets[$id]['params'],$id);
$wp_registered_widgets[$id]['callback_wl_redirect']=$wp_registered_widgets[$id]['callback'];
$wp_registered_widgets[$id]['callback']='widget_logic_redirected_callback';
}
}
}
// the redirection comes here
function widget_logic_redirected_callback()
{ global $wp_registered_widgets, $wp_reset_query_is_done;
$params=func_get_args(); // get all the passed params
$id=array_pop($params); // take off the widget ID
$callback=$wp_registered_widgets[$id]['callback_wl_redirect']; // find the real callback
$wl_options = get_option('widget_logic'); // do we want the widget?
$wl_value = ( !empty( $wl_options[$id] ) ) ? stripslashes( $wl_options[$id] ) : "true";
$wl_value = ( stristr( $wl_value, "return" ) ) ? $wl_value : "return (" . $wl_value . ");";
// before we execute the condtional code, perhaps we want to wp_reset_query...
if ( !empty( $wl_options['widget_logic-options-wp_reset_query'] ) && ( $wl_options['widget_logic-options-wp_reset_query'] == 'checked' ) && empty( $wp_reset_query_is_done ) )
{ wp_reset_query(); $wp_reset_query_is_done=true; }
$wl_value=(eval($wl_value) && is_callable($callback));
if ( $wl_value )
{ if ( !empty( $wl_options['widget_logic-options-filter'] ) && ( $wl_options['widget_logic-options-filter'] != 'checked' ) )
call_user_func_array($callback, $params); // if so callback with original params!
else
{ ob_start();
call_user_func_array($callback, $params); // if so callback with original params!
$widget_content = ob_get_contents();
ob_end_clean();
echo apply_filters( 'widget_content', $widget_content, $id);
}
}
}
?>
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment