wordpress-activitypub/includes/class-shortcodes.php

<?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( $shortcode != 'init' ) {
				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 = get_post();

		if( ! \is_object( $post ) || ( \is_object( $post ) && get_class( $post ) != 'WP_Post' ) ) {
			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 = get_post();

		if( ! \is_object( $post ) || ( \is_object( $post ) && get_class( $post ) != 'WP_Post' ) ) {
			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( ! \is_object( $post ) || ( \is_object( $post ) && get_class( $post ) != 'WP_Post' ) ) {
			return '';
		}

		$atts = shortcode_atts( array( 'length' => ACTIVITYPUB_EXCERPT_LENGTH ), $atts, $tag );

		$length = intval( $atts['length'] );

		if( $length == 0 ) { $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( ! \is_object( $post ) || ( \is_object( $post ) && get_class( $post ) != 'WP_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( ! \is_object( $post ) || ( \is_object( $post ) && get_class( $post ) != 'WP_Post' ) ) {
			return '';
		}

		$atts = shortcode_atts( array( 'type' => 'html' ), $atts, $tag );

		if( is_array( $atts ) && array_key_exists( 'type', $atts ) ) {
			if( $atts['type'] == 'raw' ) {
				return \get_permalink( $post->ID );
			}

			if( $atts['type'] == 'esc' ) {
				return \esc_url( \get_permalink( $post->ID ) );
			}

			if( $atts['type'] == 'blank' ) {
				return \sprintf( '<a href="%1$s" target="_blank">%1$s</a>', \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( ! \is_object( $post ) || ( \is_object( $post ) && get_class( $post ) != 'WP_Post' ) ) {
			return '';
		}

		$atts = shortcode_atts( array( 'type' => 'html' ), $atts, $tag );

		if( is_array( $atts ) && array_key_exists( 'type', $atts ) ) {
			if( $atts['type'] == 'raw' ) {
				return \wp_get_shortlink( $post->ID );
			}

			if( $atts['type'] == 'esc' ) {
				return \esc_url( \wp_get_shortlink( $post->ID ) );
			}

			if( $atts['type'] == 'blank' ) {
				return \sprintf( '<a href="%1$s" target="_blank">%1$s</a>', \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_thumbnail shortcode
	 *
	 * @param array  $atts 		shortcode attributes
	 * @param string $content 	shortcode content
	 * @param string $tag 		shortcode tag name
	 *
	 * @return string
	 */
	public static function thumbnail( $atts, $content, $tag ) {
		$post = get_post();

		if( ! \is_object( $post ) || ( \is_object( $post ) && get_class( $post ) != 'WP_Post' ) ) {
			return '';
		}

		$image = \get_the_post_thumbnail_url( $post->ID, 'thumbnail' );

		if ( ! $image ) {
			return '';
		}

		return $image;
	}

	/**
	 * 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 = get_post();

		if( ! \is_object( $post ) || ( \is_object( $post ) && get_class( $post ) != 'WP_Post' ) ) {
			return '';
		}

		$atts = shortcode_atts( array( 'size' => 'full' ), $atts, $tag );

		if( is_array( $atts ) && array_key_exists( 'size', $atts ) ) {
			$registered_sizes = wp_get_registered_image_subsizes();

			if( array_key_exists( $atts['size'], $registered_sizes ) ) {
				$size = intval( $atts['size'] );
			}
		}

		if( ! $size ) { $size = 'full'; }

		$image = \get_the_post_thumbnail_url( $post->ID, $size );

		if ( ! $image ) {
			return '';
		}

		return $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 = get_post();

		if( ! \is_object( $post ) || ( \is_object( $post ) && get_class( $post ) != 'WP_Post' ) ) {
			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( ! \is_object( $post ) || ( \is_object( $post ) && get_class( $post ) != 'WP_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( ! \is_object( $post ) || ( \is_object( $post ) && get_class( $post ) != 'WP_Post' ) ) {
			return '';
		}

		$url = \get_the_author_meta( 'user_url', $post->post_author );

		if ( ! $url ) {
			return '';
		}

		return $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 \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( ! \is_object( $post ) || ( \is_object( $post ) && get_class( $post ) != 'WP_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( ! \is_object( $post ) || ( \is_object( $post ) && get_class( $post ) != 'WP_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( ! \is_object( $post ) || ( \is_object( $post ) && get_class( $post ) != 'WP_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;
	}

}