April 24, 2024

KIA Subtitle Plugin

The KIA Subtitle plugin allows you to add a subtitle to your posts.

KIA subtitle allows you to add a subtitle to your posts and retrieve it in the loop in the same manner as the post title. By using the Subtitle block or the the_subtitle() or get_the_subtitle() template tags.

It adds an input field right under the title field of posts, pages and any custom post type. It also add a subtitle column to the edit screen as well as to the quick edit.

You can also use the Subtitle block or the shortcode [the-subtitle] to display it within the post content.

Site Editor

The plugin provides a Subtitle block in the editor. In the post editor, this doesn’t make a lot of sense, but mimics the core Title block. The ideal use case for the Subtitle block is when editing your theme

Click Edit Site in the WordPress toolbar
Select the template you wish to edit, commonly this might be called Single Post, or Singular.
Insert the Subtitle block where needed, commonly right after the Title block.

Template Tags

This plugin does not attempt to output the subtitle. With an infinite number of themes, it is not possible for us to support that. The onus is on the user to customize their theme accordingly. The plugin provides two template tags that can be used to customize your theme as desired.

`the_subtitle( string $before

”, string $after = ”, bool $display = true ): void|string` =

Displays or retrieves the current post subtitle with optional markup.

Parameters

$before `string` `optional` Markup to prepend to the title. Default: `''` $after `string` `optional` Markup to append to the title. Default: `''` $display `bool` `optional` Whether to echo or return the title. Default true for echo. Default: `true`

Example usage:

if ( function_exists( 'the_subtitle' ) ) the_subtitle( '<h2 class="subtitle">', '</h2>' );

`get_the_subtitle( int|WP_Post $post ): string`

Retrieves the post subtitle.

Parameters

$post `int|WP_Post` `optional` Post ID or WP_Post object. Default: global `$post` object.

WooCommerce support

There is a small bridge plugin you can install and activate to automatically display the subtitle in most WooCommerce locations. This will work for all themes that are using WooCommerce’s default hooks.

NB: It’s known that the Ocean WP theme has it’s own hooks in the WooCommerce templates. You will need to alter the bridge plugin… please take a look at this support thread.

WPML Ready

KIA Subtitle has been tested by WPML and will allow you to translate the subtitle on multilingual sites.

Support

Support is handled in the WordPress forums. Please note that support is limited and does not cover any custom implementation of the plugin.

Please report any bugs, errors, warnings, code problems to Github

Installation

Upload the plugin folder to the /wp-content/plugins/ directory
Activate the plugin through the ‘Plugins’ menu in WordPress
For Block Themes: Add the subtitle block to your template in the Site Editor
For Classic Themes: Add the ‘the_subtitle()’ tag to your theme

Screenshots

This is what the input will look like in the Block Editor.
Insert a subtitle block into your block theme's template, such as the Singular template for displaying Posts.
This is what the input will look like in the Classic Editor.

FAQ

How do I display the subtitle in my theme?

The intended way is with the the_subtitle() template tag as follows:

if ( function_exists( 'the_subtitle' ) ) the_subtitle();

You can wrap the string in some markup using the $before and $after parameters.

if ( function_exists( 'the_subtitle' ) ) the_subtitle( '<h2 class="subtitle">', '</h2>' );

As an absolute worst case fallback you could also add the following snippet to your functions.php in order to prepend the subtitle to the content.

/** * Prepend the subtitle to the post content. * * @param string $content The post content * @return string */ function kia_prepend_subtitle_to_content( $content ) { if ( ! is_admin() ) { $subtitle = function_exists( 'get_the_subtitle' ) ? get_the_subtitle() : ''; if ( ! empty( $subtitle ) ) { $content = '<h2 class="subtitle">' . wp_kses_post( $subtitle ) . '</h2>' . $content; } } return $content; } add_filter( 'the_content', 'kia_prepend_subtitle_to_content' );

You could also filter the_title and but it would have to be part of the post title’s markup and could not have it’s own markup as nesting header elements is invalid HTML markup.

/** * Append the subtitle to the title. * * @param string $title The post title * @return string */ function kia_append_subtitle_to_title( $title ) { if ( ! is_admin() ) { $subtitle = function_exists( 'get_the_subtitle' ) ? get_the_subtitle() : ''; if ( ! empty( $subtitle ) ) { $title .= ' &mdash; ' . wp_kses_post( $subtitle ); } } return $title; } add_filter( 'the_title', 'kia_append_subtitle_to_title' );

Where do I add this code?

Unfortunately, I cannot tell you exactly what file to place the above code in because 1. I don’t know where you want to display the subtitle and 2. every theme’s structure is different.

However, in general, the_subtitle() is a template tag so you will want to put it in a template file. Probably, you are looking for the file that contains your post loop. For most themes it’s single.php ( or page.php for pages ), but for many it could also be content.php. Assuming you want the subtitle to display directly after your main title, you’d place the above code after:

<h1 class="entry-title"><?php the_title(); ?></h1>

As an example if you wanted to display the subtitle on standard single posts, in the Twenty Twenty theme you’d create a copy of the entry-header.php template in your child theme and modify it as shown in this gist

How do I style the subtitle?

If you have wrapped the subtitle in an H2 tag with the class of subtitle like in the gist above, you can then style it any way you’d like.

.subtitle { color: pink; }

Can I display the subtitle for my WooCommmerce products

Yes! You can use this bridge plugin to automatically display the subtitle in most WooCommerce locations.

Can I add the subtitle to the Page Title Meta tag

function kia_add_subtitle_to_wp_title( $title ) {
if ( is_single() && function_exists( ‘get_the_subtitle’ ) ) && $subtitle == get_the_subtitle( get_the_ID() ) ) {
$title .= $subtitle;
}
}
add_filter( ‘wp_title’, ‘kia_add_subtitle_to_wp_title’ );

Is this translation ready?

WPML now supports KIA Subtitle!

Changelog

4.0.1

Fix: Fix script errors when using site editor, by preventing the sidebar panel from rendering if NOT editing a post.

4.0.0

Important: Requires WordPress 6.1
New: Subtitle block
New: Introduce kia_subtitle_sanitize_subtitle for adding your own custom sanitization rules.

3.0.3

Fix: Check subtitle is set before updating.

3.0.2

Fix: Do not load Gutenberg assets if CPT does not support ‘custom-fields’. Replace with fallback metabox.

3.0.1

Fix: Remove the duplicate metabox for post types using Classic Editor.

3.0.0

Add subtitle as a panel in the Gutenberg editor

2.0.0

Add subtitle as a metabox that is compatible with Gutenberg editor

1.6.8

Add width to column for WooCommerce products

1.6.7

Update donation link
Update required and tested against versions
Fix column location for WooCommerce products
Minify admin script

1.6.6

Insert subtitle after title, or at end if subtitle does not exist

1.6.5

Add wpml-config.xml for compatibility with WPML

1.6.4

Add link to plugin settings
testing against WP4.4

1.6.3

fix docblock

1.6.2

save subtitles on attachments. Apparently attachments don’t fire save_post hook

1.6.1

resolve PHP warnings in strict-standards mode

1.6

switch to KIA_Subtitle() instance versus global variable

1.5.4

restored accidentally deleted script for quick edit

1.5.4

remove unneeded script code now that input is using ‘placeholder’
remove tabindex on input (wasn’t doing anything anyway)
add script to tab from title to subtitle, to content. props @Giuseppe Mazzapica
add readme.md

1.5.3

verify WP3.8 compatibility
remove backcompat on edit_form_after_title hook
better docbloc

1.5.2

Move changelog back to readme.txt #facepalm

1.5.1

Switch sanitization to less restrictive sanitize_post_field, which matches how the main post title is sanitized by WordPress
Move changelog to separate file

1.5

Switch options to “check to enable” instead of “check to disable” (all post types are enabled by default)
Include upgrade routine to switch any old options to new format
Update FAQ with example for Twenty Twelve

1.4.3

Adjust $args for get_post_types()
Fix buggy conditional logic for users with no post types excluded

1.4.2

Adjust $args for get_post_types()
switch ‘kia_subtitle_post_types’ filter to ‘kia_subtitle_post_type_args’

1.4.1

Adjust $args for get_post_types()
add ‘kia_subtitle_post_types’ filter to plugin’s options

1.4

Add ability to exclude subtitle from certain post types

1.3.4

Add filter the_subtitle to allow subtitle content to be modified

1.3.3

Fix Notice: Undefined property
Clean up enqueue scripts

1.3.2

Fix for back-compatibility

1.3.1

Add example code to FAQ

1.3

Better escaping of HTML attributes thanks to @nealpoole
Take advantage of new action hook in WP 3.5

1.2

Mimic the_title(), so the_subtitle() now accepts before, after and echo parameters:
the_subtitle( $before = ”, $after = ”, $echo = true )

1.1.2

Fixed quick edit refresh ( second click on quick edit for same item and the value still reflected the original )

1.1.1

Fix ability to remove subtitle

1.1

Add column to edit.php screen
Add subtitle to quick edit
Load script on edit.php screen again

1.0.2

update donate link

1.0.1

Don’t load script on edit.php screen

1.0

Initial release.

KIA Subtitle Plugin

Site Editor

Template Tags

`the_subtitle( string $before

`get_the_subtitle( int|WP_Post $post ): string`

WooCommerce support

WPML Ready

Support

Installation

Screenshots

FAQ

Changelog

4.0.1

4.0.0

3.0.3

3.0.2

3.0.1

3.0.0

2.0.0

1.6.8

1.6.7

1.6.6

1.6.5

1.6.4

1.6.3

1.6.2

1.6.1

1.6

1.5.4

1.5.4

1.5.3

1.5.2

1.5.1

1.5

1.4.3

1.4.2

1.4.1

1.4

1.3.4

1.3.3

1.3.2

1.3.1

1.3

1.2

1.1.2

1.1.1

1.1

1.0.2

1.0.1

1.0

Details

Ratings

Tags