post_type_archive_title

Filters the post type archive title.

Description

apply_filters( 'post_type_archive_title', (string) $object_labels_name, (string) $object_name ); 

Parameters (2)

0. $object_labels_name (string)

The object labels name.

1. $object_name (string)

The object name.

Usage

To run the hook, copy the example below.

$object_labels_name = apply_filters( 'post_type_archive_title', $object_labels_name, $object_name ); 
                         
if ( !empty( $object_labels_name ) ) { 
                         
   // everything has led up to this point... 
                         
} 
  

The following example is for adding a hook callback.

// define the post_type_archive_title callback 
function filter_post_type_archive_title( $object_labels_name, $object_name ) { 
    // make filter magic happen here... 
    return $object_labels_name; 
}; 
         
// add the filter 
add_filter( 'post_type_archive_title', 'filter_post_type_archive_title', 10, 2 ); 

To remove a hook callback, use the example below.

// remove the filter 
remove_filter( 'post_type_archive_title', 'filter_post_type_archive_title', 10, 2 );