Widget Logic

Beschreibung

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, or any general PHP code.

PLEASE NOTE The widget logic you introduce is EVAL’d directly. Anyone who has access to edit widget appearance will have the right to add any code, including malicious and possibly destructive functions. There is an optional filter ‚widget_logic_eval_override‘ which you can use to bypass the EVAL with your own code if needed. (See Other Notes).

There is also an option to add a wordpress ‚widget_content‘ filter — this lets you tweak any widget’s HTML 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. As of February 2017 we have raised 1,048.50 UKP.

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. If there is no ‚return‘ in the text, an implicit ‚return‘ is added to the start and a ‚;‘ is added on the end. (This is just to make single statements like is_home() more convenient.)

The ‚widget_logic_eval_override‘ filter

Before the Widget Logic code is evaluated for each widget, the text of the Widget Logic code is passed through this filter. If the filter returns a BOOLEAN result, this is used instead to determine if the widget is visible. Return TRUE for visible.

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 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.

A WordPress filter function ‚takes as input the unmodified data, and returns modified data‘ which means that widget_content filters are provided with the raw HTML output by the widget, and you are then free to return something else entirely:

Screenshots

The 'Widget logic' field at work in standard widgets.

The plugin options are at the foot of the usual widget admin page… widget_content filter, wp_reset_query option, 'load logic point' and 'evaluate more than once'. You can also export and import your site's WL options as a plain text file for a quick backup/restore and to help troubleshoot issues.

Installation

Upload widget-logic.php to the /wp-content/plugins/ directory

Aktiviere das Plugin mittels dem ‚Plugins‘-Menü in WordPress

That’s it. The configuring and options are in the usual widget admin interface.

Configuration

Aside from logic against your widgets, there are three options added to the foot of the widget admin page (see screenshots).

Add ‚widget_content‘ filter — This allows you to modify the text output in all widgets. You need to know how to write a WP filter, though some basics are covered in Other Notes.

Use ‚wp_reset_query‘ fix — Many features of WP, as well as the many themes and plugins out there, can mess with the conditional tags, such that is_home is NOT true on the home page. This can often be fixed with a quick wp_reset_query() statement just before the widgets are called, and this option puts that in for you rather than having to resort to code editing

Load logic — This option allows you to set the point in the page load at which your widget logic if first checked. Pre v.50 it was when the ‚wp_head‘ trigger happened, ie during the creation of the HTML’s HEAD block. Many themes didn’t call wp_head, which was a problem. From v.50 it happens, by default, as early as possible, which is as soon as the plugin loads. You can now specify these ‚late load‘ points (in chronological order):

after the theme loads (after_setup_theme trigger)

when all PHP loaded (wp_loaded trigger)

after query variables set (parse_query) – this is the default

during page header (wp_head trigger)

You may need to delay the load if your logic depends on functions defined, eg in the theme functions.php file. Conversely you may want the load early so that the widget count is calculated correctly, eg to show an alternative layour or content when a sidebar has no widgets.

Don’t cache widget logic results — From v .58 the widget logic code should only execute once, but that might cause unexpected results with some themes, so this option is here to turn that behaviour off. (The truth/false of the code will be evaluated every time the sidebars_widgets filter is called.

FAQ

Installation Instructions

Upload widget-logic.php to the /wp-content/plugins/ directory

Aktiviere das Plugin mittels dem ‚Plugins‘-Menü in WordPress

That’s it. The configuring and options are in the usual widget admin interface.

Configuration

Aside from logic against your widgets, there are three options added to the foot of the widget admin page (see screenshots).

Add ‚widget_content‘ filter — This allows you to modify the text output in all widgets. You need to know how to write a WP filter, though some basics are covered in Other Notes.

Use ‚wp_reset_query‘ fix — Many features of WP, as well as the many themes and plugins out there, can mess with the conditional tags, such that is_home is NOT true on the home page. This can often be fixed with a quick wp_reset_query() statement just before the widgets are called, and this option puts that in for you rather than having to resort to code editing

Load logic — This option allows you to set the point in the page load at which your widget logic if first checked. Pre v.50 it was when the ‚wp_head‘ trigger happened, ie during the creation of the HTML’s HEAD block. Many themes didn’t call wp_head, which was a problem. From v.50 it happens, by default, as early as possible, which is as soon as the plugin loads. You can now specify these ‚late load‘ points (in chronological order):

after the theme loads (after_setup_theme trigger)

when all PHP loaded (wp_loaded trigger)

after query variables set (parse_query) – this is the default

during page header (wp_head trigger)

You may need to delay the load if your logic depends on functions defined, eg in the theme functions.php file. Conversely you may want the load early so that the widget count is calculated correctly, eg to show an alternative layour or content when a sidebar has no widgets.

Don’t cache widget logic results — From v .58 the widget logic code should only execute once, but that might cause unexpected results with some themes, so this option is here to turn that behaviour off. (The truth/false of the code will be evaluated every time the sidebars_widgets filter is called.

I upgraded to Version 5.7.0 and my site’s widgets now behave differently

There was an important change to how your Widget Logic code is evaluated. There is a new default ‚Load logic‘ point of ‚after query variables set‘. For most people this should be better, but you could try reverting to the old default ‚when plugin starts‘.

What can I try if it’s not working?

Switch to the default theme. If the problem goes away, your theme may be interfering with the WP conditional tags or how widgets work

You have a PHP syntax error in one of your widget’s Widget Logic fields. Review them for errors. You might find it easiest to check by using ‚Export options‘ and reading the code there (Though be aware that single and double quotes are escaped with multiple backslash characters.)

If you are having trouble finding the syntax error, a simple troubleshooting method is to use ‚Export options‘ to keep a copy and then blank each Widget Logic field in turn until the problem goes. Once you’ve identified the problematic code, you can restore the rest with ‚Import options‘.

It’s causing problems with Woo Commerce / other popular plugin

This is often, not always, fixed by trying the different ‚Load Logic‘ options. The ‚after query variables set‘ option looks like it might be a better default, try it.

What’s this stuff in my sidebar when there are no widgets?

Since v .50 the widget logic code runs such that when dynamic_sidebar is called in a theme’s code it will ‚return false‘ if no widgets are present. In such cases many themes are coded to put in some default sidebar text in place of widgets, which is what you are seeing.

Your options, if you want this default sidebar content gone, are to either edit the theme, or as a work around, add an empty text widget (no title, no content) to the end of the sidebar’s widget list.

How do I get widget X on just my ‚home‘ page? (Or on every page except that.)

There is some confusion between the Main Page and the front page. If you want a widget on your ‚front page‘ whether that is a static page or a set of posts, use is_front_page(). If it is a page using is_page(x) does not work. If your ‚front page‘ is a page and not a series of posts, you can still use is_home() to get widgets on that main posts page (as defined in Admin > Settings > Reading).

Logic using is_page() doesn’t work

I believe this is fixed in 5.7.0. Let me know if that is not the case.

If your theme calls the sidebar after the loop you should find that the wp_reset_query option fixes things. This problem is explained on the is_page codex page.

How do I get a widget to appear both on a category page and on single posts within that category?

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))

How do I get a widget to appear when X, Y and Z?

Have a go at it yourself first. Check out the ‚Writing Logic Code‘ section under Other Notes.

Why is Widget Logic so unfriendly, you have to be a code demon to use it?

This is sort of deliberate. I originally wrote it to be as flexible as possible with the thought of writing a drag’n’drop UI at some point. I never got round to it, because (I’m lazy and) I couldn’t make it both look nice and let you fall back to ‚pure code‘ (for the possibilities harder to cater for in a UI).

The plugin Widget Context presents a nice UI and has a neat ‚URL matching‘ function too.

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')

Rezensionen

Just found today that I can add !wp_is_mobile() to remove widgets from showing on mobile device browsers. Very handy since most of the sidebar widgets only fit well on desktop. Been using this plugin for several months now and it works great.

5.7.4

5.7.3

Fixed the issue when in some cases the plugin displayed user logic errors in the Widgets section and this didn’t allow to save the widgets.
https://wordpress.org/support/topic/an-error-has-occurred-please-reload-the-page-and-try-again-3/

0.54

A little ‚trim‘ of WL code to stop „syntax error, unexpected ‚)'“ errors, which could occur if your WL was just a single space. Thanks to https://twitter.com/chrisjean for pointing this out.

Translation support! Thanks to Foe Services Labs https://wordpress.org/support/profile/cfoellmann for the work on this and the German Social Translation

Added a ‚widget_logic_eval_override‘ filter. This allows advanced users to bypass EVAL with a function of their own.

0.53

Accidentally released code with a terrible bug in it 🙁

0.52

Two new features: optional delayed loading of logic (see Configuration under Installation), and the ability to save out and reload all your site’s widget logic into a config file

0.51

One important bug fix (fairly major and fairly stupid of me too)

0.50

For the first time since this started on WP 2.3, I’ve rewritten how the core widget logic function works, so there may be ‚bumps ahead‘.

It now uses the ’sidebars_widgets‘ filter (as it should have done when that was
introduced in WP2.8 by the look of it). The upshot is that is_active_sidebar should behave properly.

Widget callbacks only get intercepted if the ‚widget_content‘ filter is activated, and much more briefly. (A widget’s ‚callback‘ is rewired within the ‚dynamic_sidebar‘ function just before the widget is called, by the ‚dynamic_sidebar_param‘ filter, and is restored when the callback function is invoked.)

0.48

Kill some poor coding practices that throws debug notices – thanks to John James Jacoby.

0.44

0.43

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