WordPress: Use Custom Fields To Add Keyword Metadata to Your Posts

Ed Stafford — Thu, 04 Feb 2010 11:00:10 +0000

Keywords for edwardstafford.com

One of the short-comings with using WordPress is that it does not provide an easy, built-in way to include metadata for your web page descriptions and keywords (and rightfully so). Why Not? The reason is simply that WordPress cannot read your mind. I know it’s hard to believe when you consider what you can do with wordpress, but it’s true. The issue with Description and Keyword page metadata is that, to be truely effective, it should be created to describe the content found on each individual page. It’s how search engines like google determine how to categorize and index each page. Now, there are some SEO “experts” who will argue that this information is not very relevant anymore, and I do agree with that for the most part, but there are still SEO benefits to including this metadata vs. not including it at all.

I’ve been giving this some thought lately and developed a couple ideas of how to add these features into a wordpress site without too much difficulty. A bulb went off in a moment clarity when I started to think about using the Custom Fields to store page specific metadata. I was even naive enough to think I was on to something new (should have known better) but as I started researching some ideas, I realized there were others already doing similar things. Oh well, a minor detail. I took my own approach to the idea anyway, if for no other reason than a learning exercise. Ultimately, this could be added as a premium feature to any custom theme using a couple hooks and some custom theme options magic.

Okay smarty-pants! So how do we include description and keyword metadata?

The solution isn’t difficult to implement and can be used to add page specific metadata inside the tag of any wordpress page. In this example, I’m going to show you a simple solution, but with some creativity and a little thought, you can expand this to provide a more robust solution for your own needs.

Part I: Defining a Custom “Keywords” Field

Custom Fields are a little used gem found in the Posts and Pages page of the WordPress dashboard / admin back end and available when you add a new post or page, or edit an existing post or page.

Create a new custom field

To create a new custom field to use for your page or post keywords, scroll down to the Custom Fields section below the main editor and click the “Enter new” link.

That action will activate the input fields for “Name” and “Value”.

In the Name field type the name identifier you’d like to use. This identifier/name will be used to reference the custom field name/value pair later so make it something relevant to avoid confusion. For this example, I am using “keywords“.

In the Value field, type the string of keywords or phrases that you want to use as the keyword metadata string for the page/post. For this example, I am using wordpress, seo, metadata, custom fields

Add New Custom Field Inputs

When you’re done, hit the “Add Custom Field” button.

If you have already created a “keywords” Custom Field for a previous page or post, you will have the option of selecting it in future pages and posts from the Name drop down menu.

Select from Custom Fields Menu

Select the Keywords item from the menu and then add the keywords or phrases for your new page to the Value field. When your done, make sure you hit the “Add Custom Field” button to confirm it.

That completes Part I. You now have a functional Custom Field assigned to your post/page.

Next up! Adding and understanding the code that generates the keyword metadata tag.

Part II: The Magic Code.

function set_keywords(){
global $post;
$keywords = get_post_meta($post->ID, ‘keywords’, true);
$default_keywords = “Your, selection, of, default, keywords”;
$metatag= “”;

if (empty($keywords)){
$keywords = $default_keywords;
}
if (is_home() || is_front_page()){
$keywords = $default_keywords;
}

$metatag=”\t”;
$metatag.= “ $metatag.= $keywords;
$metatag.= “\” />”;
$metatag.= “\n\n”;

echo $metatag;
}
add_action(‘wp_head’, ‘set_keywords’);

Adding this block of code to your Theme’s functions.php file will create and insert page specific Keyword Metadata into inside the tag of your pages and posts assuming you have completed Part I.

How the code works

function set_keywords(){

The first line declares our function and sets the name “set_keywords”.

global $post;
$keywords = get_post_meta($post->ID, ‘keywords’, true);
$default_keywords = “Your, selection, of, default, keywords”;
$metatag= “”;

These four lines set up the variables that will be used later in the function.

global $post allows the function to reference values stored in an array containing post information that was previously set by WordPress outside of the current function.

$keywords = get_post_meta($post->ID, ‘keywords’, true) is up next and sets our variable, $keywords to a string value equal to the “keywords” Custom Variable if it was set for the current page in Part I by calling the wordpress function get_post_meta().

get_post_meta() is passed three arguments.

The post ID ($post->ID)
a Custom Field Name reference (keywords)
a boolean value (true)

These three arguments tell get_post_meta() to grab the “keywords” Custom Field value for a specific page ($post_ID = a reference to the current page) and return a string result (true).

Note: If the Boolean argument were set to “false”, get_post_meta() would return an array object instead of a single string.

$default_keywords = “Your, selection, of, default, keywords” sets a set of default keywords to use when the $keywords variable is empty or not set, or when you just want to include a general set of keywords.

$metatag = “” rounds up the variables for the function and is used to build the metadata tag string that will be inserted into the page tag.

if (empty($keywords)){
$keywords = $default_keywords;
}

The next step in the code is a conditional statement. Here I use the common PHP empty() function passing the $keywords variable as an argument to check whether the $keywords variable contains a value. If the empty() function returns true it means that $keywords does not contain a usable value, or that is has not been set. If this condition is true, it will set the value of $keywords to that of $default_keywords.

If the Keywords Custom Field was set for the current page, then the get_post_meta() function should have set the $keywords variable to a usable value equal to the Keyword Custom Field value. The condition will return false and the variable retains it’s Custom Field value.

if (is_home() || is_front_page()){
$keywords = $default_keywords;
}

Next I have another conditional statement that uses WordPress functions to see if the current page is either the home page – is_home(), or the “blog” page – is_front_page() If the current page matches either of these pages, I want to assign the value of $default_keywords to the $keywords variable.

The reason I do this is because the content on these pages is more dynamic and has a tendency to change often, effecting keyword relevancy. So I want to provide a generic set of default keywords instead of page content specific keywords.

Note: It is possible, using more in-depth techniques not covered here, to also include the Keywords Custom Field for these pages and enable a set of more targeted keywords for them.

$metatag=”\t”;
$metatag.= “ $metatag.= $keywords;
$metatag.= “\” />”;
$metatag.= “\n\n”;

These lines are used to build the actual text string creating the metadata tag for our page’s tag. for example, if our page contained a keyword Custom Field with a value of ”keyword1, keyword2, keyword3″, the output for a blog post or single page would be:

echo $metatag;
}

Wrapping up the function we have echo $metatag followed by the closing bracket bringing our function to a close. echo $metatag simply writes the output of the $metatag variable to the source of your web page inserting the keyword meta tag in the page’s tag.

add_action(‘wp_head’, ‘set_keywords’);

And finally bringing this code bit to an end is add_action(‘wp_head’, ‘set_keywords’). The add_action() function is a wordpress function used to hook your custom function to a WordPress action. In this case we are hooking our function set_keywords to the wordpress action wp_head. This is the piece that actually inserts your meta tag into the page tag.

Note: It is up to the individual theme developers to include the wp_head action in their themes, so there is a chance that your theme will not have it. In that case, check the documentation for your theme to see what action hooks are available to you.

That pretty much wraps it up!

Umm, Aren’t you forgetting something?

By now you may be thinking, “Great, but what about the Description meta tag you mentioned?”.

You can use this same technique demonstrated here to create unique page descriptions with just a few minor code changes. Just replace keyword references with description references.

Do you have any suggestions to imporve on this? Find it helpful? Have some else to share? Leave a comment!

5 Tips for better Wiki pages.

Ed Stafford — Mon, 13 Oct 2008 00:12:36 +0000

Wikis are great for sharing, documenting and archiving information. We Recently launched one for our company’s intranet to improve communication and allow better collaboration. Because wikis are intended to be an open platform to promote communication and collaboration equally across the organization, we try to encourage everyone to contribute. Unfortunately, I quickly learned that people can have different ideas regarding good page format, or may not know how to properly format a page at all. This can quidkly lead to mess of unruly pages that are difficult to read and navigate. So, I put together a list of five tips that I thought would help make formating wiki page content a little easier and make the pages less challanging to read and navigate.

When creating a new page, or editing an existing one, keep these tips in mind.

Say No To Word: Unless the wiki has a built-in feature to deal gracefully with Microsoft Word syntax, Please Please Please…avoid copy-and-paste from word documents. Word documents create ugly HTML syntax that is difficult to edit and manage within the wiki (or any wysiwyg or web editor for that matter). It also creates pages that are structurally difficult to read and navigate without additional formatting and editing. As an alternative, save word documents as Rich Text Files, or plain text files then copy-and-paste into the wiki from there, then edit and format the content in the wiki using the wiki editing tools.
Use Headers and sub-headers: Add headers and sub-headers when appropriate to organize your content on the wiki page. Using headers will not only help to visually separate each important section of your page, but they will also auto-create a page index or TOC (Table of contents) making it easy for users to find and navigate page content.
Making The list: Use Ordered (numbered) lists and Unordered (bulleted) lists when creating lists of items. This makes each item in a list easy to identify and improves readability.
Use An Opening Introduction: If your creating a new wiki page, always try include some information in a small paragraph at the top of each page describing what the content is about, and how it can be used. It is also helpful to include a small description below each heading and sub-heading as well. This helps readers to quickly identify the content and how it can be used.
Can I Quote You On That? : Provide citations and supporting links to references when possible. Besides giving credit where credit is due, citations allows readers to confirm the validity of your input and lead them to additional sources of reference.