WordPress.org

Ready to get started?Download WordPress

Codex

Attention Interested in functions, hooks, classes, or methods? Check out the new WordPress Code Reference!

Plugin API/Filter Reference/the title

Contents

Description

the_title is a filter applied to the post title retrieved from the database, prior to printing on the screen. In some cases (such as when the_title is used), the title can be suppressed by returning a false value (e.g. NULL, FALSE or the empty string) from the filter function.

Parameters

$title
(string) (required) The post title
Default: None
$id
(int) (required) The post ID
Default: None

Examples

Suppressing the title in templates for all posts in the "blurb" category:

function suppress_if_blurb( $title, $id = null ) {

    if ( in_category(' blurb', $id ) ) {
        return '';
    }

    return $title;
}
add_filter( 'the_title', 'suppress_if_blurb', 10, 2 );

Note the addition of null as the default value for the $id variable. This is because some instances of the usage of this filter did not supply a post ID. This inconsistency was introduced in version 3.1, and fixed in version 3.3 (see ticket #16688). If you want to be compatible with these older versions, you need to supply the default value as above, or you will end up with a PHP warning stating that you are missing an argument. If you don't need to support 3.1 or 3.2, it isn't necessary to specify a default value for $id.

Change Log

Source Files

This filter is applied by:

Related


This page is marked as incomplete. You can help Codex by expanding it.