Go to main content

If custom field




The if_custom_field tag may be used as a single or conditional tag. For conditional use, it is used as an opening and closing pair, like this…

    …conditional statement…

The tag will execute the contained statements if one or more custom fields for a given article have content. The contents of a custom field can be displayed with the custom_field tag.

If used a single tag, the tag will return 1 if the named custom field contains any content. It will return nothing otherwise. See Example 5.


Tag will accept the following attributes (case-sensitive) as well as the global attributes :

match="match type" v4.3.0+
How you wish your value to be tested. Choose from:
exact: value text must exactly match the custom field.
any: checks if any of the given comma-separated list of values occur anywhere in the custom field.
all: checks if all of the given comma-separated list of values occur anywhere in the custom field.
pattern: allows you to specify a regular expression in your value attribute to match against the custom field.
Default: exact.
name="field name"
The custom field name you wish to check.
separator="character" v4.3.0+
If you wish to treat your custom field as a list of items - so that each item is a discrete entity and tested separately when using any or all matching - specify the delimiter that you use in the custom field. This attribute is ignored if using exact or pattern matching.
value="field value"
The custom field content you want to check for a match.


Example 1: Display contents of custom fields

<txp:if_custom_field name="subtitle">
    <txp:custom_field name="subtitle" />

Checks if a custom field has any content (at all) and display it.

Why might you do it? Say, you are publishing book reviews on your site and you use custom fields to enter the author, title, publisher and year of publication. Some of the books have a subtitle, others don’t, so the conditional checks if the custom field you named subtitle holds any content and if it does, it will be displayed. If it’s empty, the field won’t turn up on the page.

The whole set of custom fields could look like this:

    <txp:custom_field name="author" />:
    <txp:custom_field name="title" />
<txp:if_custom_field name="subtitle">
        <txp:custom_field name="subtitle" />
    Published by
    <txp:custom_field name="publisher" />
    <txp:custom_field name="year" />

For a *book that has a subtitle, this may be seen:

<h4>Stephen Covey: The Seven Habits of Highly Effective People</h4>
<p>Powerful lessons in personal change</p>
<p>Published by Simon &amp; Schuster in 2002.</p>

For a *book without a subtitle, this might be shown:

<h4>J.R.R. Tolkien: The Lord of the Rings</h4>
<p>Published by HarperCollins in 2004.</p>

Other tags used: custom_field.

Example 2: Check custom field value

A mood indicator:

<txp:if_custom_field name="mood" value="happy">
    <img src="happy-face.png" alt="Happy">

<txp:if_custom_field name="mood" value="sad">
    <img src="sad-face.png" alt="Sad">

Checks the content of the custom field named mood to see if it matches the text happy or sad. Depending which one it matches determines which of the emoticon images is displayed.

Why might you do it? If you define a custom field mood, you can enter a word to indicate your mood while writing an article. You enter either happy or sad.

Example 3: Use the tag with else

<txp:if_custom_field name="website">
        <txp:custom_field name="website" />
<txp:else />
    <p>Unfortunately, this band hasn't got a website.</p>

If the custom field named ‘website’ has some content, display it, otherwise display a standard message.

Why might you do it? If you publish music reviews and you’ve set up some custom fields for the band name, the album title and the band’s website. But not all bands have a website and you want to display a standard message if a band hasn’t got one.

Other tags used: custom_field, else.

Example 4: Display a conditional statement based on a comma separated value

<txp:if_custom_field name="animals" separator="," match="any" value="monkeys">
    <p>The monkeys are eating bananas.</p>
<txp:else />
    <p>The bears ate all the monkeys. How sad.</p>

Checks the content of the custom field named animals which has a comma separated list of animals. It checks if it contains the text monkeys, and displays a conditional statement if it does.

Other tags used: else.

Example 5: Use as a single tag to increment a counter

   <txp:variable name="counter" add='<txp:if_custom_field name="Type" value="info" />' />

When placed within an article context, it increments the counter variable if the custom field named Type contains the value info. If it does, the <txp:if_custom_field /> tag returns 1 which is then added to the current value of the counter.

Other tags used: variable, if_individual_article.


Version 4.7.0

May be used as a single tag.

Version 4.3.0

val attribute deprecated and renamed to value.
match and separator attributes added.

If you notice any kind of problem with this page's construction or content (outdated information, typos, broken links, or whatever), open an issue to have it sorted. Or have a go at it yourself. :)