fix: support custom post types in default archive queries

- turn example code into a comment
- remove redundant class in generated page templates
- update instructions for creating post types
- comment out unnecessary add_filter call

Author: dustin-jw

README.md

@@ -350,6 +350,8 @@ The following files will be created based on your inputs:
 - `src/php/views/single-<post-type-name>.twig` (optional)
 - `src/php/views/archive-<post-type-name>.twig` (optional)
 
+To allow for posts from your new custom post type to be shown on archive pages, you will also need to update `src/php/inc/setup-queries.php` to look for posts and your custom post types by default.
+
 [Custom Post Types documentation](https://wordpress.org/support/article/post-types/#custom-post-types)
 
 ### Custom Taxonomy

generators/page-template.js

@@ -18,7 +18,7 @@ render_with_password_protection( $timber_post, '${baseFileName}.twig', $context
 const twigTemplate = `{% extends "layouts/base.twig" %}
 
 {% block content %}
-	<div class="obj-width-limiter">
+	<div>
 		{{ post.content }}
 	</div>
 {% endblock %}

generators/post-type.js

@@ -63,7 +63,7 @@ render_with_password_protection( $timber_post, $templates, $context );
 const getSinglePostTemplate = () => `{% extends "layouts/base.twig" %}
 
 {% block content %}
-  <div class="obj-width-limiter">
+  <div>
     {{ post.content }}
   </div>
 {% endblock %}
@@ -85,7 +85,7 @@ Timber\\Timber::render( $templates, $context );
 const getArchiveTemplate = () => `{% extends "layouts/base.twig" %}
 
 {% block content %}
-	<div class="obj-width-limiter">
+	<div>
 		{% if posts.found_posts %}
 			<h1>{{ title }}</h1>
 			{% for post in posts %}
@@ -186,6 +186,10 @@ const generatePostType = async () => {
 		writeFileSync(archiveTemplatePath, archiveTemplate, 'utf-8');
 		console.log(`Created ${archiveTemplatePath}`);
 	}
+
+	console.log(`
+Note: to get posts from your new custom post type to show up on archive pages, you will need to update enable_custom_posts_in_archives in ./src/php/inc/setup-queries.php.
+	`);
 };
 
 generatePostType();

generators/taxonomy.js

@@ -52,7 +52,7 @@ Timber\\Timber::render( $templates, $context );
 const getArchiveTemplate = () => `{% extends "layouts/base.twig" %}
 
 {% block content %}
-	<div class="obj-width-limiter">
+	<div>
 		{% if posts.found_posts %}
 			<h1>{{ title }}</h1>
 			{% for post in posts %}

src/php/inc/setup-queries.php

@@ -10,8 +10,35 @@
  * @return array
  */
 function sb_query_vars_filter( $vars ) {
-	$vars[] = 'example_var'; // e.g. allow ?example_var="test" in url.
+	// Allow custom query params in URL.
+	// e.g. $vars[] = 'example_var'; to allow ?example_var=test in URL.
 	return $vars;
 }
+// Uncomment this line if you've added custom query params.
+// add_filter( 'query_vars', 'sb_query_vars_filter' );
 
-add_filter( 'query_vars', 'sb_query_vars_filter' );
+/**
+ * Alter default query to fetch posts from custom post types on archive pages.
+ *
+ * @param object $query - The incoming query.
+ * @return object
+ */
+function enable_custom_posts_in_archives( $query ) {
+	if ( $query->is_admin() || $query->is_post_type_archive() ) {
+		return $query;
+	}
+
+	if ( $query->is_archive() || ( $query->is_home() && $query->is_main_query() ) ) {
+		$query->set(
+			'post_type',
+			array(
+				'post',
+				// Extend which post types will be queried by default on archive pages.
+				// e.g. 'recipe', to fetch posts for a custom post type with the slug 'recipe'
+			)
+		);
+	}
+
+	return $query;
+}
+add_filter( 'pre_get_posts', 'enable_custom_posts_in_archives' );

src/php/inc/theme-scripts.php

@@ -9,9 +9,10 @@
  * Enqueue scripts and styles.
  */
 function sparkpress_theme_scripts() {
-	$example_data = array( '1', '2', '3' );
 	wp_enqueue_script( 'sparkpress-theme-script', get_template_directory_uri() . '/js/scripts.js', array(), _S_VERSION, true );
-	// Defines an `example` JavaScript variable, within the sparkpress-theme-script, equal to $example_data.
-	wp_localize_script( 'sparkpress-theme-script', 'example', $example_data );
+
+	// You can also define global variables that get appended to an enqueued script.
+	// e.g. wp_localize_script( 'sparkpress-theme-script', 'example', array( '1', '2', '3' ) );
+	// would define `example` as a global variable with a value of [1, 2, 3]
 }
 add_action( 'wp_footer', 'sparkpress_theme_scripts' );

src/php/inc/theme-setup.php

@@ -101,13 +101,12 @@ function custom_hide_editor() {
  *
  * @param mixed  $value   The current option value.
  * @param string $option The name of the option being filtered.
- * @param mixed  $default The default value for the option.
  *
  * @return mixed The filtered option value. If the provided option is 'default_ping_status',
  *               this function will set its value to 'closed' (disabling pingbacks and trackbacks),
  *               and return the updated value. For other options, it returns the original value.
  */
-function custom_disable_pingbacks_trackbacks_option( $value, $option, $default ) {
+function custom_disable_pingbacks_trackbacks_option( $value, $option ) {
     if ( 'default_ping_status' === $option ) {
         $value = 'closed';
     }