So as a result of my tooling around with WordPress, I’ve created two plugins for people to use.

RandomQuotr

In one of my older site lay­outs, I had a random quote dis­play­ing at the top of the page. The orig­i­nal logic was based very much on the Hello Dolly plugin that comes shipped with Word­Press. Even though I no longer use the func­tion within my layout, I still had the code and I felt that with a little revi­sion, this could be a psudo-​useful plugin.

So one morn­ing I did exactly that. Ran­domQuotr was born, and with it came the abil­ity to store all of the quotes within the WordPress data­base, as opposed to the PHP array that it started out as. Some more func­tion­al­ity was added to allow the selec­tion of spe­cific quotes.

PostDivider

I was a big advo­cate for using “the_excerpt()” for my sites layout, because it allowed me to split up my con­tent and work around my theme. the prob­lem is that using “the_excerpt()” sucks for many reasons:

1. The field is HTML only.
2. The field is tiny and cannot be re-​sized.
3. It requires you to break up your most in a less than stel­lar way.

Enter Post­Di­vider.

Based on an old post of mine, Post­Di­vider allows the user to get the con­tent before and after the <!–MORE–> tag sep­a­rately. With Post­Di­vider, hooks are pro­vided to allow the Theme to dis­play the text directly (echo­ing it), or return­ing the con­tent as a value from the func­tion. If no <!–MORE–> tag is pro­vided, it will return the_excerpt() and the_content() respectively.

So far those are the only ones I’ve developed. I’ve got a couple ideas for more, when I get around to building my portfolio and the like.

I’ve also created a page that lists all of the plugins I have developed. They’re also hosted over on the wordpress.org plugins directory if you want to keep watch there.

I’m always looking for feedback or suggestions, so feel free to email me or leave a comment.

When I developed the theme I am currently using, I searched high and low for something I could steal take inspiration from. The funny thing is that most people don’t even know where the colour swapper is on my site. So few in fact that I had to add a caption to it to help make it a little more obvious.

In any case I felt that I would share the method I used to create the swapping functionality on my website. I’m aware that most of it can be figured out with a little imagination and some source viewing, but I think that going through it step by step is more helpful.

UPDATE – 10/09/2008 - In record time, a second pair of eyes looking at this has managed to refine the process. Thank you Bart for pointing out that if the CSS files are named the same as the Title attribute of the Anchor, then you can drop the whole If statement. I’ve updated the tutorial accordingly

Table of contents

• The idea
• Before we begin
• Setting up our files
• Setting up the CSS files
• A dash of PHP
• The basic markup
• The JavaScript
  • Importing the required files
  • Adding functionality
• Pulling it all together
  • Flow
• Conclusion

The idea

So you want to build a colour swapper? Easy as pie. You want to do it without causing a postback and sustains itself throughout the navigation? That’s a little more tricky, and what I wanted to do myself.

What, you’re too lazy to figure this out for yourself? No problem. Read on and be merry.

Before we begin

A few words before we begin:

• I am not a master of JavaScript, let alone JQuery. I’m not a novice, but I am in no way a master of the language. There are probably many ways in which to improve my methods here. I’m going to take another crack at them and see what I can come up with. I’ll update the code to this post If I come up with anything.
• In addition to the last note, I’m not going to explain how JQuery works. they do a fine job on their own. If you don’t understand it, I suggest you take some time and become familiar with it.
• This whole solution rides on the idea that your users allow JavaScript and Cookies. If the Cookies are disabled, the styles will still change, but will not persist between page refreshes/navigation. If JavaScript is disabled, nothing will work because I have not yet implemented a postback-friendly alternate. If I find myself with time I’ll do this as well and update this post.
• This whole tutorial is based on the idea that you are applying this to a WordPress theme. If you’re using something else, you’ll need to alter this as you need.
• I have noticed that in some browsers, the swapping is not instant, and you may notice somewhat of a flicker. In my case the colours go away, and then the new ones are applied. Some browsers do not do this. I have no idea why this happens.

Setting up our files

For this solution we’re going to need to get some files from the JQuery website (the latest JQuery build), and create some files in our Theme folder.

You are going to need to make a JavaScript folder – I called mine “js” – and multiple CSS files. One will be a core style sheet that contains all of the universal CSS styles, and then alternate sheets that contain the CSS that is swapped around.

Example setup:

• THEME FOLDER
  • style.css
  • Yellow Version.css
  • Red Version.css
  • Blue Version.css
  • Green Version.css
  • JS FOLDER
    • jquery.js
    • functions.js

The rest of this example will assume that you have that setup.

Setting up the CSS files

First off, you’re going to need some CSS files to play around with. Generally you would have a core css file that would contain all the styles that wouldn’t be affected by your swapper. Depending on how you use your swapper, this may or may not be the case. Some people want to totally alter the website with their swapper; I just wanted a colour change.

Note: I’m not going to paste all the CSS I used to format the actual tiles, because my layout requirements will be different than yours. Set the CSS code up however you need to make your selector HTML – we’ll see that in a bit – look right.

So you have your core css file (style.css for WordPress users). Do what you need to in that file and then put it away. We won’t be touching it very much. The only addition I put in my CSS files are the following:

.red {background-color:#FF3333;}
.yellow {background-color:#FBDC00;}
.green {background-color:#1FF900;}
.blue {background-color:#00CCFF;}

These four styles are in my core CSS file so that my swappers always have access to correct classes for them. What this means is that regardless of what CSS file is imported, the swapper tiles will always look the same.

Next up we have our swapping CSS files: Blue Version, Green Version, Red Version and Yellow Version.

Note: I use Yellow Version as my default, but that doesn’t come in for a little bit yet.

So in each one of these CSS files, I have the same selectors:

.specialBGColor {background-color:#FBDC00;}
a, .specialColourText, #left_bar .widget table th {color:#FBDC00;}
.specialTopBorder{border-top:20px solid #FBDC00;}

All of your swappable CSS files will have the same selectors with whatever colour differences you need. In my case The hex colours are going to change to whatever is appropriate for the file (yellow is #FBDC00, red is #FF3333, etc.) “specialBGColor” is basically a class I apply to anything that is going to have a swappable background. I also have a “speciallTopBorder” that does something similar, and some selectors for links and table headers to change their colours.

All of these swappable CSS files should be in the same directory. Since I am using WordPress my CSS files are all kept together in the same directory: the theme directory. I dislike the lack of separation but I’ll manage.

Once you’ve got all those set up we can move on to setting up the PHP functions

A dash of PHP

We need to add a little function to our functions.php file. The function will attempt to grab a value from the users cookie cache and return it. Pretty simple overall. In my case, if the cookie is not found, it returns a default string that is the URL to my yellow style sheet. As previously stated, the Yellow CSS file is the same.

Add the following to your functions.php file:

function getStyleCookie()
{
   if($_COOKIE["styleHref"] != null && $_COOKIE["styleHref"] != "")
   {
      echo $_COOKIE["styleHref"];
   }
   else
   {
      $url = bloginfo('template_url') + "/Yellow Version.css";
      echo $url;
   }
}

What this does is if it can get the cookies value – in this case “styleHref” cookie – this is explained in the JS – it will echo the value of the cookie. if it can’t it returns the default value of the Yellow Version.css location.

Note: I could have made the function a bit more universal by passing in the cookie name, but as I’m only using it for this one instance, I didn’t bother.

The basic markup

Alright lets set up the markup. Lets start with the header.

Locate the <head></head> section of your website (for WordPress users, this is usually the header.php file).

You’ll need to find where you have any current CSS files linked and paste the following over or after the CSS tags. I say over or after because depending how much of this you’re following, you may already have a core CSS file that you don’t want to remove.

<!-- THIS IS YOUR CORE CSS FILE. IGNORE THIS LINE IF YOU ALREADY HAVE THIS IN YOUR HEADER -->
<link rel="stylesheet" href="<?php bloginfo('stylesheet_url'); ?>" type="text/css"/>

<!-- some dynamic stuff that won't make any sense yet, but it will later -->
<?php if($_COOKIE["styleHref"] != null && $_COOKIE["styleHref"] != "") : ?>
   <link id="altsheet" rel="stylesheet" href="<?php echo $_COOKIE["styleHref"]; ?>" type="text/css"/>
<?php else : ?>
   <link id="altsheet" rel="stylesheet" href="<?php bloginfo('template_url'); ?>/Yellow Version.css" type="text/css"/>
<?php endif; ?>

What this does: try and get the URL to the currently used CSS file and render that CSS file. If nothing can be found, default to the Yellow Version style sheet. This may seem repetitive given that the functions.php code we put in also compensates for a lack of cookie. I’m one for having backup plans, and this was mine. If you don’t like it, you can simply remove the entire else section.

Next up is the actual swapper markup. I’m going to paste a simplified version of mine, because as I stated before, your swapper will look different than mine. As long as the base HMTL is the same, this solution works. how you style things up is totally up to you.

<div id="colour_swapper">
   <ul>
      <li>
         <a href="javascript:;" class="green" title="Green Version">Swap to green</a>
      </li>
      <li>
         <a href="javascript:;" class="yellow" title="Yellow Version">Swap to yellow</a>
      </li>
      <li>
         <a href="javascript:;" class="blue" title="Blue Version">Swap to blue</a>
      </li>
      <li>
         <a href="javascript:;" class="red" title="Red Version">Swap to red</a>
      </li>
   </ul>
</div>

The important parts to this are two-fold.

First, the ID of the DIV element is going to be used in the JavaScript. I’m aware that the DIV isn’t really needed, but as I said, this is a simplified version of what I’m using, and as such I’ve actually stripped out additional elements contained in the DIV.

The second thing is the title of the ANCHOR items. The title will be used in the JavaScript to determine what CSS file to get.

Note: I’m aware that having a href of ‘javascript:;’ is a bad practice. In reality the href should offer a link that would manually post back the page, and have PHP  code that would look for that action and set the cookie that way. Doing so would allow for the swapper to work when JavaScript is disabled.

The JavaScript

Importing the required files

This is where everything is tied together and starts working.

First off we need to import some JS files. This solution imports JQuery, as well as a functions.js file that I created in a sub directory of my Theme folder called “js”. This was explained in the Setup section, but I’m still reiterating.

First we need to add a bit more markup within our <head></head> sections:

<script type="text/JavaScript" src="<?php bloginfo('template_url'); ?>/js/jquery.js"></script>
<script type="text/javascript">
   var templateUrl = "<?php bloginfo('template_url'); ?>";
</script>
<script type="text/JavaScript" src="<?php bloginfo('template_url'); ?>/js/functions.js"></script>

What we’re doing here:

1. Importing the JQuery framework.
2. Setting a JavaScript variable that contains the template_url value from WordPress. This makes life easier when we get to the actual cookie setting.
3. Importing our functions.js file that will contain all of our functionality.

Note: I’m not a JavaScript expert, and part of me thinks that there should be a way to pass in the template URL to the functions.js import call. I don’t know and if someone can comment on this and explain, I’d be more than happy to refine my work.

Next up we need to add some functionality to the functions.js file!

Adding functionality

I’ll pase the code first and then explain it:

var $j = jQuery.noConflict();

$j(document).ready(function(){
   $j("#colour_swapper a").click( function(){
	var style_title = $j(this).attr("title");
	var style_href= "";
	var altSheet = $j("#altsheet");

	altSheet.attr({"href":templateUrl +"/" + style_title+".css"});

	style_href = altSheet.attr("href");

	var date = new Date();
	date.setTime(date.getTime()+(1*24*60*60*1000));
	var expires = "; expires="+date.toGMTString();
	document.cookie = "styleHref="+style_href+"; expires="+date.toGMTString()+"; path=/";
   });
 });

What the hell is going on:

1. Set JQuery to no conflict mode by assigning it to a different variable. I had to do this because of other plugins I use on my site. I maintain that this is a good idea when you are working in a plugin-heavy framework like WordPress.
2. For every link found within the element with the id of colour_swapper attach a new click function
3. Set a variable to the value of the links title (Yellow Version, Green Version, etc)
4. Grab the element with the id of “altsheet” (in our case this is a link element in our header) and change it’s href value to the url of the new style sheet. This url is made up of the template URL and the name of the style sheet (title of the anchor)
5. Set a variable with the URL the new CSS file to be used.
6. Create a date variable, and set it to the future (exact day eludes me at the moment. Part of me thinks that it’s either 24 hours into the future, or 1000 days. I can’t honestly remember at this point).
7. Convert the date to a GMTString which is used in the creation of cookies.
8. Create a cookie, “styleHref”, that stores the URL of the style sheet used. This cookie is set to expire in the future, and will apply to all pages within the website (that’s what the “/” is for)

Whew! That took longer to explain than I thought.

Pulling it all together

So now that we’ve gone through all that, everything should work. To give you an idea on how it all comes together I’ll explain the general flow.

Flow

• While the page is loading, try and grab the cookie and set the secondary style sheet. If none is found, apply a default (Yellow Version)
• Import all of the JavaScript needed.
• User clicks on a style swapping link
• JavaScript figures out what style sheet to use
• Changes the secondary sheets href to the new CSS file
• Sets a cookie to store the URL of the new CSS file

Now if a user navigates to another page in your website, the first step will apply the change right off the bat.

Conclusion

I hope that this helps someone out there, and comments are more than appreciated to help improve the solution. I’ll try and refine the solution a little more when I have time.

Good luck and happy coding!

I myself am a fan despite it’s assault on the CPU and database. It’s fast, it’s simple, and so long as your website isn’t gaining huge traffic (or you’re paying peanuts for CPU usage and storage) than it’s a great selection. It’s fairly customizable, has a huge support and user base, and it’s just damned easy to use. I’ve been slowly getting more and more into customizing and extending what WordPress can do out of the box.There’s more in the code than people think.

Recently I a friend of mine ripped a strip off of me for only using summaries in my RSS feed. He told me that he, along with other net-savvy users, didn’t have time to get teased by RSS summaries.

UPDATE: As of December 3rd, 2008 I’ve turned this baby into a plugin! Check it out.

For those wishing to skip the lengthy buildup, here is a little table of contents:

• The Back Story
• Solution
• Explanation
• Installation and Usage
• Further Notes

The Back Story – To Summarize or not to Summarize

This is some what of a conundrum, as I want people to actually come to my site. On the flip side, I want people to read what I write. So I can force people to come to my site and gain page views, or I can increase my RSS readership. After careful consideration, I’ve opted to fix my RSS feed to display the entire content.

Here’s the issue: Until now, I’ve used ‘The Excerpt’ field in WordPress. Basically this allows me to have a pretty excerpt instead of 55 characters truncated with a “READ MORE PLEAZE!” I use the custom excerpt for the top part of the post; the preview if you will. The problem with this is that I had to rip out the first couple paragraphs from the post area, add some HTML to make sure it worked, and then post. The result looked pretty, but had some unexpected side-effects on the RSS.

As it turns out, when you decide to use the EXCERPT field, that excerpt will become the summary in the RSS. That’s all well and good, but what If you want to have the whole post? One would hope that it would stitch the Excerpt and the Post together, but alas this was not the case.

I turned to the <!–more–> tag to assist me.

What they don’t document about the more tag is pretty much all the bitchy parts of it. When you use the <!–more–> tag, you split the content, allowing for the excerpt to be defaulted to all the content preceding the tag. This is great, except for how my layout works. You see The top have is the Excerpt, and the bottom half is the rest of the post. Just using the_content wouldn’t work, because I would be repeating all the pre-more content.

I thought about maybe using an hr tag, or reworking my entire layout, but I dismissed those due to the complexity of the markup. My only option was to carve into WordPress itself. I first checked Google to see if anyone had come up against what I was facing. As it turns out people have asked the question, but no one has posted the answer.

I am fixing that right now.

Getting the Pre and Post <!–more–> content separately

Here is my solution, in full:

function the_formatted_pre_more_from_content ($body)
{
$returnVal = get_the_formatted_pre_more_from_content ($body);
if ($returnVal !== FALSE)
echo get_the_formatted_pre_more_from_content ($body);
else
the_excerpt();
}

function get_the_formatted_pre_more_from_content ($body)
{
$moreTag = ‘<!–more’;
$content = FALSE;

$morePos = stripos($body, $moreTag);
if ($morePos !== FALSE || $morePos > -1)
$content = substr($body, 0, $morePos);
else
return FALSE;

$content = apply_filters(‘the_content’, $content);
$content = str_replace(‘]]>’, ‘]]>’, $content);

return $content;
}

function the_formatted_post_more_from_content ($body)
{
echo get_the_formatted_post_more_from_content ($body);
}

function get_the_formatted_post_more_from_content ($body)
{
$moreTag = ‘<!–more’;
$content = FALSE;

$morePos = stripos($body, $moreTag);

if ($morePos !== FALSE || $morePos > -1)
{
$content = substr($body, $morePos + strlen($moreTag));
$morePos = stripos($content, ‘–>’); // reuse variable
if ($morePos !== FALSE || $morePos > -1)
$content = substr($content, $morePos + 3); // strip off rest of more tag
}
else
$content = $body;

$content = apply_filters(‘the_content’, $content);
$content = str_replace(‘]]>’, ‘]]&gt;’, $content);

return $content;
}

Explanation

The two important functions here are ‘get_the_formatted_pre_more_from_content’ and ‘get_the_formatted_post_more_from_content’. Long names, I know, but at least their mission is clear.

The other two functions ‘the_formatted_pre_more_from_content’ and ‘the_formatted_post_more_from_content’ pretty much add a bit of logic and echo the content automatically. I chose this naming structure and function structure to emulate what is already in WordPress (e.g. ‘the_content’ versus ‘get_the_content’).

Installation and Usage

To use this code, add it all to your functions.php file of your theme. I’m sure I, or some other enterprising person, could turn this into a plugin, but at the moment I don’t feel it’s warranted.

All of the functions take one parameter: $body.

When you call these functions you must be in The Loop.

example usage: <?php the_formatted_pre_more_from_content($post->post_content); ?>

explanation: This call will display the content preceding the <!–more–> tag.

example usage: <?php the_formatted_post_more_from_content($post->post_content); ?>

explanation: This call will display the content proceeding the <!–more–> tag.

Further Notes

UPDATE: As of December 3rd, 2008 I’ve turned this baby into a plugin! Check it out. I’ve also fixed the post_content bug!

Note the $post->post_content that is passed into the function. This exists automatically when you are in The Loop. This will pass all of the posts content to the function without any formatting. The only thing that isn’t straight text – conveniently – is the <!–more–> tag. As a result the content becomes fairly straight forward.

As of right now you must pass $post->post_content to the functions. I tried to do it without passing the value, and they don’t seem to pick up the value.

I opted for using a substring functionality as opposed to an array split function simply because it was 2 am when I finally got this going. I don’t know which is more efficient, so someone who is more knowledgeable in PHP can comment on this and state which is better.

I only search for ‘<!–more’ because according to the tag documentation, there is text that can follow the MORE that changes some functionality. As a result, I have an additional if statement in the get_post function that will detect for the end of the tag and substring the content again to trim that out.

I hope that this helps out some people who may be in a similar boat as I was.

Then I tried to create a Custom List. I had event receivers attached to custom lists (ListTemplateID=100 for those who care) and i got this:

Cannot insert the value NULL into column ‘Name’, table ‘[somesharepointcontentdatabase].dbo.EventReceivers’;
column does not allow nulls. INSERT fails.
The statement has been terminated.

Took me a good two hours of trying everything I could think of with my XML and code, only to be repeatedly thwarted by this database-level error! I tried commenting out different sections of my receivers and still got the error. When I commented the entire <Receivers> section, things ran fine, but not the <Receiver> items inside. What the hell is going on? Read on!

I’ll give an example of what I’m talking about here – the following comes from MSDN:

feature.xml:
<Feature
Scope=”Web”
Title=”Simple Updating Item Event Handler Registration”
Id=”A6B8687A-3200-4b01-AD76-09E8D163FB9A”
xmlns=”http://schemas.microsoft.com/sharepoint/”>
<ElementManifests>
<ElementManifest Location=”elements.xml”/>
</ElementManifests>
</Feature>

inside the feature.xml file (above) it references the following file:

elements.xml:

<Elements xmlns=”http://schemas.microsoft.com/sharepoint/”>
<Receivers
ListTemplateOwner=”ADDABAAA-1111-2222-3333-111111111111″
ListTemplateId=”104″>
<Receiver>
<Name>SimpleUpdateEvent</Name>
<Type>ItemUpdating</Type>
<SequenceNumber>10000</SequenceNumber>
<Assembly>SimpleUpdateEventHandler, Version=1.0.0.0, Culture=neutral, PublicKeyToken=10b23036c9b36d6d</Assembly>
<Class>MS.Samples.SimpleItemUpdateHandler</Class>
<Data></Data>
<Filter></Filter>
</Receiver>
</Receivers>
</Elements>

This works fine. Here’s something interesting though: any comments – <!– Like this –> - you have in the <Receivers> node will be literally interpreted as <Receiver> nodes! That means whenever it tries to attach event receivers to any list, it treats the comments as actual receivers! That’s right, for whatever reason, the code that ties event receivers to lists literally loops through every node (comments are still considered nodes!) and tries to use them instead of using any sort of XPath. How hard is it to use “//Elements/Receivers/Receiver” as your node collection XPath? I really hope whoever wrote that code got the ruler or something.

The solution: Remove comments from your Feature xml file(s).

I say this because God only knows where else this is happening, and the odds of you realizing that it is something that should just work, like comments, are probably not that high. Remember folks, sometimes the most obtuse problems have the most simple answers. Try not to over-think things.

A huge thank you must go out to Janne Mattila for being the first (and apparently only according to Google) documenting this. I wish I had looked sooner.