post

Genesis Widgetized Not Found & 404

New Flexibility plus Enhanced User Experience

We all know that sometimes 404 Errors happen on our sites. And sometimes users search but get no results. I believe it's better to serve users some highly customized and maintained pages/content areas for these cases. What better to do that with Widgets in WordPress? -- In my opinion Genesis Framework could improve here so that's why I just made this little plugin to FINALLY have these two cases maintainable EASILY via your widgets admin. Just place in a search widget, your last blog posts, an image widget, some explanation via text widget, some galleries... You got it. The possibilities are endless. Finally.

A great helper tool for Genesis Child Themes!

Please note: Genesis Widgetized Not Found & 404 requires the Genesis Theme Framework, a paid premium product released by StudioPress/ Copyblogger Media LLC (via studiopress.com).

Advantages & Benefits

  • Helps users stay longer on your site because you can give options like search form, recent posts, introductory text, image(s) etc.
  • Hugely improved user experience! (Helps decrease the "Oops, I broke the internet..." experiences...)
  • Easily customizeable for any webmaster!
  • Works across Genesis child themes - so you can switch your "skin" but not loosing this tool :-)
  • Provides extra Search Form Widget with more options than the default WordPress core widget.
  • Handy search form Shortcode!
  • Ideal for multilingual websites (for example with "WPML"): Much better handling of 404/Not found content for different languages. -- See bottom of FAQ section here for more info on that.

General Features

  • Small & lightweight plugin tool: Just activate plugin, place your widgets and you're done!
  • Adds a new widget area (Sidebar) for the "404 Error Page"
  • Adds a new widget area (Sidebar) for the "Search not found" page (if there no results on search)
  • Adds a new Search Form Widget - which gives you more options than the default WordPress "Search" widget! (Search text, Submit text etc.)
  • Adds 2 Shortcodes: a customizeable Search form to place anywhere Shortcodes are supported, plus Shortcode for this plugin's widget areas.
  • Special Bonus for bbPress 2.3+: make the forum search not found content/status widgetized - take full control!
  • Adds a few CSS styles for the content area to properly divide widgets with some more space (all other styling is recommended via your child theme)
  • Included are two handy helper functions (via child theme) for applying the Genesis 'Full-Width' layout option for one or both 'not found' cases! -- See the FAQ section for more info on that!
  • For developers & advanced users: plugin provides lots of filter and acton hooks throughout for easy customization if ever needed.
  • All markup is fully compatible with Genesis 2.0+, that means for HTML5 if the child theme supports it (is done all automatically & conditionally under the surface!).
  • Integrated default Genesis filters genesis_search_text and genesis_search_button_text for default strings :-).
  • Fully internationalized! Real-life tested and developed with international users in mind!
  • Fully WPML compatible!
  • Fully Multisite compatible, you can also network-enable it if ever needed (per site use is recommended).
  • Tested with WordPress versions 3.4 branch (plus former 3.3 branch) - also in debug mode (no stuff there, ok? :)

Localization

  • English (default) - always included
  • German (de_DE) - always included
  • Spanish (es_ES) - user-submitted - currently 37% complete for v1.5.0
  • .pot file (genesis-widgetized-notfound.pot) for translators is also always included :)
  • Easy plugin translation platform with GlotPress tool: Translate "Genesis Widgetized Not Found & 404"...
  • Your translation? - Just send it in

A plugin from deckerweb.de and GenesisThemes

Feedback

  • I am open for your suggestions and feedback - Thank you for using or trying out one of my plugins!
  • Drop me a line @deckerweb on Twitter
  • Follow me on my Facebook page
  • Or follow me on +David Decker on Google Plus ;-)

More

Download

Latest version: Download Genesis Widgetized Not Found & 404 v1.5.0 (Downloaded: 10,189 times)

Installation

NOTE: Only works with Genesis Framework as the parent theme. This is a paid premium product by StudioPress/ Copyblogger Media LLC, available via studiopress.com.

  1. Upload genesis-widgetized-notfound folder to the /wp-content/plugins/ directory -- or just upload the ZIP package via 'Plugins > Add New > Upload' in your WP Admin
  2. Activate the plugin through the 'Plugins' menu in WordPress
  3. Got the "Widgets" admin page and configure your widgets for the "404 Error Page" and the "Search Not Found" page.
  4. Hope the new widgets will never be needed, but in case, you're prepared now! :-)

Note: The "Genesis Framework" is required for this plugin in order to work. If you don't own a copy it yet, this premium parent theme has to be bought. More info about that you'll find here: http://ddwb.me/getgenesis

Own translation/wording: For custom and update-secure language files please upload them to /wp-content/languages/genesis-widgetized-notfound/ (just create this folder) - This enables you to use fully custom translations that won't be overridden on plugin updates. Also, complete custom English wording is possible with that, just use a language file like genesis-widgetized-notfound-en_US.mo/.po to achieve that (for creating one see the tools on "Other Notes").

Screenshots

  1. genesis-widgetized-notfound screenshot 1

    Genesis Widgetized Not Found & 404: two additional Widget areas/ sidebars - here with some example widgets placed in... (Click here for larger version of screenshot)

  2. genesis-widgetized-notfound screenshot 2

    Genesis Widgetized Not Found & 404: the plugin in action on a live site - displaying here the "Search not found" case - three widgets placed in (Text widget, Search Form widget, recent Posts widget). (Click here for larger version of screenshot)

  3. genesis-widgetized-notfound screenshot 3

    Genesis Widgetized Not Found & 404: plugin's own search widget called "Genesis - Search Form" with way more options than the WordPress core search widget! (Click here for larger version of screenshot)

  4. genesis-widgetized-notfound screenshot 4

    Genesis Widgetized Not Found & 404: plugin's optional Shortcodes in action for a post. (Click here for larger version of screenshot)

  5. genesis-widgetized-notfound screenshot 5

    Genesis Widgetized Not Found & 404: plugin's help tab. (Click here for larger version of screenshot)

FAQ

How can I change the layout of the '404 Error Page' (i.e. go full-width)?

You can use my "Genesis Layout Extras" plugin for that, which has an option for the 404 case built in. Or you can also use my built in helper function and add this little line to your functions.php of your child theme (backup file before!) or to the "Custom Function" section of Prose Child Theme 1.5+:

/** Genesis Widgetized NotFound: 404 Error Page - Full-Width Layout */
add_action( 'genesis_meta', '__gwnf_layout_404_full_width' );

How can I change the layout of the 'Search not found' Page (i.e. go full-width)?

You can use my "Genesis Layout Extras" plugin for that, which has an option for the search case built in. -- Or you can also use my built in helper function and add this little line to your functions.php of your child theme (backup file before!) or to the "Custom Functions" section of Prose Child Theme 1.5+:

/** Genesis Widgetized NotFound: Search not found Page - Full-Width Layout */
add_action( 'genesis_meta', '__gwnf_layout_searchnotfound_full_width' );

Note: The above code is restricted to the case when NO search results are found! It doesn't effect your search results display IF THERE ARE any results!

How can I style the content/widget areas?

It's all done via your child theme. Maybe you need to add an "!important" to some CSS rules here and there... For more even better styling I included some IDs and classes:

  • "404 Error Page" section:
    • the whole content area, before and after all widgets is wrapped in a div with the ID: #gwnf-404-area
    • each widget in this area has its own ID depending on the widget (regular WordPress behavior!)
    • each widget gets an additional class: .gwnf-404 -- which allows to set some common styles for all widgets in this area
  • "Search not found" section:
    • the whole content area, before and after all widgets is wrapped in a div with the ID: #gwnf-notfound-area
    • each widget in this area has its own ID depending on the widget (regular WordPress behavior!)
    • each widget gets an additional class: .gwnf-notfound -- which allows to set some common styles for all widgets in this area

Note, WordPress itself additionally adds body classes in the 404 case and the search not found case. So you can also use these classes: .error404 and .search-no-results

If that's still not enough, you can even enqueue your own style, an action hook is included for that: gwnf_load_styles -- This hook fires within the WordPress action hook wp_enqueue_scripts just after properly enqueueing the plugin's styles and only if at least one of both widgets is active, so it's fully conditional!

Could I disable the Shortcode support for widgets?

Of course, it's possible! Just add the following constant to your child theme's functions.php file or to a functionality plugin:

/** Genesis Widgetized Not Found & 404: Remove Widgets Shortcode Support */
define( 'GWNF_NO_WIDGETS_SHORTCODE', TRUE );

Some webmasters could need this for security reasons regarding their stuff members or for whatever other reasons... :).

What are parameters of the plugin's own Shortcodes?

(1) Parameters for [gwnf-widget-area] Shortcode:

  • area -- ID of the Widget area (Sidebar) (default: none, empty)
  • The following values are accepted: 404 OR notfound OR bbpress-notfound

(2) Parameters for [gwnf-search] Shortcode:

  • search_text -- Search placeholder text (default: Search this website)
  • button_text -- HTML wrapper tag (default: Search)
  • form_label -- Additional label before the search form (default: none, empty)
  • wrapper -- HTML wrapper tag (default: Latest update date:)
  • class -- Additional custom CSS class for the wrapper (default: none, empty)
  • post_type -- Optional setup post type(s) for search (default: none, empty - i.e., WordPress default search behavior!)

Could I completely remove the plugin's Shortcode features?

Of course, that's possible! Just add the following constant to your child theme's functions.php file or to a functionality plugin:

/** Genesis Widgetized Not Found & 404: Remove Shortcode Features */
define( 'GWNF_SHORTCODE_FEATURES', TRUE );

Can I remove the widgetized content area for bbPress forum search "not found"?

Of course, that's possible - very easily :). Just add the following line of code to your child theme's functions.php file or a functionality plugin:

/**
 * Genesis Widgetized Not Found & 404:
 *  Remove bbPress Widgetized Content Area on "not found"
 */
add_filter( 'gwnf_filter_bbpress_noresults_widgetized', '__return_false' );

How can I customize the widget titles/strings in the admin?

I've just included some filters for that - if ever needed (i.e. for clients, branding purposes etc.), you can use these filters:

gwnf_filter_404_widget_title - default value: "404 Error Page"

gwnf_filter_404_widget_description - default value: "This is the widget area of the 404 Not Found Error Page."

gwnf_filter_notfound_widget_title - default value: "Search Not Found"

gwnf_filter_notfound_widget_description - default value: "This is the widget area of the search not found content section."

gwnf_filter_notfound_default - default value: "Sorry, no content matched your criteria. Try a different search?"

Example code for changing one of these filters:

add_filter( 'gwnf_filter_404_widget_title', 'custom_404_widget_title' );
/**
 * Genesis Widgetized NotFound: Custom 404 Widget Title
 */
function custom_404_widget_title() {
    return __( 'Custom Error Page', 'your-child-theme-textdomain' );
}

Final note: I DON'T recommend to add customization code snippets to your child theme's functions.php file! Please use a functionality plugin or an MU-plugin instead! This way you can also use this better for Multisite environments. In general you are not abusing the functions.php for plugin-specific stuff and you are then also more independent from child theme changes etc. If you don't know how to create such a plugin yourself just use one of my recommended 'Code Snippets' plugins. Read & bookmark these Sites:

All the custom & branding stuff code above can also be found as a Gist on GitHub: https://gist.github.com/2473125 (you can also add your questions/ feedback there :)

How can I use the advantages of this plugin for multlingual sites?

(1) In general: You may use it for "global" widgets.

(2) Usage with the "WPML" plugin: Widgets can be translated with their "String Translation" component - this is much easier than adding complex information/instructions to the 404 error or search not found pages for a lot of languages...

You can use the awesome "Widget Logic" plugin (or similar ones) and add additional paramaters, mostly conditional stuff like is_home() in conjunction with is_language( 'de' ) etc. This way widget usage on a per-language basis is possible. Or you place in the WPML language codes like ICL_LANGUAGE_CODE == 'de' for German language. Fore more info on that see their blog post: http://wpml.org/2011/03/howto-display-different-widgets-per-language/

With the following language detection code you are now able to make conditional statements, in the same way other WordPress conditional functions work, like is_single(), is_home() etc.:

/**
 * WPML: Conditional Switching Languages
 *
 * @author David Decker - DECKERWEB
 * @link   http://twitter.com/deckerweb
 *
 * @global mixed $sitepress
 */
function is_language( $current_lang ) {

    global $sitepress;

    if ( $current_lang == $sitepress->get_current_language() ) {
        return true;
    }
}

Note: Be careful with the function name 'is_language' - this only works if there's no other function in your install with that name! If it's already taken (very rare case though), then just add a prefix like my_custom_is_language().

--> You now can use conditionals like that:

if ( is_language( 'de' ) ) {
    // do something for German language...
} elseif ( is_language( 'es' ) ) {
    // do something for Spanish language...
}

Changelog

1.5.0 (2013-05-29)

  • NEW: Added Widget "Genesis - Search Form" - more customizeable than the built-in WordPress core widget (change Search text, Submit text, display options etc.).
  • NEW: Added Shortcode [gwnf-search] for displaying a configurable search for anywhere you like :) -- conditionally with full support for HTMTL5 & Genesis 2.0.0+ if in use.
  • NEW: Added Shortcode [gwnf-widget-area] for displaying any of the plugin's 3 Widget areas (if active) into Shortcode aware content areas.
  • NEW: Added support for bbPress 2.3+ forum plugin: Added widgetized content area for the "No results" state of the bbPress Forum search - now you can easily customize this "edge case" with well-known and proved regular WordPress tools (that are Widgets!).
  • UPDATE: All markup output by the plugin is now fully compatible with Genesis 2.0+, that means for HTML5 if the child theme supports it (is done all automatically & conditionally under the surface!).
  • UPDATE: Additional stylesheet now uses the WordPress convention for file names: gwnf-styles.min.css (gwnf-html5-styles.min.css) is the minified default version, plus, gwnf-styles.css (gwnf-html5-styles.css) is now the development version. If WP_DEBUG or SCRIPT_DEBUG constants are true, the dev styles will be loaded. This makes development/ customizing & debugging a lot easier! :)
  • UPDATE: Improved versioning of stylesheet, also in light of above update :).
  • UPDATE: All frontent relevant code is now moved into the plugin's frontend file and only then loaded!
  • CODE: Some code optimizations, plus code/documentation updates & improvements.
  • UPDATE: Added a few new screenshots.
  • UPDATE: Updated readme.txt file here.
  • UPDATE: Updated German translations and also the .pot file for all translators.
  • NEW: Added partly Spanish translations, user-submitted.

1.4.0 (2012-12-15)

  • Maintenance release
  • UPDATE: Added the class placeholder to widget registrations to fullfill WordPress standard for Widgets API.
  • NEW: Added constant for disabling the widget shortcode support (see FAQ here).
  • CODE: Some code/documentation updates & improvements.
  • UPDATE: Updated readme.txt file here.
  • UPDATE: Initiated new three digits versioning, starting with this version.
  • UPDATE: Updated German translations and also the .pot file for all translators.
  • UPDATE: Moved screenshots to 'assets' folder in WP.org SVN to reduce plugin package size.

1.3.0 (2012-08-20)

  • Maintenance release
  • NEW: Added help tab also on Genesis settings page.
  • NEW: Compressed CSS file for improved performance (the development file has now the file name gwnf-styles.dev.css and is still packaged).
  • CODE: Minor code/documentation updates & improvements.
  • UPDATE: Updated German translations and also the .pot file for all translators.
  • UPDATE: Extended GPL License info in readme.txt as well as main plugin file.
  • NEW: Easy plugin translation platform with GlotPress tool: Translate "Genesis Widgetized Not Found & 404"...

1.2.0 (2012-04-27)

  • NEW: Added little help tab on Widget admin page for better user experience. (Works only with WordPress 3.3 or higher!)
  • UPDATE: Moved plugin links from main file to extra admin file which only loads within 'wp-admin', this way it's performance-improved! This also effects the new help tab stuff :).
  • UPDAGE: Added action hook gwnf_load_styles if you ever need to properly enqueue your own stylesheet for the edge cases... (Also see FAQ here).
  • CODE: Minor code/documentation tweaks and improvements.
  • UPDATE: Extended and improved readme.txt file documentation here, corrected typos.
  • UPDATE: Updated German translations and also the .pot file for all translators.

1.1.0 (2012-04-23)

  • NEW: Added two helper functions (via child theme) for applying the Genesis 'Full-Width' layout option for one or both 'not found' cases! This is very handy for lots of use cases... -- See the FAQ section for more info on that!
  • UPDATE: Placed widget display in conditionals only for the "404" or the "Search not found" case to avoid overlaying of more than one 'no content messages'. This should finally cover more edge cases...
  • UPDATE: Improved translations loading, especially for activation (messages).
  • UPDATE: Improved registering of widget areas/sidebars: switching back to Genesis register function, but now properly wrapped in a conditional, checking for activated Genesis. This way we also get further improved Multisite support!
  • UPDATE: Improved CSS styling, handling the limition of the empty "p" (left over from the original "no content status" of Genesis).
  • UPDATE: Updated German translations and also the .pot file for all translators.

1.0.1 (2012-04-20)

  • Bugfix release. Mmh, stuff happens...
  • UPDATE: Changed widget registering from Genesis to WordPress function (it doesn't matter in the end!)
  • BUGFIX: Fixed function typo that was causing notices on plugin activation.
  • UPDATE: Minor code documentation updates. Also, minor updates to readme.txt file here.
  • UPDATE: Updated German translations and also the .pot file for all translators.
  • UPDATE: Added banner image on WordPress.org for better plugin branding :)

1.0.0 (2012-04-20)

  • Initial release
About Travis Smith

As a WordPress Enthusiast, Travis writes about his journey in WordPress trying to help other WordPress travelers and enthusiasts with tutorials, explanations, & demonstrations of the things he learns.