phoenixheart - portfolio & more » snippet http://www.phoenixheart.net phoenixheart - portfolio & more Wed, 23 Mar 2011 09:47:25 +0000 en hourly 1 http://wordpress.org/?v=3.1 Code Snippet 3 – Create post slugs http://www.phoenixheart.net/2009/10/code-snippet-3-create-post-slugs/ http://www.phoenixheart.net/2009/10/code-snippet-3-create-post-slugs/#comments Sat, 17 Oct 2009 12:20:40 +0000 An http://www.phoenixheart.net/?p=328 If you’re used to WordPress, you must have noticed that usually a blog doesn’t use the default permalink structure (like http://site.com/?p=43, where 43 is the post ID store in the database). Instead, almost all blog owners tend to use the built-in option form to set the permalinks to something similar to http://site.com/a-great-post and leave the rest to Apache’s mod_rewrite to handle. In this case, a-great-post is called a post slug, or to be short, a slug. According to WordPress Codex:

A slug is a few words that describe a post or a page. Slugs are usually a URL friendly version of the post title (which has been automatically generated by WordPress), but a slug can be anything you like. Slugs are meant to be used with permalinks as they help describe what the content at the URL is.

In case you are wondering, slugs play a really, really important part in SEO. This is due to the fact that search engines like Google analyze an URL, and if it is relevant to the page’s content, the page’s rank point may be increased. Just like to us human, ?p=43 doesn’t tell anything, but how-to-create-post-slugs surely does.

So how is a slug generated? Most of the time, the post/page title is involved.

  1. First, notice that all slugs are in lowercase format
  2. Second, all non-alphanumeric characters – those ugly &?#$()… – are removed.
  3. Third, spaces get replaced by dashes

Let’s codify them into PHP:

1
2
3
4
5
6
7
8
9
10
11
12
13
14

function create_slug($post_title)
{
    // 1. convert into lower case
    $post_title = strtolower($post_title);
 
    // 2. only accepts alphanumerical characters (a-z, 0-9), spaces, and dashes
    // to do that, we use some RegEx magic
    $post_title = preg_replace('/[^a-z0-9 -]/', '', $post_title); 
 
    // 3. replace the spaces with dashes
    $post_title = str_replace(' ', '-', $post_title);
 
    return $post_title;
}

Now test the function – we’ll be using some real world examples from Digg:

1
2
3
4

echo create_slug("High-Speed 'Other' Internet Goes Global ") . '';
echo create_slug('Proposed Anti-Piracy Legislation is Flawed, ISP   Says') . '';
echo create_slug('Cheetah, Gecko and Spiders Inspire Robotic Designs (PICS)') . '';
echo create_slug('In-App Sales & iTablet: The Killer Combo to Save Publishing?');

The above code produces:

high-speed-other-internet-goes-global-
proposed-anti-piracy-legislation-is-flawed-isp---says
cheetah-gecko-and-spiders-inspire-robotic-designs-pics
in-app-sales--itablet-the-killer-combo-to-save-publishing

Not bad huh? There are some problems however. First, if the title has continuous spaces, the slug will contains continuous dashes, which is not quite right. Second, much more important, we didn’t take into account a concept called stop words – long story short, stop words are words that don’t contain important information and are often filtered out from search queries by search engines. A list of English stop words can be found here.

With this information on hand, we improve our code a bit:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

function create_slug($post_title)
{
    // 1. convert into lower case
    $post_title = strtolower($post_title);
 
    // 2. only accepts alphanumerical characters (a-z, 0-9), spaces, and dashes
    // to do that, we use some RegEx magic
    $post_title = preg_replace('/[^a-z0-9 -]/', '', $post_title); 
 
    // 3. replace the spaces with dashes
    $post_title = str_replace(' ', '-', $post_title);
 
    // 4. deal with stop words. I added '' (empty string) into the stop words array too.
    $stop_words = array('', 'a', 'about', 'above', 'above', 'across', 'after', 'afterwards', 'again', 'against', 'all', 'almost', 'alone', 'along', 'already', 'also','although','always','am','among', 'amongst', 'amoungst', 'amount',  'an', 'and', 'another', 'any','anyhow','anyone','anything','anyway', 'anywhere', 'are', 'around', 'as',  'at', 'back','be','became', 'because','become','becomes', 'becoming', 'been', 'before', 'beforehand', 'behind', 'being', 'below', 'beside', 'besides', 'between', 'beyond', 'bill', 'both', 'bottom','but', 'by', 'call', 'can', 'cannot', 'cant', 'co', 'con', 'could', 'couldnt', 'cry', 'de', 'describe', 'detail', 'do', 'done', 'down', 'due', 'during', 'each', 'eg', 'eight', 'either', 'eleven','else', 'elsewhere', 'empty', 'enough', 'etc', 'even', 'ever', 'every', 'everyone', 'everything', 'everywhere', 'except', 'few', 'fifteen', 'fify', 'fill', 'find', 'fire', 'first', 'five', 'for', 'former', 'formerly', 'forty', 'found', 'four', 'from', 'front', 'full', 'further', 'get', 'give', 'go', 'had', 'has', 'hasnt', 'have', 'he', 'hence', 'her', 'here', 'hereafter', 'hereby', 'herein', 'hereupon', 'hers', 'herself', 'him', 'himself', 'his', 'how', 'however', 'hundred', 'ie', 'if', 'in', 'inc', 'indeed', 'interest', 'into', 'is', 'it', 'its', 'itself', 'keep', 'last', 'latter', 'latterly', 'least', 'less', 'ltd', 'made', 'many', 'may', 'me', 'meanwhile', 'might', 'mill', 'mine', 'more', 'moreover', 'most', 'mostly', 'move', 'much', 'must', 'my', 'myself', 'name', 'namely', 'neither', 'never', 'nevertheless', 'next', 'nine', 'no', 'nobody', 'none', 'noone', 'nor', 'not', 'nothing', 'now', 'nowhere', 'of', 'off', 'often', 'on', 'once', 'one', 'only', 'onto', 'or', 'other', 'others', 'otherwise', 'our', 'ours', 'ourselves', 'out', 'over', 'own','part', 'per', 'perhaps', 'please', 'put', 'rather', 're', 'same', 'see', 'seem', 'seemed', 'seeming', 'seems', 'serious', 'several', 'she', 'should', 'show', 'side', 'since', 'sincere', 'six', 'sixty', 'so', 'some', 'somehow', 'someone', 'something', 'sometime', 'sometimes', 'somewhere', 'still', 'such', 'system', 'take', 'ten', 'than', 'that', 'the', 'their', 'them', 'themselves', 'then', 'thence', 'there', 'thereafter', 'thereby', 'therefore', 'therein', 'thereupon', 'these', 'they', 'thickv', 'thin', 'third', 'this', 'those', 'though', 'three', 'through', 'throughout', 'thru', 'thus', 'to', 'together', 'too', 'top', 'toward', 'towards', 'twelve', 'twenty', 'two', 'un', 'under', 'until', 'up', 'upon', 'us', 'very', 'via', 'was', 'we', 'well', 'were', 'what', 'whatever', 'when', 'whence', 'whenever', 'where', 'whereafter', 'whereas', 'whereby', 'wherein', 'whereupon', 'wherever', 'whether', 'which', 'while', 'whither', 'who', 'whoever', 'whole', 'whom', 'whose', 'why', 'will', 'with', 'within', 'without', 'would', 'yet', 'you', 'your', 'yours', 'yourself', 'yourselves');
    $slug = array();
 
    // explode() the post title into single words
    $segments = explode('-', $post_title);
    foreach ($segments as $segment)
    {
        // if the segment is not a stop words, add it into $slug array
        if (!in_array($segment, $stop_words))
        {
            $slug[] = $segment;
        }
    }
 
    // now convert the $slug array into a string with dashes being the connector
    $slug = implode('-', $slug);
 
    return $slug;
}

Run the previous example again, we have:

high-speed-internet-goes-global
proposed-anti-piracy-legislation-flawed-isp-says
cheetah-gecko-spiders-inspire-robotic-designs-pics
app-sales-itablet-killer-combo-save-publishing

That’s better, and this time much more usable, isn’t it? Now the next step should be the database part – create a `slug` field as a unique key, and start querying on it instead of the ID. You handle it!

]]> http://www.phoenixheart.net/2009/10/code-snippet-3-create-post-slugs/feed/ 0 Code snippet #2 – Shorten Links Using Bit.ly http://www.phoenixheart.net/2009/05/code-snippet-2-shorten-links-using-bitly/ http://www.phoenixheart.net/2009/05/code-snippet-2-shorten-links-using-bitly/#comments Sat, 09 May 2009 02:29:26 +0000 An http://www.phoenixheart.net/?p=285 Following the first snippet, here is another small one to shorten a link using Bit.ly. I chose Bit.ly over other link shortening services due to a simple reason: Twitter uses it as default (by now).

Code snippet #2 – Shorten Links Using Bit.ly

Purpose

Create a shortened URL using Bit.ly. This is extremely useful for your visitors, as they don’t have to look any further – just grab it to use right away.

Requirements

  • A Bit.ly account (and API key). You can create one for free at their site in seconds. Once logged in, head to Account section and look for a long ugly string starting with “R_”.
  • PHP 5 >= 5.2.0. Your host doesn’t support PHP 5? Claim your money back and find another host.

The Code

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

function get_shortened_url($url)
{
    $bitly_api_key = 'YOUR KEY HERE';
    $bitly_username = 'YOUR BIT.LY USERNAME HERE';
    $data = file_get_contents("http://api.bit.ly/shorten?version=2.0.1&longUrl=$url&login=$bitly_username&apiKey=$bitly_api_key");
 
    $data = json_decode(utf8_encode($data));
 
    if ($data->errorCode)
    {
        return false;
    } 
 
    return $data->results->$url->shortUrl;
}
 
// now use it
echo get_shortened_url('http://www.example.com/this-is-a-stupid-long-long-long-url.html');
 
// how about WordPress?
// Just place the function above somewhere in your functions.php theme page and then
 
// 1. inside The Loop
echo get_shortened_url(get_permalink());
 
// 2. outside The Loop
echo get_shortened_url(get_permalink($post->ID));
 
]]> http://www.phoenixheart.net/2009/05/code-snippet-2-shorten-links-using-bitly/feed/ 1 Code snippet #1 – Get Latest Tweet http://www.phoenixheart.net/2009/05/code-snippet-1-get-latest-tweet/ http://www.phoenixheart.net/2009/05/code-snippet-1-get-latest-tweet/#comments Wed, 06 May 2009 12:29:41 +0000 An http://www.phoenixheart.net/?p=271 Ok so I’m following some guy’s recommendation (sorry, I really forgot his name as well as his blog address) to try to post something useful even when I don’t have anything to blog about. How about a series of code snippets? To some they are old but to the others they may help – for example to myself two months later that is.

Code Snippet #1 – Get Latest Tweet

Purpose

  • Get your latest tweet from Twitter to show up instead of an unconvincing “Follow Me” link -or-
  • Display your idol’s latest tweet to wow your readers

Requirements

  • A Twitter account. Don’t have one? Head here or here

The Code

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

<?php
 
// the function
/**
 * @desc Get latest tweet from a Twitter account
 * @param string The account's username
 * @return string The tweet
 */
function get_latest_tweet($username)
{
    $url = "http://search.twitter.com/search.atom?q=from:$username&rpp=1";
    $content = file_get_contents($url);
    $content = explode('<content type="html">', $content);
    $content = explode('</content>', $content[1]);
    return html_entity_decode($content[0]);
}
 
// now use it
$my_username = 'Phoenixheart';
echo get_latest_tweet($my_username);
?>
]]> http://www.phoenixheart.net/2009/05/code-snippet-1-get-latest-tweet/feed/ 17