Merge pull request #90 from Automattic/fix/73-postnotesurl

Fixes for #73, also introducing a REST API namespace for the plugin a…
Automattic · Dec 20, 2024 · eadfc57 · eadfc57
2 parents ffce29b + db53d45
commit eadfc57
Show file tree

Hide file tree

Showing 8 changed files with 105 additions and 53 deletions.
diff --git a/includes/block-functions.php b/includes/block-functions.php
@@ -698,15 +698,15 @@ function ttgarden_block_post_notes( $atts, $content = '' ): string {
 add_shortcode( 'block_postnotes', 'ttgarden_block_post_notes' );
 
 /**
- * Rendered if the post has at least one comment.
+ * Always rendered, but only outputs content if the post has comments or comments open.
  *
  * @param array  $atts    The attributes of the shortcode.
  * @param string $content The content of the shortcode.
  *
  * @return string
  */
 function ttgarden_block_notecount( $atts, $content = '' ): string {
-	return ( get_comments_number() > 0 ) ? ttgarden_do_shortcode( $content ) : '';
+	return ttgarden_do_shortcode( $content );
 }
 add_shortcode( 'block_notecount', 'ttgarden_block_notecount' );
 
@@ -1686,7 +1686,7 @@ function ttgarden_block_daypage( $atts, $content = '' ): string {
  * @return string
  */
 function ttgarden_block_previouspage( $atts, $content = '' ): string {
-	return ( get_next_posts_link() ) ? ttgarden_do_shortcode( $content ) : '';
+	return ( get_previous_posts_link() ) ? ttgarden_do_shortcode( $content ) : '';
 }
 add_shortcode( 'block_previouspage', 'ttgarden_block_previouspage' );
 
@@ -1699,7 +1699,7 @@ function ttgarden_block_previouspage( $atts, $content = '' ): string {
  * @return string
  */
 function ttgarden_block_nextpage( $atts, $content = '' ): string {
-	return ( get_previous_posts_link() ) ? ttgarden_do_shortcode( $content ) : '';
+	return ( get_next_posts_link() ) ? ttgarden_do_shortcode( $content ) : '';
 }
 add_shortcode( 'block_nextpage', 'ttgarden_block_nextpage' );
 

diff --git a/includes/tag-functions.php b/includes/tag-functions.php
@@ -689,7 +689,7 @@ function ttgarden_tag_nextpost(): string {
  * @see https://www.tumblr.com/docs/en/custom_themes#basic_variables
  */
 function ttgarden_tag_previouspage(): string|null {
-	return untrailingslashit( esc_url( get_next_posts_page_link() ) );
+	return untrailingslashit( esc_url( get_previous_posts_page_link() ) );
 }
 add_shortcode( 'tag_previouspage', 'ttgarden_tag_previouspage' );
 
@@ -701,7 +701,7 @@ function ttgarden_tag_previouspage(): string|null {
  * @see https://www.tumblr.com/docs/en/custom_themes#basic_variables
  */
 function ttgarden_tag_nextpage(): string|null {
-	return untrailingslashit( esc_url( get_previous_posts_page_link() ) );
+	return untrailingslashit( esc_url( get_next_posts_page_link() ) );
 }
 add_shortcode( 'tag_nextpage', 'ttgarden_tag_nextpage' );
 
@@ -874,6 +874,7 @@ function ttgarden_tag_notecountwithlabel(): string {
 	return get_comments_number_text();
 }
 add_shortcode( 'tag_notecountwithlabel', 'ttgarden_tag_notecountwithlabel' );
+add_shortcode( 'tag_formattednotecount', 'ttgarden_tag_notecountwithlabel' );
 
 /**
  * The post comments.
@@ -1928,11 +1929,14 @@ public function __construct( $id ) {
 add_shortcode( 'tag_likebutton', 'ttgarden_tag_likebutton' );
 
 /**
- * Returns a URL to the post comments.
+ * Returns a URL to the post comments HTML partial.
  *
  * @return string
  */
 function ttgarden_tag_postnotesurl(): string {
-	return get_comments_link();
+	return sprintf(
+		'/?p=%d&ttgarden_html_comments=true',
+		get_the_ID()
+	);
 }
 add_shortcode( 'tag_postnotesurl', 'ttgarden_tag_postnotesurl' );
diff --git a/includes/tumblr-theme-language/tags.php b/includes/tumblr-theme-language/tags.php
@@ -204,6 +204,7 @@
 	'PostNotes-64',
 	'NoteCount',
 	'NoteCountWithLabel',
+	'FormattedNoteCount',
 	'Tag',
 	'URLSafeTag',
 	'TagURL',

diff --git a/src/Customizer.php b/src/Customizer.php
@@ -468,16 +468,15 @@ public function theme_specific_options( $wp_customize ): void {
 						$wp_customize,
 						$name,
 						array(
-							'label'    => $label,
-							'section'  => 'colors',
-							'settings' => $name,
+							'label'   => $label,
+							'section' => 'colors',
 						)
 					)
 				);
 
 				// If it doesn't exist, load the default value into the theme mod.
 				if ( ! get_theme_mod( $name ) ) {
-					set_theme_mod( $name, $color );
+					set_theme_mod( $name, sanitize_hex_color( $color ) );
 				}
 
 				continue;
@@ -514,7 +513,7 @@ public function theme_specific_options( $wp_customize ): void {
 
 				// If it doesn't exist, load the default value into the theme mod.
 				if ( ! get_theme_mod( $name ) ) {
-					set_theme_mod( $name, $font );
+					set_theme_mod( $name, sanitize_text_field( $font ) );
 				}
 
 				continue;
@@ -551,7 +550,7 @@ public function theme_specific_options( $wp_customize ): void {
 
 				// If it doesn't exist, load the default value into the theme mod.
 				if ( null === get_theme_mod( $name, null ) ) {
-					set_theme_mod( $name, '1' === $condition ? '1' : '' );
+					set_theme_mod( $name, sanitize_text_field( '1' === $condition ? '1' : '' ) );
 				}
 
 				continue;
@@ -588,7 +587,7 @@ public function theme_specific_options( $wp_customize ): void {
 
 				// If it doesn't exist, load the default value into the theme mod.
 				if ( ! get_theme_mod( $name ) ) {
-					set_theme_mod( $name, $text );
+					set_theme_mod( $name, sanitize_text_field( $text ) );
 				}
 
 				continue;
@@ -628,7 +627,7 @@ public function theme_specific_options( $wp_customize ): void {
 
 				// If it doesn't exist, load the default value into the theme mod.
 				if ( ! get_theme_mod( $name ) ) {
-					set_theme_mod( $name, $image );
+					set_theme_mod( $name, esc_url_raw( $image ) );
 				}
 
 				continue;
@@ -676,7 +675,7 @@ public function theme_specific_options( $wp_customize ): void {
 
 			// If it doesn't exist, load the default value into the theme mod.
 			if ( ! get_theme_mod( $name ) ) {
-				set_theme_mod( $name, $default );
+				set_theme_mod( $name, sanitize_text_field( $default ) );
 			}
 		}
 	}

diff --git a/src/ThemeGarden.php b/src/ThemeGarden.php
@@ -198,7 +198,7 @@ public function get_theme( string $theme_id ) {
 	 */
 	public function register_rest_routes(): void {
 		register_rest_route(
-			'tumblr-theme-garden/v1',
+			TTGARDEN_REST_NAMESPACE,
 			'/themes',
 			array(
 				'methods'             => 'GET',
@@ -210,7 +210,7 @@ public function register_rest_routes(): void {
 		);
 
 		register_rest_route(
-			'tumblr-theme-garden/v1',
+			TTGARDEN_REST_NAMESPACE,
 			'/theme',
 			array(
 				'methods'             => 'GET',
@@ -331,14 +331,18 @@ function ( $theme ) {
 	 * @return void
 	 */
 	public function option_defaults_helper( $default_params ): void {
-		$ttgarden_mods = get_option( 'theme_mods_ttgarden', array() );
+		$ttgarden_mods = get_option( 'theme_mods_tumblr-theme-garden', array() );
+
+		if ( ! is_array( $ttgarden_mods ) ) {
+			$ttgarden_mods = array();
+		}
 
 		foreach ( $default_params as $key => $value ) {
 			$normal                   = ttgarden_normalize_option_name( $key );
-			$ttgarden_mods[ $normal ] = $value;
+			$ttgarden_mods[ $normal ] = ( str_starts_with( $key, 'color:' ) ) ? sanitize_hex_color( $value ) : sanitize_text_field( $value );
 		}
 
-		update_option( 'theme_mods_ttgarden', $ttgarden_mods );
+		update_option( 'theme_mods_tumblr-theme-garden', $ttgarden_mods );
 	}
 
 	/**

diff --git a/theme/tumblr-theme-garden/comments.php b/theme/tumblr-theme-garden/comments.php
@@ -18,37 +18,38 @@
 }
 ?>
 
-<?php if ( have_comments() ) : ?>
-
-	<ol class="notes">
-		<?php
-		wp_list_comments(
-			array(
-				'style'       => 'ol',
-				'short_ping'  => true,
-				'avatar_size' => 24,
-				'callback'    => 'ttgarden_comment_markup',
-				'max_depth'   => 0,
-			)
-		);
-		?>
-	</ol><!-- .comment-list -->
-
-	<?php if ( get_comment_pages_count() > 1 && get_option( 'page_comments' ) ) : ?>
-		<nav class="navigation comment-navigation" role="navigation">
-			<div class="nav-previous"><?php previous_comments_link( __( '&larr; Older Comments', 'tumblr-theme-garden' ) ); ?></div>
-			<div class="nav-next"><?php next_comments_link( __( 'Newer Comments &rarr;', 'tumblr-theme-garden' ) ); ?></div>
-		</nav><!-- .comment-navigation -->
-	<?php endif; // Check for comment navigation ?>
-
-	<?php if ( ! comments_open() && get_comments_number() ) : ?>
-		<p class="no-comments"><?php esc_html_e( 'Comments are closed.', 'tumblr-theme-garden' ); ?></p>
-	<?php endif; ?>
+<ol class="notes">
+	<?php
+	wp_list_comments(
+		array(
+			'style'       => 'ol',
+			'short_ping'  => true,
+			'avatar_size' => 24,
+			'callback'    => 'ttgarden_comment_markup',
+			'max_depth'   => 0,
+		)
+	);
+	?>
+</ol><!-- .comment-list -->
+
+<?php if ( get_comment_pages_count() > 1 && get_option( 'page_comments' ) ) : ?>
+	<nav class="navigation comment-navigation" role="navigation">
+		<div class="nav-previous"><?php previous_comments_link( __( '&larr; Older Comments', 'tumblr-theme-garden' ) ); ?></div>
+		<div class="nav-next"><?php next_comments_link( __( 'Newer Comments &rarr;', 'tumblr-theme-garden' ) ); ?></div>
+	</nav><!-- .comment-navigation -->
+<?php endif; // Check for comment navigation ?>
 
+<?php if ( ! comments_open() && get_comments_number() ) : ?>
+	<p class="no-comments"><?php esc_html_e( 'Comments are closed.', 'tumblr-theme-garden' ); ?></p>
 <?php endif; ?>
 
+<?php if ( comments_open() ) : ?>
+
 <ol class="notes">
 	<li>
 		<?php comment_form(); ?>
 	</li>
 </ol><!-- .comment-list -->
+
+	<?php
+endif;
diff --git a/theme/tumblr-theme-garden/functions.php b/theme/tumblr-theme-garden/functions.php
@@ -96,7 +96,7 @@ function ttgarden_enqueue_scripts(): void {
  *
  * @return void
  */
-function ttgarden_random_endpoint_rewrite(): void {
+function ttgarden_rewrite_rules(): void {
 	// Handle the Tumblr random endpoint.
 	add_rewrite_rule(
 		'^random/?$',
@@ -111,7 +111,7 @@ function ttgarden_random_endpoint_rewrite(): void {
 		'top'
 	);
 }
-add_action( 'init', 'ttgarden_random_endpoint_rewrite' );
+add_action( 'init', 'ttgarden_rewrite_rules' );
 
 /**
  * Add a new query variable for Tumblr search.
@@ -123,16 +123,56 @@ function ttgarden_random_endpoint_rewrite(): void {
 function ttgarden_add_tumblr_search_var( $vars ): array {
 	$vars[] = 'q';
 	$vars[] = 'random';
+	$vars[] = 'ttgarden_html_comments';
 	return $vars;
 }
 add_filter( 'query_vars', 'ttgarden_add_tumblr_search_var' );
 
 /**
- * Redirect Tumblr search to core search.
+ * Handles template redirects for Tumblr theme.
+ *
+ * - If 'random' is set, redirect to a random post.
+ * - If 'q' is set, redirect to the core search page.
+ * - If 'ttgarden_html_comments' is set, redirect to a HTML only comments page.
  *
  * @return void
  */
-function ttgarden_redirect_tumblr_search(): void {
+function ttgarden_template_redirects(): void {
+	// If 'ttgarden_html_comments' is set, redirect to a HTML only comments page. /?p=85&ttgarden_html_comments=true
+	if ( get_query_var( 'ttgarden_html_comments' ) ) {
+		$post_id = get_query_var( 'p' );
+
+		// Ensure this is a valid post, it's published, not private.
+		if ( ! 'post' === get_post_type( $post_id ) || 'publish' !== get_post_status( $post_id ) ) {
+			exit;
+		}
+
+		// Get the comments.
+		$comments = get_comments(
+			array(
+				'post_id' => $post_id,
+				'status'  => 'approve',
+			)
+		);
+
+		// Build the HTML output.
+		$html_output = sprintf(
+			'<ol class="notes">%s</ol>',
+			wp_list_comments(
+				array(
+					'style'    => 'ol',
+					'callback' => 'ttgarden_comment_markup',
+					'echo'     => false,
+					'per_page' => 100,
+				),
+				$comments
+			)
+		);
+
+		echo wp_kses_post( $html_output );
+		exit;
+	}
+
 	// If random is set, redirect to a random post.
 	if ( get_query_var( 'random' ) ) {
 		// @see https://docs.wpvip.com/databases/optimize-queries/using-post__not_in/
@@ -158,7 +198,7 @@ function ttgarden_redirect_tumblr_search(): void {
 		exit;
 	}
 }
-add_action( 'template_redirect', 'ttgarden_redirect_tumblr_search' );
+add_action( 'template_redirect', 'ttgarden_template_redirects', 1 );
 
 /**
  * Custom comment markup.

diff --git a/tumblr-theme-garden.php b/tumblr-theme-garden.php
@@ -36,6 +36,9 @@ function_exists( 'get_plugin_data' ) || require_once ABSPATH . 'wp-admin/include
 define( 'TTGARDEN_PATH', plugin_dir_path( __FILE__ ) );
 define( 'TTGARDEN_URL', plugin_dir_url( __FILE__ ) );
 
+// Define REST API namespace.
+define( 'TTGARDEN_REST_NAMESPACE', 'tumblr-theme-garden/v1' );
+
 // Define tag and block names from Tumblr Theme language.
 define( 'TTGARDEN_TAGS', require_once TTGARDEN_PATH . 'includes/tumblr-theme-language/tags.php' );
 define( 'TTGARDEN_BLOCKS', require_once TTGARDEN_PATH . 'includes/tumblr-theme-language/blocks.php' );