Merge pull request #250 from toolstack/switch-to-shortcodes

Switch to shortcodes

activitypub.php

@@ -19,10 +19,11 @@ namespace Activitypub;
  * Initialize plugin
  */
 function init() {
+	\defined( 'ACTIVITYPUB_EXCERPT_LENGTH' ) || \define( 'ACTIVITYPUB_EXCERPT_LENGTH', 400 );
 	\defined( 'ACTIVITYPUB_MAX_IMAGE_ATTACHMENTS' ) || \define( 'ACTIVITYPUB_MAX_IMAGE_ATTACHMENTS', 3 );
 	\defined( 'ACTIVITYPUB_HASHTAGS_REGEXP' ) || \define( 'ACTIVITYPUB_HASHTAGS_REGEXP', '(?:(?<=\s)|(?<=<p>)|(?<=<br>)|^)#([A-Za-z0-9_]+)(?:(?=\s|[[:punct:]]|$))' );
 	\defined( 'ACTIVITYPUB_ALLOWED_HTML' ) || \define( 'ACTIVITYPUB_ALLOWED_HTML', '<strong><a><p><ul><ol><li><code><blockquote><pre><img>' );
-	\defined( 'ACTIVITYPUB_CUSTOM_POST_CONTENT' ) || \define( 'ACTIVITYPUB_CUSTOM_POST_CONTENT', "<p><strong>%title%</strong></p>\n\n%content%\n\n<p>%hashtags%</p>\n\n<p>%shortlink%</p>" );
+	\defined( 'ACTIVITYPUB_CUSTOM_POST_CONTENT' ) || \define( 'ACTIVITYPUB_CUSTOM_POST_CONTENT', "<p><strong>[ap_title]</strong></p>\n\n[ap_content]\n\n<p>[ap_hashtags]</p>\n\n<p>[ap_shortlink]</p>" );
 	\define( 'ACTIVITYPUB_PLUGIN_DIR', plugin_dir_path( __FILE__ ) );
 	\define( 'ACTIVITYPUB_PLUGIN_BASENAME', plugin_basename( __FILE__ ) );
 	\define( 'ACTIVITYPUB_PLUGIN_FILE', plugin_dir_path( __FILE__ ) . '/' . basename( __FILE__ ) );
@@ -70,6 +71,9 @@ function init() {
 	require_once \dirname( __FILE__ ) . '/includes/class-hashtag.php';
 	\Activitypub\Hashtag::init();
 
+	require_once \dirname( __FILE__ ) . '/includes/class-shortcodes.php';
+	\Activitypub\Shortcodes::init();
+
 	require_once \dirname( __FILE__ ) . '/includes/class-debug.php';
 	\Activitypub\Debug::init();
 

includes/class-admin.php

@@ -50,6 +50,8 @@ class Admin {
 
 		switch ( $tab ) {
 			case 'settings':
+				\Activitypub\Model\Post::upgrade_post_content_template();
+
 				\load_template( \dirname( __FILE__ ) . '/../templates/settings.php' );
 				break;
 			case 'welcome':

includes/class-shortcodes.php

@@ -0,0 +1,510 @@
+<?php
+namespace Activitypub;
+
+class Shortcodes {
+	/**
+	 * Class constructor, registering WordPress then shortcodes
+	 *
+	 * @param WP_Post  $post    A WordPress Post Object
+	 */
+	public static function init() {
+		foreach ( get_class_methods( 'Activitypub\Shortcodes' ) as $shortcode ) {
+			if ( 'init' !== $shortcode ) {
+				add_shortcode( 'ap_' . $shortcode, array( 'Activitypub\Shortcodes', $shortcode ) );
+			}
+		}
+	}
+
+	/**
+	 * Generates output for the ap_hashtags shortcode
+	 *
+	 * @param array  $atts      shortcode attributes
+	 * @param string $content   shortcode content
+	 * @param string $tag       shortcode tag name
+	 *
+	 * @return string
+	 */
+	public static function hashtags( $atts, $content, $tag ) {
+		$post_id = get_the_ID();
+
+		if ( ! $post_id ) {
+			return '';
+		}
+
+		$tags = \get_the_tags( $post_id );
+
+		if ( ! $tags ) {
+			return '';
+		}
+
+		$hash_tags = array();
+
+		foreach ( $tags as $tag ) {
+			$hash_tags[] = \sprintf(
+				'<a rel="tag" class="u-tag u-category" href="%s">#%s</a>',
+				\get_tag_link( $tag ),
+				$tag->slug
+			);
+		}
+
+		return \implode( ' ', $hash_tags );
+	}
+
+	/**
+	 * Generates output for the ap_title shortcode
+	 *
+	 * @param array  $atts      shortcode attributes
+	 * @param string $content   shortcode content
+	 * @param string $tag       shortcode tag name
+	 *
+	 * @return string
+	 */
+	public static function title( $atts, $content, $tag ) {
+		$post_id = get_the_ID();
+
+		if ( ! $post_id ) {
+			return '';
+		}
+
+		return \get_the_title( $post_id );
+
+	}
+
+	/**
+	 * Generates output for the ap_excerpt shortcode
+	 *
+	 * @param array  $atts      shortcode attributes
+	 * @param string $content   shortcode content
+	 * @param string $tag       shortcode tag name
+	 *
+	 * @return string
+	 */
+	public static function excerpt( $atts, $content, $tag ) {
+		$post = get_post();
+
+		if ( ! $post ) {
+			return '';
+		}
+
+		$atts = shortcode_atts(
+			array( 'length' => ACTIVITYPUB_EXCERPT_LENGTH ),
+			$atts,
+			$tag
+		);
+
+		$excerpt_length = intval( $atts['length'] );
+
+		if ( 0 === $excerpt_length ) {
+			$excerpt_length = ACTIVITYPUB_EXCERPT_LENGTH;
+		}
+
+		$excerpt = \get_post_field( 'post_excerpt', $post );
+
+		if ( '' === $excerpt ) {
+
+			$content = \get_post_field( 'post_content', $post );
+
+			// An empty string will make wp_trim_excerpt do stuff we do not want.
+			if ( '' !== $content ) {
+
+				$excerpt = \strip_shortcodes( $content );
+
+				/** This filter is documented in wp-includes/post-template.php */
+				$excerpt = \apply_filters( 'the_content', $excerpt );
+				$excerpt = \str_replace( ']]>', ']]>', $excerpt );
+
+			}
+		}
+
+		// Strip out any remaining tags.
+		$excerpt = \wp_strip_all_tags( $excerpt );
+
+		/** This filter is documented in wp-includes/formatting.php */
+		$excerpt_more = \apply_filters( 'excerpt_more', ' [...]' );
+		$excerpt_more_len = strlen( $excerpt_more );
+
+		// We now have a excerpt, but we need to check it's length, it may be longer than we want for two reasons:
+		//
+		//   * The user has entered a manual excerpt which is longer that what we want.
+		//   * No manual excerpt exists so we've used the content which might be longer than we want.
+		//
+		// Either way, let's trim it up if we need too.  Also, don't forget to take into account the more indicator
+		// as part of the total length.
+		//
+
+		// Setup a variable to hold the current excerpts length.
+		$current_excerpt_length = strlen( $excerpt );
+
+		// Setup a variable to keep track of our target length.
+		$target_excerpt_length = $excerpt_length - $excerpt_more_len;
+
+		// Setup a variable to keep track of the current max length.
+		$current_excerpt_max = $target_excerpt_length;
+
+		// This is a loop since we can't calculate word break the string after 'the_excpert' filter has run (we would break
+		// all kinds of html tags), so we have to cut the excerpt down a bit at a time until we hit our target length.
+		while ( $current_excerpt_length > $target_excerpt_length && $current_excerpt_max > 0 ) {
+			// Trim the excerpt based on wordwrap() positioning.
+			// Note: we're using <br> as the linebreak just in case there are any newlines existing in the excerpt from the user.
+			//       There won't be any <br> left after we've run wp_strip_all_tags() in the code above, so they're
+			//       safe to use here.  It won't be included in the final excerpt as the substr() will trim it off.
+			$excerpt = substr( $excerpt, 0, strpos( wordwrap( $excerpt, $current_excerpt_max, '<br>' ), '<br>' ) );
+
+			// If something went wrong, or we're in a language that wordwrap() doesn't understand,
+			// just chop it off and don't worry about breaking in the middle of a word.
+			if ( strlen( $excerpt ) > $excerpt_length - $excerpt_more_len ) {
+				$excerpt = substr( $excerpt, 0, $current_excerpt_max );
+			}
+
+			// Add in the more indicator.
+			$excerpt = $excerpt . $excerpt_more;
+
+			// Run it through the excerpt filter which will add some html tags back in.
+			$excerpt_filtered = apply_filters( 'the_excerpt', $excerpt );
+
+			// Now set the current excerpt length to this new filtered length.
+			$current_excerpt_length = strlen( $excerpt_filtered );
+
+			// Check to see if we're over the target length.
+			if ( $current_excerpt_length > $target_excerpt_length ) {
+				// If so, remove 20 characters from the current max and run the loop again.
+				$current_excerpt_max = $current_excerpt_max - 20;
+			}
+		}
+
+		return \apply_filters( 'the_excerpt', $excerpt );
+	}
+
+	/**
+	 * Generates output for the ap_content shortcode
+	 *
+	 * @param array  $atts      shortcode attributes
+	 * @param string $content   shortcode content
+	 * @param string $tag       shortcode tag name
+	 *
+	 * @return string
+	 */
+	public static function content( $atts, $content, $tag ) {
+		$post = get_post();
+
+		if ( ! $post ) {
+			return '';
+		}
+
+		$content = \get_post_field( 'post_content', $post );
+
+		return \apply_filters( 'the_content', $content );
+	}
+
+	/**
+	 * Generates output for the ap_permalink shortcode
+	 *
+	 * @param array  $atts      shortcode attributes
+	 * @param string $content   shortcode content
+	 * @param string $tag       shortcode tag name
+	 *
+	 * @return string
+	 */
+	public static function permalink( $atts, $content, $tag ) {
+		$post = get_post();
+
+		if ( ! $post ) {
+			return '';
+		}
+
+		$atts = shortcode_atts(
+			array(
+				'type' => 'url',
+			),
+			$atts,
+			$tag
+		);
+
+		if ( 'url' === $atts['type'] ) {
+			return \esc_url( \get_permalink( $post->ID ) );
+		}
+
+		return \sprintf( '<a href="%1$s">%1$s</a>', \esc_url( \get_permalink( $post->ID ) ) );
+	}
+
+	/**
+	 * Generates output for the ap_shortlink shortcode
+	 *
+	 * @param array  $atts      shortcode attributes
+	 * @param string $content   shortcode content
+	 * @param string $tag       shortcode tag name
+	 *
+	 * @return string
+	 */
+	public static function shortlink( $atts, $content, $tag ) {
+		$post = get_post();
+
+		if ( ! $post ) {
+			return '';
+		}
+
+		$atts = shortcode_atts(
+			array(
+				'type' => 'url',
+			),
+			$atts,
+			$tag
+		);
+
+		if ( 'url' === $atts['type'] ) {
+			return \esc_url( \wp_get_shortlink( $post->ID ) );
+		}
+
+		return \sprintf( '<a href="%1$s">%1$s</a>', \esc_url( \wp_get_shortlink( $post->ID ) ) );
+	}
+
+	/**
+	 * Generates output for the ap_image shortcode
+	 *
+	 * @param array  $atts      shortcode attributes
+	 * @param string $content   shortcode content
+	 * @param string $tag       shortcode tag name
+	 *
+	 * @return string
+	 */
+	public static function image( $atts, $content, $tag ) {
+		$post_id = get_the_ID();
+
+		if ( ! $post_id ) {
+			return '';
+		}
+
+		$atts = shortcode_atts(
+			array(
+				'type' => 'full',
+			),
+			$atts,
+			$tag
+		);
+
+		$size = 'full';
+
+		if ( in_array(
+			$atts['type'],
+			array( 'thumbnail', 'medium', 'large', 'full' ),
+			true
+		) ) {
+			$size = $atts['type'];
+		}
+
+		$image = \get_the_post_thumbnail_url( $post_id, $size );
+
+		if ( ! $image ) {
+			return '';
+		}
+
+		return \esc_url( $image );
+	}
+
+	/**
+	 * Generates output for the ap_hashcats shortcode
+	 *
+	 * @param array  $atts      shortcode attributes
+	 * @param string $content   shortcode content
+	 * @param string $tag       shortcode tag name
+	 *
+	 * @return string
+	 */
+	public static function hashcats( $atts, $content, $tag ) {
+		$post_id = get_the_ID();
+
+		if ( ! $post_id ) {
+			return '';
+		}
+
+		$categories = \get_the_category( $post_id );
+
+		if ( ! $categories ) {
+			return '';
+		}
+
+		$hash_tags = array();
+
+		foreach ( $categories as $category ) {
+			$hash_tags[] = \sprintf( '<a rel="tag" class="u-tag u-category" href="%s">#%s</a>', \get_category_link( $category ), $category->slug );
+		}
+
+		return \implode( ' ', $hash_tags );
+	}
+
+	/**
+	 * Generates output for the ap_author shortcode
+	 *
+	 * @param array  $atts      shortcode attributes
+	 * @param string $content   shortcode content
+	 * @param string $tag       shortcode tag name
+	 *
+	 * @return string
+	 */
+	public static function author( $atts, $content, $tag ) {
+		$post = get_post();
+
+		if ( ! $post ) {
+			return '';
+		}
+
+		$name = \get_the_author_meta( 'display_name', $post->post_author );
+
+		if ( ! $name ) {
+			return '';
+		}
+
+		return $name;
+	}
+
+	/**
+	 * Generates output for the ap_authorurl shortcode
+	 *
+	 * @param array  $atts      shortcode attributes
+	 * @param string $content   shortcode content
+	 * @param string $tag       shortcode tag name
+	 *
+	 * @return string
+	 */
+	public static function authorurl( $atts, $content, $tag ) {
+		$post = get_post();
+
+		if ( ! $post ) {
+			return '';
+		}
+
+		$url = \get_the_author_meta( 'user_url', $post->post_author );
+
+		if ( ! $url ) {
+			return '';
+		}
+
+		return \esc_url( $url );
+	}
+
+	/**
+	 * Generates output for the ap_blogurl shortcode
+	 *
+	 * @param array  $atts      shortcode attributes
+	 * @param string $content   shortcode content
+	 * @param string $tag       shortcode tag name
+	 *
+	 * @return string
+	 */
+	public static function blogurl( $atts, $content, $tag ) {
+		return \esc_url( \get_bloginfo( 'url' ) );
+	}
+
+	/**
+	 * Generates output for the ap_blogname shortcode
+	 *
+	 * @param array  $atts      shortcode attributes
+	 * @param string $content   shortcode content
+	 * @param string $tag       shortcode tag name
+	 *
+	 * @return string
+	 */
+	public static function blogname( $atts, $content, $tag ) {
+		return \get_bloginfo( 'name' );
+	}
+
+	/**
+	 * Generates output for the ap_blogdesc shortcode
+	 *
+	 * @param array  $atts      shortcode attributes
+	 * @param string $content   shortcode content
+	 * @param string $tag       shortcode tag name
+	 *
+	 * @return string
+	 */
+	public static function blogdesc( $atts, $content, $tag ) {
+		return \get_bloginfo( 'description' );
+	}
+
+	/**
+	 * Generates output for the ap_date shortcode
+	 *
+	 * @param array  $atts      shortcode attributes
+	 * @param string $content   shortcode content
+	 * @param string $tag       shortcode tag name
+	 *
+	 * @return string
+	 */
+	public static function date( $atts, $content, $tag ) {
+		$post = get_post();
+
+		if ( ! $post ) {
+			return '';
+		}
+
+		$datetime = \get_post_datetime( $post );
+		$dateformat = \get_option( 'date_format' );
+		$timeformat = \get_option( 'time_format' );
+
+		$date = $datetime->format( $dateformat );
+
+		if ( ! $date ) {
+			return '';
+		}
+
+		return $date;
+	}
+
+	/**
+	 * Generates output for the ap_time shortcode
+	 *
+	 * @param array  $atts      shortcode attributes
+	 * @param string $content   shortcode content
+	 * @param string $tag       shortcode tag name
+	 *
+	 * @return string
+	 */
+	public static function time( $atts, $content, $tag ) {
+		$post = get_post();
+
+		if ( ! $post ) {
+			return '';
+		}
+
+		$datetime = \get_post_datetime( $post );
+		$dateformat = \get_option( 'date_format' );
+		$timeformat = \get_option( 'time_format' );
+
+		$date = $datetime->format( $timeformat );
+
+		if ( ! $date ) {
+			return '';
+		}
+
+		return $date;
+	}
+
+	/**
+	 * Generates output for the ap_datetime shortcode
+	 *
+	 * @param array  $atts      shortcode attributes
+	 * @param string $content   shortcode content
+	 * @param string $tag       shortcode tag name
+	 *
+	 * @return string
+	 */
+	public static function datetime( $atts, $content, $tag ) {
+		$post = get_post();
+
+		if ( ! $post ) {
+			return '';
+		}
+
+		$datetime = \get_post_datetime( $post );
+		$dateformat = \get_option( 'date_format' );
+		$timeformat = \get_option( 'time_format' );
+
+		$date = $datetime->format( $dateformat . ' @ ' . $timeformat );
+
+		if ( ! $date ) {
+			return '';
+		}
+
+		return $date;
+	}
+}

includes/help.php

@@ -1,5 +1,51 @@
 <?php
 
+\get_current_screen()->add_help_tab(
+	array(
+		'id'      => 'template-tags',
+		'title'   => \__( 'Template Tags', 'activitypub' ),
+		'content' =>
+			'<p>' . __( 'The following Template Tags are available:', 'activitypub' ) . '</p>' .
+			'<dl>
+				<dt><code>[ap_title]</code></dt>
+				<dd>' . \wp_kses( __( 'The post\'s title.', 'activitypub' ), 'default' ) . '</dd>
+				<dt><code>[ap_content]</code></dt>
+				<dd>' . \wp_kses( __( 'The post\'s content.', 'activitypub' ), 'default' ) . '</dd>
+				<dt><code>[ap_excerpt lenght="400"]</code></dt>
+				<dd>' . \wp_kses( __( 'The post\'s excerpt (default 400 chars). length parameter is optional.', 'activitypub' ), 'default' ) . '</dd>
+				<dt><code>[ap_permalink type="url"]</code></dt>
+				<dd>' . \wp_kses( __( 'The post\'s permalink. Type can be either: <code>url</code> or <code>html</code> (an &lt;a /&gt; tag to the url).', 'activitypub' ), 'default' ) . '</dd>
+				<dt><code>[ap_shortlink type="url"]</code></dt>
+				<dd>' . \wp_kses( __( 'The post\'s shortlink. Type can be either <code>url</code> or <code>html</code> (an &lt;a /&gt; tag to the url). I can recommend <a href="https://wordpress.org/plugins/hum/" target="_blank">Hum</a>, to prettify the Shortlinks.', 'activitypub' ), 'default' ) . '</dd>
+				<dt><code>[ap_hashtags]</code></dt>
+				<dd>' . \wp_kses( __( 'The post\'s tags as hashtags.', 'activitypub' ), 'default' ) . '</dd>
+				<dt><code>[ap_hashcats]</code></dt>
+				<dd>' . \wp_kses( __( 'The post\'s categories as hashtags.', 'activitypub' ), 'default' ) . '</dd>
+				<dt><code>[ap_image type=full]</code></dt>
+				<dd>' . \wp_kses( __( 'The URL for the post\'s featured image, defaults to full size. The type attribute can be any of the following: <code>thumbnail</code>, <code>medium</code>, <code>large</code>, <code>full</code>', 'activitypub' ), 'default' ) . '</dd>
+				<dt><code>[ap_author]</code></dt>
+				<dd>' . \wp_kses( __( 'The author\'s name.', 'activitypub' ), 'default' ) . '</dd>
+				<dt><code>[ap_authorurl]</code></dt>
+				<dd>' . \wp_kses( __( 'The URL to the author\'s profile page.', 'activitypub' ), 'default' ) . '</dd>
+				<dt><code>[ap_date]</code></dt>
+				<dd>' . \wp_kses( __( 'The post\'s date.', 'activitypub' ), 'default' ) . '</dd>
+				<dt><code>[ap_time]</code></dt>
+				<dd>' . \wp_kses( __( 'The post\'s time.', 'activitypub' ), 'default' ) . '</dd>
+				<dt><code>[ap_datetime]</code></dt>
+				<dd>' . \wp_kses( __( 'The post\'s date/time formated as "date @ time".', 'activitypub' ), 'default' ) . '</dd>
+				<dt><code>[ap_blogurl]</code></dt>
+				<dd>' . \wp_kses( __( 'The URL to the site.', 'activitypub' ), 'default' ) . '</dd>
+				<dt><code>[ap_blogname]</code></dt>
+				<dd>' . \wp_kses( __( 'The name of the site.', 'activitypub' ), 'default' ) . '</dd>
+				<dt><code>[ap_blogdesc]</code></dt>
+				<dd>' . \wp_kses( __( 'The description of the site.', 'activitypub' ), 'default' ) . '</dd>
+			</dl>' .
+			'<p>' . __( 'You may also use any Shortcode normally available to you on your site, however be aware that Shortcodes may significantly increase the size of your content depending on what they do.', 'activitypub' ) . '</p>' .
+			'<p>' . __( 'Note: the old Template Tags are now deprecated and automatically converted to the new ones.', 'activitypub' ) . '</p>' .
+			'<p>' . \wp_kses( \__( '<a href="https://github.com/pfefferle/wordpress-activitypub/issues/new" target="_blank">Let me know</a> if you miss a template pattern.', 'activitypub' ), 'activitypub' ) . '</p>',
+	)
+);
+
 \get_current_screen()->add_help_tab(
 	array(
 		'id'      => 'glossar',

includes/model/class-post.php

@@ -16,7 +16,7 @@ class Post {
 	private $tags;
 	private $object_type;
 
-	public function __construct( $post = null ) {
+	public function __construct( $post ) {
 		$this->post = \get_post( $post );
 
 		$this->post_author = $this->post->post_author;
@@ -226,18 +226,22 @@ class Post {
 		return $object_type;
 	}
 
+	/**
+	 * Generates the content for the activitypub item.
+	 *
+	 * @return string the content
+	 */
 	public function generate_the_content() {
 		$post = $this->post;
 		$content = $this->get_post_content_template();
 
-		$content = \str_replace( '%title%', \get_the_title( $post->ID ), $content );
+		// Register the shortcodes.
-		$content = \str_replace( '%excerpt%', $this->get_the_post_excerpt(), $content );
+		$shortcodes = new \Activitypub\Shortcodes( $post );
-		$content = \str_replace( '%content%', $this->get_the_post_content(), $content );
+
-		$content = \str_replace( '%permalink%', $this->get_the_post_link( 'permalink' ), $content );
+		// Fill in the shortcodes.
-		$content = \str_replace( '%shortlink%', $this->get_the_post_link( 'shortlink' ), $content );
+		setup_postdata( $post );
-		$content = \str_replace( '%hashtags%', $this->get_the_post_hashtags(), $content );
+		$content = do_shortcode( $content );
-		// backwards compatibility
+		wp_reset_postdata();
-		$content = \str_replace( '%tags%', $this->get_the_post_hashtags(), $content );
 
 		$content = \trim( \preg_replace( '/[\r\n]{2,}/', '', $content ) );
 
@@ -253,166 +257,66 @@ class Post {
 		return $decoded_content;
 	}
 
+	/**
+	 * Gets the template to use to generate the content of the activitypub item.
+	 *
+	 * @return string the template
+	 */
 	public function get_post_content_template() {
 		if ( 'excerpt' === \get_option( 'activitypub_post_content_type', 'content' ) ) {
-			return "%excerpt%\n\n<p>%permalink%</p>";
+			return "[ap_excerpt]\n\n<p>[ap_permalink]</p>";
 		}
 
 		if ( 'title' === \get_option( 'activitypub_post_content_type', 'content' ) ) {
-			return "<p><strong>%title%</strong></p>\n\n<p>%permalink%</p>";
+			return "<p>[ap_title]</p>\n\n<p>[ap_permalink]</p>";
 		}
 
 		if ( 'content' === \get_option( 'activitypub_post_content_type', 'content' ) ) {
-			return "%content%\n\n<p>%hashtags%</p>\n\n<p>%permalink%</p>";
+			return "[ap_content]\n\n<p>[ap_hashtags]</p>\n\n<p>[ap_permalink]</p>";
 		}
 
-		return \get_option( 'activitypub_custom_post_content', ACTIVITYPUB_CUSTOM_POST_CONTENT );
+		// Upgrade from old template codes to shortcodes.
+		$content = self::upgrade_post_content_template();
+
+		return $content;
 	}
 
 	/**
-	 * Get the excerpt for a post for use outside of the loop.
+	 * Updates the custom template to use shortcodes instead of the deprecated templates.
 	 *
-	 * @param int     Optional excerpt length.
+	 * @return string the updated template content
-	 *
-	 * @return string The excerpt.
 	 */
-	public function get_the_post_excerpt( $excerpt_length = 400 ) {
+	public static function upgrade_post_content_template() {
-		$post = $this->post;
+		// Get the custom template.
+		$old_content = \get_option( 'activitypub_custom_post_content', ACTIVITYPUB_CUSTOM_POST_CONTENT );
 
-		$excerpt = \get_post_field( 'post_excerpt', $post );
+		// If the old content exists but is a blank string, we're going to need a flag to updated it even
+		// after setting it to the default contents.
+		$need_update = false;
 
-		if ( '' === $excerpt ) {
+		// If the old contents is blank, use the defaults.
+		if ( '' === $old_content ) {
+			$old_content = ACTIVITYPUB_CUSTOM_POST_CONTENT;
+			$need_update = true; }
 
-			$content = \get_post_field( 'post_content', $post );
+		// Set the new content to be the old content.
+		$content = $old_content;
 
-			// An empty string will make wp_trim_excerpt do stuff we do not want.
+		// Convert old templates to shortcodes.
-			if ( '' !== $content ) {
+		$content = \str_replace( '%title%', '[ap_title]', $content );
+		$content = \str_replace( '%excerpt%', '[ap_excerpt]', $content );
+		$content = \str_replace( '%content%', '[ap_content]', $content );
+		$content = \str_replace( '%permalink%', '[ap_permalink type="html"]', $content );
+		$content = \str_replace( '%shortlink%', '[ap_shortlink type="html"]', $content );
+		$content = \str_replace( '%hashtags%', '[ap_hashtags]', $content );
+		$content = \str_replace( '%tags%', '[ap_hashtags]', $content );
 
-				$excerpt = \strip_shortcodes( $content );
+		// Store the new template if required.
-
+		if ( $content !== $old_content || $need_update ) {
-				/** This filter is documented in wp-includes/post-template.php */
+			\update_option( 'activitypub_custom_post_content', $content );
-				$excerpt = \apply_filters( 'the_content', $excerpt );
-				$excerpt = \str_replace( ']]>', ']]>', $excerpt );
-
-			}
 		}
 
-		// Strip out any remaining tags.
+		return $content;
-		$excerpt = \wp_strip_all_tags( $excerpt );
-
-		/** This filter is documented in wp-includes/formatting.php */
-		$excerpt_more = \apply_filters( 'excerpt_more', ' [...]' );
-		$excerpt_more_len = strlen( $excerpt_more );
-
-		// We now have a excerpt, but we need to check it's length, it may be longer than we want for two reasons:
-		//
-		//   * The user has entered a manual excerpt which is longer that what we want.
-		//   * No manual excerpt exists so we've used the content which might be longer than we want.
-		//
-		// Either way, let's trim it up if we need too.  Also, don't forget to take into account the more indicator
-		// as part of the total length.
-		//
-
-		// Setup a variable to hold the current excerpts length.
-		$current_excerpt_length = strlen( $excerpt );
-
-		// Setup a variable to keep track of our target length.
-		$target_excerpt_length = $excerpt_length - $excerpt_more_len;
-
-		// Setup a variable to keep track of the current max length.
-		$current_excerpt_max = $target_excerpt_length;
-
-		// This is a loop since we can't calculate word break the string after 'the_excpert' filter has run (we would break
-		// all kinds of html tags), so we have to cut the excerpt down a bit at a time until we hit our target length.
-		while ( $current_excerpt_length > $target_excerpt_length && $current_excerpt_max > 0 ) {
-			// Trim the excerpt based on wordwrap() positioning.
-			// Note: we're using <br> as the linebreak just in case there are any newlines existing in the excerpt from the user.
-			//       There won't be any <br> left after we've run wp_strip_all_tags() in the code above, so they're
-			//       safe to use here.  It won't be included in the final excerpt as the substr() will trim it off.
-			$excerpt = substr( $excerpt, 0, strpos( wordwrap( $excerpt, $current_excerpt_max, '<br>' ), '<br>' ) );
-
-			// If something went wrong, or we're in a language that wordwrap() doesn't understand,
-			// just chop it off and don't worry about breaking in the middle of a word.
-			if ( strlen( $excerpt ) > $excerpt_length - $excerpt_more_len ) {
-				$excerpt = substr( $excerpt, 0, $current_excerpt_max );
 	}
 
-			// Add in the more indicator.
-			$excerpt = $excerpt . $excerpt_more;
-
-			// Run it through the excerpt filter which will add some html tags back in.
-			$excerpt_filtered = apply_filters( 'the_excerpt', $excerpt );
-
-			// Now set the current excerpt length to this new filtered length.
-			$current_excerpt_length = strlen( $excerpt_filtered );
-
-			// Check to see if we're over the target length.
-			if ( $current_excerpt_length > $target_excerpt_length ) {
-				// If so, remove 20 characters from the current max and run the loop again.
-				$current_excerpt_max = $current_excerpt_max - 20;
-			}
-		}
-
-		return \apply_filters( 'the_excerpt', $excerpt );
-	}
-
-	/**
-	 * Get the content for a post for use outside of the loop.
-	 *
-	 * @return string The content.
-	 */
-	public function get_the_post_content() {
-		$post = $this->post;
-
-		$content = \get_post_field( 'post_content', $post );
-
-		return \apply_filters( 'the_content', $content );
-	}
-
-	/**
-	 * Adds a backlink to the post/summary content
-	 *
-	 * @param string  $content
-	 * @param WP_Post $post
-	 *
-	 * @return string
-	 */
-	public function get_the_post_link( $type = 'permalink' ) {
-		$post = $this->post;
-
-		if ( 'shortlink' === $type ) {
-			$link = \esc_url( \wp_get_shortlink( $post->ID ) );
-		} elseif ( 'permalink' === $type ) {
-			$link = \esc_url( \get_permalink( $post->ID ) );
-		} else {
-			return '';
-		}
-
-		return \sprintf( '<a href="%1$s">%1$s</a>', $link );
-	}
-
-	/**
-	 * Adds all tags as hashtags to the post/summary content
-	 *
-	 * @param string  $content
-	 * @param WP_Post $post
-	 *
-	 * @return string
-	 */
-	public function get_the_post_hashtags() {
-		$post = $this->post;
-		$tags = \get_the_tags( $post->ID );
-
-		if ( ! $tags ) {
-			return '';
-		}
-
-		$hash_tags = array();
-
-		foreach ( $tags as $tag ) {
-			$hash_tags[] = \sprintf( '<a rel="tag" class="u-tag u-category" href="%s">#%s</a>', \get_tag_link( $tag ), $tag->slug );
-		}
-
-		return \implode( ' ', $hash_tags );
-	}
 }

readme.txt

@@ -91,6 +91,7 @@ Project maintained on GitHub at [pfefferle/wordpress-activitypub](https://github
 = v.next =
 
 * Add configuration item for number of images to attach. props [@mexon](https://github.com/mexon)
+* Use shortcodes instead of custom templates, to setup the Activity Post-Content. props [@toolstack](https://github.com/toolstack)
 
 = 0.15.0 =
 

templates/settings.php

@@ -56,22 +56,22 @@
 						<p>
 							<textarea name="activitypub_custom_post_content" id="activitypub_custom_post_content" rows="10" cols="50" class="large-text" placeholder="<?php echo wp_kses( ACTIVITYPUB_CUSTOM_POST_CONTENT, 'post' ); ?>"><?php echo wp_kses( \get_option( 'activitypub_custom_post_content', ACTIVITYPUB_CUSTOM_POST_CONTENT ), 'post' ); ?></textarea>
 							<details>
-								<summary><?php esc_html_e( 'See the complete list of template patterns.', 'activitypub' ); ?></summary>
+								<summary><?php esc_html_e( 'See a list of ActivityPub Template Tags.', 'activitypub' ); ?></summary>
 								<div class="description">
 									<ul>
-										<li><code>%title%</code> - <?php \esc_html_e( 'The Post-Title.', 'activitypub' ); ?></li>
+										<li><code>[ap_title]</code> - <?php \esc_html_e( 'The post\'s title.', 'activitypub' ); ?></li>
-										<li><code>%content%</code> - <?php \esc_html_e( 'The Post-Content.', 'activitypub' ); ?></li>
+										<li><code>[ap_content]</code> - <?php \esc_html_e( 'The post\'s content.', 'activitypub' ); ?></li>
-										<li><code>%excerpt%</code> - <?php \esc_html_e( 'The Post-Excerpt (default 400 Chars).', 'activitypub' ); ?></li>
+										<li><code>[ap_excerpt]</code> - <?php \esc_html_e( 'The post\'s excerpt (default 400 chars).', 'activitypub' ); ?></li>
-										<li><code>%permalink%</code> - <?php \esc_html_e( 'The Post-Permalink.', 'activitypub' ); ?></li>
+										<li><code>[ap_permalink]</code> - <?php \esc_html_e( 'The post\'s permalink.', 'activitypub' ); ?></li>
-										<?php // translators: ?>
+										<li><code>[ap_shortlink]</code> - <?php echo \wp_kses( \__( 'The post\'s shortlink. I can recommend <a href="https://wordpress.org/plugins/hum/" target="_blank">Hum</a>.', 'activitypub' ), 'default' ); ?></li>
-										<li><code>%shortlink%</code> - <?php echo \wp_kses( \__( 'The Post-Shortlink. I can recommend <a href="https://wordpress.org/plugins/hum/" target="_blank">Hum</a>, to prettify the Shortlinks', 'activitypub' ), 'default' ); ?></li>
+										<li><code>[ap_hashtags]</code> - <?php \esc_html_e( 'The post\'s tags as hashtags.', 'activitypub' ); ?></li>
-										<li><code>%hashtags%</code> - <?php \esc_html_e( 'The Tags as Hashtags.', 'activitypub' ); ?></li>
+										<li><code>[ap_hashcats]</code> - <?php \esc_html_e( 'The post\'s categories as hashtags.', 'activitypub' ); ?></li>
+										<li><code>[ap_image]</code> - <?php \esc_html_e( 'The URL for the post\'s featured image.', 'activitypub' ); ?></li>
 									</ul>
+									<p><?php \esc_html_e( 'You can find the full list with all possible attributes in the help section on the top-right of the screen.', 'activitypub' ); ?></p>
 								</div>
 							</details>
 						</p>
-						<?php // translators: ?>
-						<p><?php echo \wp_kses( \__( '<a href="https://github.com/pfefferle/wordpress-activitypub/issues/new" target="_blank">Let me know</a> if you miss a template pattern.', 'activitypub' ), 'default' ); ?></p>
 					</td>
 				</tr>
 				<tr>