Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/helgatheviking/kia-subtitle

Add a subtitle meta field
https://github.com/helgatheviking/kia-subtitle

hacktoberfest meta subtitle wordpress

Last synced: about 5 hours ago
JSON representation

Add a subtitle meta field

Awesome Lists containing this project

README 

        
# KIA Subtitle #



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



This is a developmental repo. Clone this repo and run `npm install && npm run release`   

OR    

|[Download latest release](https://github.com/helgatheviking/KIA-Subtitle/releases/latest)|



## Description ##



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.



## Installation ##



1. Upload the `plugin` folder to the `/wp-content/plugins/` directory

1. Activate the plugin through the 'Plugins' menu in WordPress

1. *For Block Themes:* Add the subtitle block to your template in the Site Editor

1. *For Classic Themes:* Add the 'the_subtitle()' tag to your theme



## 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



1. Click Edit Site in the WordPress toolbar

1. Select the template you wish to edit, commonly this might be called Single Post, or Singular.

1. 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( '
', '
' );`



### `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](https://github.com/helgatheviking/kia-subtitle-woocommerce-bridge) 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](https://wordpress.org/support/topic/compatibility-with-latest-wp-and-wc/#post-15456180).



### 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](http://wordpress.org/support/plugin/kia-subtitle). 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](https://github.com/helgatheviking/KIA-Subtitle/issues)



## Screenshots ##



1. This is what the input will look like in the Block Editor.

1. Insert a subtitle block into your block theme's template, such as the Singular template for displaying Posts.

1. This is what the input will look like in the Classic Editor.



## Frequently Asked Questions ##



### 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( '
', '
' );



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 = '
' . wp_kses_post( $subtitle ) . '
' . $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 .= ' — ' . 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:



	



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](https://gist.github.com/helgatheviking/6754a8a381ace9aef325ca3f7b4128c1)



### 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](https://github.com/helgatheviking/kia-subtitle-woocommerce-bridge) 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!