Developer notes for Ultimate Post List Pro

Overview

This page explains developers technical issues about Ultimate Post List Pro. Jump to the sections:

Shortcode attributes
Call by function in PHP code
CSS class names
Compatibility with WPML

Shortcode Attributes

You can add some attributes to overwrite the respective settings of the list.

list_title: Sets the headline of the list. To remove a headline use an empty string.; Example: list_title="Your Site, Your Way"; Example: list_title=""
included_categories: Displays only posts of the categories specified by their IDs, slugs or names, separated by commas.; Example: included_categories="323,245,788"; Example: included_categories="lorem-ipsum,fringilla-mauris,dolor-sit-amet"; Example: included_categories="Lorem ipsum,Fringilla mauris,Dolor sit amet"; You can use specifiers of different types in a comma-separated list.; Example: included_categories="Lorem ipsum,245,dolor-sit-amet"
excluded_categories: Blocks out posts of the given categories specified by their IDs, slugs or names, separated by commas.; Example: excluded_categories="dolor-sit-amet,389"
included_tags: Displays only posts assigned with the given tags specified by their IDs, slugs or names, separated by commas.; Example: included_tags="News,156"
excluded_tags: Blocks out posts assigned with the given tags specified by their IDs, slugs or names, separated by commas.; Example: excluded_tags="News,156"

Example of a shortcode with attributes

This shortcode prints the list of ID 48, shows only posts of the specified category with a new headline.

[ultimate-post-list-pro id="48" list_title="Your Site, Your Way" included_categories="News"]

How to use the shortcode

Copy the shortcode in the Shortcode box and insert it at the desired place in the content.

You can find the shortcode both in the table list of all post lists and in the Shortcode column and in the Shortcode box on the edit page of each list in the Shortcode box.

Call by function in PHP code

You can call an Ultimate Post List directly in PHP code with the function

uplp_print_list( $args )

The arguments are defined in an array of key-value-pairs of the same arguments as described in the Shortcode Attributes section.

Example of calling Ultimate Post List in PHP

The following line displays an Ultimate Post List with the ID of 233 and excludes posts which are tagged with ‘News’ and the tag of ID 43:

<?php uplp_print_list(
    array(
        'id' => 233,
        'excluded_tags' => 'News, 43'
    )
); ?>

You can also write the code in another way for better legibility:

<?php

$args = array(

    'id' => 233,

    'excluded_tags' => 'News, 43',

);

uplp_print_list( $args );

?>

CSS class names for fine-tuning the design of post lists

If you want to style parts of a post list there are many helpers for you to achieve that. Every HTML code of a list generated by Ultimate Post List Pro provides you a wide range of class names for CSS statements. The following list specify them all.

Class name of every post list

You can catch every post list of Ultimate Post List Pro with one single CSS selector:

.uplp-list

ID of a post list

To catch a single post list you can use the name of the list’s ID. The selector name is kind of the pattern:

#uplp-list-{list id}

Replace the part ‘{list id}’ with the ID of the post list. You get the ID in the shortcode of the list at the parameter ‘id’.

Class name of post thumbnails

To catch all thumbnails in a post list use this selector:

.uplp-post-thumbnail

Class name of post titles

To catch all post titles in a post list use this selector:

.uplp-post-title

Class name of post dates

To catch all post dates in a post list use this selector:

.uplp-post-date

Class name of post authors

To catch all post author names in a post list use this selector:

.uplp-post-author

Class name of post excerpts

To catch all post excerpts in a post list use this selector:

.uplp-post-excerpt

Class name of numbers of comments

To catch all numbers of comments in a post list use this selector:

.uplp-post-comment_count

Class names of post types

To catch all post type names in a post list use this selector:

.uplp-post-type

To catch only the desired post type name you can use the slug of the post type. The CSS selector is like this:

.uplp-{post type slug}

Replace the part ‘{post type slug}’ with the slug of the post type. For the WordPress standard post types posts and pages there are the slugs ‘post’ and ‘page’. Every custom post type is supported and can be addressed by its slug in the selector.

Class name of the ‘Read more’ link

To catch all ‘Read more’ links in a post list use this selector:

.uplp-post-read_more

Class names of post formats

To catch all post format names in a post list use this selector:

.uplp-post-format

To catch only the desired post format name you can use the slug of the post format. The CSS selector is like this:

.uplp-{post format slug}

Replace the part ‘{post format slug}’ with the slug of the post format. Please look at the HTML source code to find out the class name.

Class names of post categories

To catch all post category names in a post list use this selector:

.uplp-post-categories

In some very rare cases WordPress can not retrieve the post categories and returns an error. To catch those informations use this selector:

.uplp-error-categories

In some cases – especially in the case of a custom post type – there are no categories assigned with the post. To catch those informations use this selector:

.uplp-no-categories

To catch only the desired category name of a post you can use the slug of the post categories. The CSS selector is like this:

.uplp-{post categories slug}

Replace the part ‘{post categories slug}’ with the slugs of all assigned post categories, concatenated with ‘-‘. Please look at the HTML source code to find out the class name.

Class names of post tags

To catch all post tag names in a post list use this selector:

.uplp-post-tags

In some very rare cases WordPress can not retrieve the post tags and returns an error. To catch those informations use this selector:

.uplp-error-tags

If there are no tags assigned with the post you can catch those informations with this selector:

.uplp-no-tags

To catch only the desired tag name of a post you can use the slug of the post tags. The CSS selector is like this:

.uplp-{post tags slug}

Replace the part ‘{post tags slug}’ with the slug of all assigned post tags, concatenated with ‘-‘. Please look at the HTML source code to find out the class name.

Class names of custom post taxonomies

To catch all custom taxonomy names in a post list use this selector:

.uplp-post-custom-tax

To catch only the desired custom taxonomy name of a post use this selector:

.uplp-{custom taxonomy slug}

Replace the part ‘{post taxonomy slug}’ with the slug of the assigned custom taxonomy. Please look at the HTML source code to find out the class name.

To catch the value of a custom taxonomy use this selector:

.uplp-{custom value slug}

Replace the part ‘{custom value slug}’ with the slug of the assigned value. Please look at the HTML source code to find out the value slug.

Class names of custom terms

In some very rare cases WordPress can not retrieve the post terms and returns an error. To catch those informations use this selector:

.uplp-error-terms

If there are no terms assigned with the post you can catch those informations with this selector:

.uplp-no-terms

To catch only the desired custom term name assigned with a post use this selector:

.uplp-{custom terms slug}

Replace the part ‘{custom terms slug}’ with the slug of all assigned post terms, concatenated with ‘-‘. Please look at the HTML source code to find out the class name.

Class names of custom fields

To catch all custom field names in a post list use this selector:

.uplp-post-custom-field

To catch only the desired custom field name of a post use this selector:

.uplp-{custom taxonomy slug}

Replace the part ‘{custom taxonomy slug}’ with the slug of the assigned custom

taxonomy. Please look at the HTML source code to find out the class name.

To catch the value of a custom field use this selector: