Indiana University: IT Training Tips Blog

One of the benefits of administering this blog is that it allows me to find gaps in the WordPress documentation already published to the web and/or find easier ways to do things than what has already been explained.

Today, I’m looking into how to create the category RSS feeds that you can see in our sidebar. This article will discuss how to create the following by editing the default WordPress category sidebar widget:

RSS Feed text links:

RSS Feed icon links:

NOTE: This article is intended for individuals who are working with WordPress at an administrative level. A familiarity with PHP is required.

WordPress Version: 2.8.0 and up

Understanding How Category Lists Are Generated

Before we dive into the specifics of how to edit the Category widget, let’s explore how Category links are made.

In the most recent version of WordPress (3.0.1 at the time of this writing), the function that generates categories is called wp_list_categories() (link opens in new window). I will spare you the entire explanation of how the function works (follow the link to go to the WordPress Codex), but we will need a general working knowledge of how we will send it input.

The typical usage is:

<?php wp_list_categories($args); ?>

Where $args is an array that passes display settings to the function.

Dynamic vs. Static Sidebar: Which One Am I Using?

This article focuses on the dynamic sidebar. The easiest way to tell if you are using a dynamic or static sidebar is whether or not you are using widgets in your theme. If you use widgets, you are using a dynamic sidebar. If you aren’t using widgets, you are using a static sidebar. If you are using a static sidebar, you will probably still get some helpful information out of this post, but it’s truly geared toward the dynamic sidebar.

Creating Category RSS Feed Text Links

Let’s start with the easier of the two methods, text-based RSS links.

1. To begin, you need to find your wp-includes/default-widgets.php file.
2. Save the current file as wp-includes/default-widgets-OLD.php.

Now that we’ve backed up our work, we can begin looking for the code we need. In the file, you should find an area of text around line 414 that looks like:

/**
 * Categories widget class
 *
 * @since 2.8.0
 */
class WP_Widget_Categories extends WP_Widget {

	function WP_Widget_Categories() {
		$widget_ops = array( 'classname' => 'widget_categories', 'description' => __( "A list or dropdown of categories" ) );
		$this->WP_Widget('categories', __('Categories'), $widget_ops);
	}

	function widget( $args, $instance ) {
		extract( $args );

		$title = apply_filters('widget_title', empty( $instance['title'] ) ? __( 'Categories' ) : $instance['title'], $instance, $this->id_base);
		$c = $instance['count'] ? '1' : '0';
		$h = $instance['hierarchical'] ? '1' : '0';
		$d = $instance['dropdown'] ? '1' : '0';

		echo $before_widget;
		if ( $title )
			echo $before_title . $title . $after_title;

		$cat_args = array('orderby' => 'name', 'show_count' => $c, 'hierarchical' => $h);

		if ( $d ) {
			$cat_args['show_option_none'] = __('Select Category');
			wp_dropdown_categories(apply_filters('widget_categories_dropdown_args', $cat_args));
?>

There are essentially two locations we are interested in in this code chunk. The first is where we will declare our feed link’s name:

$c = $instance['count'] ? '1' : '0';
$h = $instance['hierarchical'] ? '1' : '0';
$d = $instance['dropdown'] ? '1' : '0';

The second is where we modify the $cat_args array:

$cat_args = array('orderby' => 'name', 'show_count' => $c, 'hierarchical' => $h);

We will add a $f variable and set it’s value to ‘rss’. We will then add the variable in the $cat_args array to make the links appear.

1. To create the $f variable, in the code editor, under the line that reads $d = $instance['dropdown'] ? '1' : '0'; type,
   $f = 'rss';
2. To modify the $cat_args array, immediately after the $h, type:
   , 'feed' => $f

   The line should now read: $cat_args = array(‘orderby’ => ‘name’, ‘show_count’ => $c, ‘hierarchical’ => $h, ‘feed’ => $f);

   Full code listing for the WP_Widget_Categories class. (opens in new window)

3. Save your file and upload it back to your wp-includes folder.
4. Refresh your blog front page.

You should see something similar to:

Creating Category RSS Icon Links

The process for creating RSS links with an icon is very similar to the above process. Instead of settign the $f variable to 'rss', we will set it to the location of the image file and instead of adding 'feed' => $f to the $cat_args array, we will add 'feed_image' => $f.

To complete this section, you will need a small RSS icon. Right click here and choose ‘Save Target As…’ to use the one that we use. You will also have to upload the image to a folder you can link to from your WordPress installation, we stored ours in our wp-content/themes/current_theme/images folder.

Let’s get started.

1. Find the same code snippets listed above, namely:
   $c = $instance['count'] ? '1' : '0';
   $h = $instance['hierarchical'] ? '1' : '0';
   $d = $instance['dropdown'] ? '1' : '0';

2. To create the feed variable, after $d, type:
   $f = ‘path_to_your.image’
3. To modify the $cat_args variable, immediately after the $h, type:
   , ‘feed_image’ => $f

   The line should now read: $cat_args = array(‘orderby’ => ‘name’, ‘show_count’ => $c, ‘hierarchical’ => $h, ‘feed_image’ => $f);

   Full code listing for the WP_Widget_Categories class. (opens in new window)

4. Save your file and upload it back to your wp-includes folder.
5. Refresh your blog front page.

You should see something similar to:

Where To Go From Here

Now that you have modified your default-widgets.php file, you will have to preserve it before upgrading your WordPress installation. I recommend that you keep a copy of the modified file stored somewhere safe. For example, you could save your default-widgets.php file as default-widgets-NEW.php and move it to your desktop or any other location.

This entry was posted on Monday, October 11th, 2010 at 8:00 am and is filed under Content Management, Social Media, WCMS, WordPress. You can follow any responses to this entry through the RSS 2.0 feed. You can leave a response, or trackback from your own site.