WP-SNAP! WordPress Plugin

Permalink  |  Comments [348]

What Is WP-SNAP!?

WP-SNAP! (WordPress System for Navigating Alphabetized Posts) creates an alphabetical listing of post titles on a Category or Page template file. Navigation through the listings WP-SNAP! generates is accomplished using the alphabet itself. (For example, if a site visitor clicked on the letter D, any post titles that began with that letter would be showcased.) WP-SNAP! will work on any Wordpress 2.1.x or higher site, but is particularly useful managing glossaries, indexes, reviews, or directories. Since it is said that a picture is worth a thousand words, here’s a screenshot of WP-SNAP! in action:

screenshot

WP-SNAP! offers three different navigational styles and integration with both custom permalinks and the Wordpress loop. Plugin options can be managed both site-wide and on the template itself with results either restricted to one category or broadened to include child categories as well. The clever web developer should have no problem seamlessly integrating WP-SNAP! into their latest project. Options have also been added to allow the customization of css class names and the appearance of html mark-up.

How To Configure WP-SNAP!

  1. Click on the link to the right to download the WP-SNAP! WordPress Plugin, extract it and upload it to your WordPress Plugins folder on your site.
  2. Activate the Plugin from the WordPress Administration Plugins tab.
  3. Edit the category templates your Theme uses, such as category.php, and add the following code above the start of the Wordpress Loop:
    <?php if (function_exists('wp_snap')) { echo wp_snap(); } ?>
  4. Copy the CSS example below and paste it into your WordPress Theme stylesheet (you can style it better later).
  5. Upload the files and refresh the category page on your WordPress blog to see it in action.
  6. For further customization, go to the Plugins > WP-SNAP! panel and change the alphabetical structure to something different and click Update Options. You may also change the categories to be displayed and the menu navigational structure by passing variables as a query-string to the plugin like so:
    <?php if (function_exists('wp_snap')) { echo wp_snap('arguments'); ?>

    There are currently four possible arguments: Category (’cat’), Include Category Children (’child’), Navigational Menu Style (’menu’), and First Load (’firstload’). Category must equal a category number from your WordPress installation, Include Category Children must equal true or false as to whether to include child categories (the default value is false), Navigational Menu Style must equal a number between 1 and 3 (corresponding with the three navigational styles offered in the admin options panel), and First Load must equal ALL, NONE or RECENT and will affect how WP-SNAP! displays posts/tags when it is first called on a template. Note that if RECENT is selected, the number of recent posts/tags to display can be controlled from the admin options page. For instance, to create a navigational menu for all posts in category 15, including child categories, using the default menu navigational style, and displaying recent posts on first load, WP-SNAP! would be called like this:

    <?php if (function_exists('wp_snap')) { echo wp_snap('cat=15&child=true&firstload=recent'); } ?>

    To create a navigational menu for the current category, excluding child categories and using navigational menu style 3, WP-SNAP! would be called like this:

    <?php if (function_exists('wp_snap')) { echo wp_snap('menu=3'); } ?>

    To create a navigational menu for all categories, using default navigational menu style, WP-SNAP! would be called like this:

    <?php if (function_exists('wp_snap')) { echo wp_snap('cat=all'); } ?>
  7. Test it out and enjoy!

Note: For the Plugin to work, you must have access to edit your WordPress Theme files. You must also have a category.php template file in your WordPress Theme. If you do not, you can create one following the instructions on the for creating a category template file.

CSS Styling

It should be noted that this plugin does not inject any css styling information, so it is up to the user to add the appropriate class information to the Wordpress Theme css stylesheet. Here is some sample code to get you started:


ol.snap_nav {
	display: inline;
	float: left;
	clear: both;
	list-style: none;
}

ol.snap_nav li {
	display: block;
	float: left;
	padding: 0 2px 10px 0;
}

ol.snap_nav li a {
	font-weight: bold
}

ol.snap_nav li.snap_selected a {
	cursor: text;
}

ol.snap_titles {
	clear: both;
	display: block;
	border: 0;
	list-style: none;
}

Feedback

This plugin thrives on user feedback. Praise, ideas, and bug reports are all welcome. Use the comment form below to let me know what you think. Please keep in mind that I am not paid to work on this plugin and that delays between updates can and will occur. Please do not post questions about when the next update will be released. I appreciate your enthusiasm, but your comment will be deleted. If there is a significant delay between releases, I try to post a timeframe of when the next update can be expected.

Thank You

My thanks to Lorelle VanFossen for reviewing my plugin and allowing me to reuse her instructions on this page.

Change Log

  • 06.2008.10 Version 0.8.5
    • Added international language file support
    • Changed the method for passing data to the plugin
    • Tracked down bugs
  • 06.2008.08 Version 0.8.4
    • Made the plugin compatible with Wordpress’s new tagging system
    • Corrected problem with listing recent posts
  • 04.2008.03 Version 0.8.3
    • Fixed a small — but significant — typo
    • Moved the administrative submenu to plugins.php
    • Added the ability to display All/None/Recent posts on first load
  • 12.2007.02 Version 0.8.1
    • Fixed incompatibility with PHP 4
  • 11.2007.28 Version 0.8
    • Added support for fancy URLs
  • 10.2007.04 Version 0.7.3
    • Fixed error with Wordpress 2.3 database call
  • 09.2007.28 Version 0.7.2
    • Made database call compatible with Wordpress 2.3
  • 06.2007.02 Version 0.7.1
    • Fixed error with database call
  • 05.2007.30 Version 0.7
    • Fixed issue preventing the display of more than 10 posts
    • Fixed issue with sorting uppercase/lowercase post titles
    • Restored ability to pass a category to the plugin
    • Added ability to include category children in returned results
    • Added ability to display all categories
    • Added ability to change navigation style when calling the plugin
    • Added support for Gengo (hopefully)
  • 05.2007.12 Version 0.6.2
    • Restored the ability to exclude first words from being alphabetized
    • Cleaned-up some instructional text in the options menu
  • 01.2007.21 Version 0.6.1
    • Fixed a minor error with the $wp_snap_category variable
  • 01.2007.20 Version 0.6
    • Rebuilt the entire plugin to be better, stronger, faster
    • Changed how results are displayed; plugin now plays well with the Wordpress loop
    • Removed option to pass a category number directly to the plugin, making it incompatible with Pages (feature to return if requested)
    • Added nonce protection to the admin options panel
    • Added option to group posts beginning with a number under ‘#’
    • Fixed unencoded ampersands
  • 09.2006.20 Version 0.5.4
    • Updated WP-SNAP! to ignore posts with post-dated timestamps
  • 08.2006.02 Version 0.5.3
    • Fixed an error that affected certain navigational menu styles
  • 08.2006.01 Version 0.5.2
    • Updated alphabetization to accomodate accent marks; still needs refinement
    • Fixed a logic error with the post title sort loop
  • 06.2006.07 Version 0.5.1
    • Squashed some bugs in the new ignore filter
  • 06.2006.06 Version 0.5
    • Words can now be filtered from the alphabetization process from the WP-SNAP! admin options menu
  • 06.2006.01 Version 0.4
    • Added ‘#’ to catch category entries beginning with non-alphanumeric characters
    • Tweaked the code here and there
    • Fixed the WP-SNAP! plugin url on the admin options page
  • 05.2006.13 Version 0.3.1
    • Fixed the url structure of the navigation when used on a Page
    • Added ‘apply_filters’ to the post excerpt
  • 05.2006.08 Version 0.3
    • Plugin no longer displays excerpts for password protected posts, if the viewer is unauthorized
    • If there is no excerpt for a post and excerpts are turned on, plugin now creates an excerpt from the post content
    • Fixed a typo
  • 03.2006.29 Version 0.2
    • Added the ability to pass a category number directly to the plugin, making WP-SNAP compatible with Pages
  • 03.2006.29 Version 0.1
    • Initial Release

Technorati TagsTags: , ,


Comments

Pages: [1] 2 3 4 518 » Show All

  • Hello Nathan–

    I was looking at using your plugin to create an alphabetized archive page. Unfortunately, the plugin generated 4 “headers already sent errors” and was then inaccessible from the Plugin management page. I had to delete it and never got the chance to take it for a spin. Offhand, do you know what might have caused the errors? The warnings were on lines 11, 12, 13, 14. Comments. I removed the comments, but the same error was generated. WP 1.5.2. Any ideas?

    cheers
    SAM :)

  • Sam —

    After doing a bit of research, it seems that header errors are most likely the result of “spaces, new lines, or other garbage before an opening <?php tag or after a closing ?> tag.” My guess is that you copied and pasted this plugin into a new document and accidently left extra spaces in the document. I suggest that you re-download the plugin by right-clicking on the above link and saving it to your drive. Thank you for your feedback!

  • Thanks! There was indeed one space after the closing ?>. Thanks for your quick response!

  • Where i put the plugin code?
    archive? single post?

  • Every attempt to activate the plugin returns a blank page for my blog. I have downloaded several times to avoid the problem you mentioned above.

  • Very cool. Just what I was looking for. Going to use it for software reviews for my friends and Dad. They are always asking me what software does this or tha, or what a particular piece of software I am using. This will work nicely on the cat page I made. Thanks!

  • Roberlan — for most themes, you would place the code in your category.php file. That’s the only way to get it to work in it’s default mode. But it’s really up to you. Where do you want your list of post titles to appear? It should work just about anywhere, as long as you pass a category number to it.

    andre — If you would like me to help you resolve the issue you are encountering, you will have to be a little more specific. How are you trying to “activate” the plugin? Do you mean from within your WordPress admin interface? Or when you place the wp-snap() function on the page? In which file are you placing the function? Where in the file are you placing it? If it’s one besides category.php, you’ll have to pass a category number to it.

    z — Thank you very much for the feedback. It’s great to hear that someone has found use for this!

  • nateo
    I haven’t been able to get past activating in the admin interface. I dl’ed the wp-.phps file upload to my plugin directory rename wp-snap.php. Then go the the admin interface click activate then I get blank page. if I remove the wp-snap.php everything goes back to normal. I’m running WP 2.01 on a unix box

  • hey nate, thanks for the answer, but in my wp installation (wp2.0.2) i don´t have “category.php” file. I can´t figure it out where to put the code…
    Anyway, thanks for the answer
    :)

  • andre — Off the top of my head, my first thought is that you’re having a conflict with another plugin. It would be helpful to know if you still get the blank page when you turn off all other plugins. If the blank page goes away, if you could let me know what plugins you’re using, I’ll see if I can figure out what the conflict is and fix it! Thanks!

    Roberlan — The “category.php” page would be in your theme files. So you’d go to /wp-content/themes/default/ to find category.php.

  • nateo I found the conflict I think it was with a plugin caled book review when I removed that wp-snap activated fine. Is a horizontal list an option?

  • andre — I’ll look up “book review” and see if I can figure out why it’s a conflict. Thanks for the heads up. Yes, the list can be made horizontal, you just have to add some code to your style.css file in your theme. Unfortunately, a css tutorial kind of goes beyond the scope of this plugin, but I did provide some sample css rules above. You’ll probably find that those rules will work better if you append the div id or class in which they are contained. For instance, if your php code looks like this:

    <div id="myid">
    <?php echo my_snap(); ?>
    </div>

    Then change the above styles to begin like this:

    #myid ol.snap_nav {
  • [...]   WP-SNAP!,提供按字母排列文章的导航条。 alphabetized navigating 字母 导航条 [...]

  • Hello,

    I am trying to organize a list of museums on a protected install of WP that I use to organize the notes for my doctorate. I want to display a single category of entries (cat # 15). I tried the syntax that you post … … but it did not work. What am I doing wrong? How can I get it to work because this is perfect for what I am to do?

  • Hello Thad —

    You didn’t mention in your post how WP-SNAP! failed, so it’s difficult for me to suggest a solution. Is your problem that you can’t isolate it to a single category? Or that it’s not working at all?

    If you are using the default theme, go to your archive.php file and starting at line 32, change your code to something like this:

    <?php if (is_category('15')) { ?>
    <div id="someid">
    <?php echo wp_snap(); ?>
    </div>
    <?php } else { ?>
    <div class="navigation">
    <div class="alignleft"><?php next_posts_link('« Previous Entries') ?></div>
    <div class="alignright"><?php previous_posts_link('Next Entries »') ?></div>
    </div>
    <?php } ?>

    That should get WP-SNAP! to display for the correct category, but you’ll probably want to clean things up a bit after that — maybe add a div container around it, include more html code in the else statement so that you don’t get full post entries displaying for category 15.

    Hope that helps.

  • nateo -

    Thanks! That fixed it! Cheers!

    Sorry about not describing the problem in too much detail …

    But, thanks for the solution!

  • Hello … today, I got an error message that I had not gotten since I started using it. Before today it had worked fine but today I get this error when I click on the category link -

    WordPress database error: [You have an error in your SQL syntax. Check the manual that corresponds to your MySQL server version for the right syntax to use near 'publish' AND `category_id` = '15' ORDER BY `post_title` ASC' at]
    SELECT `post_title`, `post_excerpt`, `ID` FROM rtp_notes_posts, rtp_notes_post2cat WHERE (left(`post_title`, 1) = ''') AND `post_id` = `ID` AND `post_status` = 'publish' AND `category_id` = '15' ORDER BY `post_title` ASC

    The other odd thing is that it works fine if I click on a letter (which are still displayed on the page below the error).

    Any help would be appreciated.

  • Sorry about posting too fast … but I figured out what broke the script. The last post that I had entered was started with ‘The Grove’ and evidently the quote breaks the script because it does not know how to handle it.

    Just wanted to let you know, cheers!

  • Hey Nate, AWESOME plugin. I’ve been tweeking with it this morning but I have one issue I can’t seem to resolve myself. I checked the box “Show Post Title and Excerpt” but only the post title shows up. Am I missing something?

    Thanks

  • Thad — Thank you for the heads up. I’m not sure what the best way to handle this is. Any suggestions?

    Rhine — WP-SNAP doesn’t automagically create excerpts like WordPress does. It actually pulls the excerpt from the excerpt post field. So, if you didn’t write an excerpt, nothing shows up. I’m not sure that this is the best way to go about this, because I’m sure many people make use of the auto excerpts WordPress creates. I’m sure it’s a fairly easy fix, let me think about it.

  • Pages: [1] 2 3 4 518 » Show All

    Leave a Reply

    Allowed markup: a blockquote br code em pre strong ul ol li

Download The Latest Release

WP-SNAP! v0.8.5 (zip archive)

View The Code

WP-SNAP! v0.8.5 (phps)

Make A Donation

If you find this plugin useful, please consider making a donation. It's a great way to say “thank you” for all the hard work that has gone into its development.

Frequently Asked Questions

  1. When will the next version of your plugin be released?

    As soon as I find the time, I will update the plugin and release a new version. I understand how frustrating it can be to be so close to having the perfect Wordpress installation only to be held up by a plugin that just needs a little more work to be exactly what’s needed. However, please remember that I am not paid write this plugin and that, like you, I have a family and responsibilities that extend far beyond this little piece of code. I really appreciate your enthusiasm, but if you wish to reap the benefits of my freely given labor, then you must be satisfied with doing so on my timetable. Otherwise, if you simply cannot wait, you are more than welcome to modify and extend the capabilities of my plugin yourself.

  2. Why do the results WP-SNAP! returns look funky? Why is it numbering every item?

    A web page is composed of two parts: a document containing HTML code and a document containing styling code (known as a Cascading Style Sheet, or CSS for short). Because WordPress templates can look so drastically different from one another, I have intentionally avoided injecting any CSS information into WP-SNAP! However, I have included several ID selectors (that can even be modified from within wp-admin) that should allow you to style WP-SNAP! to look however you’d like. Those numbered lists? You can turn them off. I do ask that you try to refrain from asking me CSS related questions — while I would love to help you, my time is limited. If you would like to learn more about CSS, I suggest visiting A List Apart or Vitamin.

  3. I tried using your plugin, but it just won’t work. What am I doing wrong?

    Unfortunately, I don’t have the time to troubleshoot every installation of this plugin. However, if you believe you have discovered a bug, I encourage you to post a comment to my website and I will reply as soon as I can. I do request that you be as specific as possible when asking for assistance. Please provide a detailed account of the steps you took that resulted in the error you encountered so that I can try to reproduce it and more quickly deduce how to fix it.