Skip to content

Latest commit

 

History

History
158 lines (108 loc) · 9.89 KB

README.md

File metadata and controls

158 lines (108 loc) · 9.89 KB

Simple Podcasting for WordPress

Simple Podcasting

Support Level Required PHP Version Required WP Version WordPress tested up to version GPLv2 License Dependency Review E2E Test Unit Tests PHPCS PHP Compatibility CodeQL WordPress Playground Demo

Easily set up multiple podcast feeds using built-in WordPress posts. Includes a podcast block and podcast transcript block for the WordPress block editor (aka Gutenberg).

Overview

Podcasting is a method to distribute audio messages through a feed to which listeners can subscribe. You can publish podcasts on your WordPress site and make them available for listeners in Apple Podcasts and through direct feed links for other podcasting apps by following these steps:

Screenshot of podcast block

Requirements

  • PHP 7.4+
  • WordPress 6.5+
  • RSS feeds must not be disabled

Installation

  1. Install the plugin via the plugin installer, either by searching for it or uploading a .zip file.
  2. Activate the plugin.
  3. Head to Posts → Podcasts and add at least one podcast.
  4. Create a post and insert an audio embed (or a podcast block in the new WordPress editor) and select a Podcast feed to include it in.

Create your podcast

From the WordPress Admin, go to Podcasts. To create a podcast, complete all of the "Add New Podcast" fields and click "Add New Podcast".

  • Name: this title appears in Apple Podcasts and any other podcast apps.
  • Slug: this is the URL-friendly version of the Name field.
  • Subtitle: the subtitle also appears in Apple Podcasts and any other podcast apps.
  • Artist / Author name: the artist or producer of the work.
  • Podcast email: a contact email address for your podcast.
  • Summary: Apple Podcasts displays this summary when browsing through podcasts.
  • Copyright / License information: copyright information viewable in Apple Podcasts or other podcast apps.
  • Mark as explicit: mark Yes if podcast contains adult language or adult themes.
  • Language: the main language spoken in the podcast.
  • Cover image: add the URL for the cover art to appear in Apple Podcasts and other podcast apps. Click "Select Image" and choose an image from the Media Library. Note that podcast cover images must be between 1400 x 1400 and 3000 x 3000 pixels in JPG or PNG formats to work on Apple Podcasts.
  • Keywords: add terms to help your podcast show up in search results on Apple Podcasts and other podcast apps.
  • Categories: these allow your podcast to show up for those browsing Apple Podcasts or other podcast apps by category.

Repeat for each podcast you would like to create.

Add content to your podcast

  • Create a new post and assign it to one or more Podcasts using the panel labeled Podcasts.
  • Upload or embed an audio file into this post using any of the usual WordPress methods. If using the new block-based WordPress editor (sometimes referred to as Gutenberg), insert a Podcast block. Only one Podcast block can be inserted per post.
  • For more advanced settings, use the Podcasting meta box to mark explicit content or closed captioning available, season number, episode number, episode type, add a transcript and to optionally specify one media item in the post if you have more than one in your post. In the block-based editor, these are the block settings that appear in the sidebar when the podcast block is selected.
  • Transcript: If desired, an optional transcript can be added from the settings of the Podcast block. This will add a Podcast Transcript block, allowing you to add a transcript consisting of time codes, citations, and paragrah text that can be embedded in the post, linked to an external plain HTML file, or linked in a special <podcast:transcript> XML element.

Submit your podcast feed to Apple Podcasts

Podcast setup Podcast in editor Podcast feed
Podcast setup Podcast in editor Podcast feed

Submit your podcast feed to Pocket Casts

How do I get my podcast featured on Pocket Casts?

The Featured section of Pocket Casts is human-curated. To ensure that all podcasts have an equal opportunity at being featured, selections are made on the basis of merit.

If you’d like to suggest your podcast for a featured spot, reach out to [email protected].

For more information, read more.

How do I submit private and paid podcast feeds?

Follow this documentation to submit private and paid podcast feeds

Control how many episodes are listed on the feed

If you want to adjust the default number of episodes included in a podcast RSS feed, then utilize the following to do so...

<?php

add_filter( 'simple_podcasting_episodes_per_page', 'podcasting_feed_episodes_per_page' );

/**
 * Filter how many items are displayed on the feed
 * Default is 250
 *
 * @param int $qty Items count.
 * @return string
 */
function podcasting_feed_episodes_per_page( $qty ) {
	return 300;
}

Customize the RSS feed title

The <title> element of the RSS feed can be adjusted using the simple_podcasting_feed_title filter.

<?php

add_filter( 'simple_podcasting_feed_title', 'podcasting_feed_update_feed_title', 10, 2 );

/**
 * Filter the name of the of the feed channel
 *
 * @param $output Output to be modified.
 * @param $term WP_Term object representing the podcast
 * @return string
 */
function podcasting_feed_update_feed_title( $output, $term ) {
	$term_name = $term->name;

	return '10up Presents: ' . $term_name;
}

Customize RSS feed

If you want to modify RSS feed items output, there is a filter for that:

<?php

function podcasting_feed_item_filter( $feed_item = array(), $post_id = null, $term_id = null ) {
	if ( 42 === $post_id ) {
		$feed_item['keywords'] = 'one,two,three';
	}
	return $feed_item;
}
add_filter( 'simple_podcasting_feed_item', 'podcasting_feed_item_filter', 10, 3 );

Support Level

Stable: 10up is not planning to develop any new features for this, but will still respond to bug reports and security concerns. We welcome PRs, but any that include new features should be small and easy to integrate and should not include breaking changes. We otherwise intend to keep this tested up to the most recent version of WordPress.

Changelog

A complete listing of all notable changes to Simple Podcasting for WordPress are documented in CHANGELOG.md.

Contributing

Please read CODE_OF_CONDUCT.md for details on our code of conduct, CONTRIBUTING.md for details on the process for submitting pull requests to us, and CREDITS.md for a listing of maintainers of, contributors to, and libraries used by Simple Podcasting for WordPress.

Like what you see?