Add primary category selection to quick-edit and bulk-edit interfaces (#731)

Closes #512.

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: Sybre Waaijer <sybrew@users.noreply.github.com>

Author: Copilot

autodescription.php

@@ -3,7 +3,7 @@
  * Plugin Name: The SEO Framework
  * Plugin URI: https://theseoframework.com/
  * Description: An automated, advanced, accessible, unbranded and extremely fast SEO solution for your WordPress website.
- * Version: 5.1.3-dev-20
+ * Version: 5.1.3-dev-22
  * Author: Sybre Waaijer
  * Author URI: https://theseoframework.com/
  * Troy: https://repo.theseoframework.com/

inc/classes/admin/script/loader.class.php

@@ -101,6 +101,9 @@ public static function init() {
 			$scripts[] = static::get_description_scripts();
 			$scripts[] = static::get_canonical_scripts();
 
+			if ( Query::is_singular_admin() )
+				$scripts[] = static::get_primaryterm_scripts();
+
 			if ( Data\Plugin::get_option( 'display_pixel_counter' ) || Data\Plugin::get_option( 'display_character_counter' ) )
 				$scripts[] = static::get_counter_scripts();
 		} elseif ( Query::is_seo_settings_page() ) {
@@ -331,7 +334,7 @@ public static function get_list_edit_scripts() {
 			[
 				'id'       => 'tsf-le',
 				'type'     => 'js',
-				'deps'     => [ 'tsf-title', 'tsf-description', 'tsf-canonical', 'tsf-postslugs', 'tsf-termslugs', 'tsf-authorslugs', 'tsf', 'tsf-tt', 'tsf-utils' ],
+				'deps'     => [ 'tsf-pt-le', 'tsf-title', 'tsf-description', 'tsf-canonical', 'tsf-postslugs', 'tsf-termslugs', 'tsf-authorslugs', 'tsf', 'tsf-tt', 'tsf-utils' ],
 				'autoload' => true,
 				'name'     => 'le',
 				'base'     => \THE_SEO_FRAMEWORK_DIR_URL . 'lib/js/',
@@ -813,12 +816,13 @@ public static function get_canonical_scripts() {
 	 * @since 4.0.0
 	 * @since 4.1.0 Now filters out unsupported taxonomies.
 	 * @since 5.1.0 Changed the dependencies for pt, because we now use a select field.
+	 * @since 5.1.3 Added list edit support.
 	 *
 	 * @return array The script params.
 	 */
 	public static function get_primaryterm_scripts() {
 
-		$post_id = Query::get_the_real_admin_id();
+		$is_list_edit = Query::is_wp_lists_edit();
 
 		$post_type   = Query::get_admin_post_type();
 		$_taxonomies = $post_type ? Taxonomy::get_hierarchical( 'names', $post_type ) : [];
@@ -828,7 +832,7 @@ public static function get_primaryterm_scripts() {
 			if ( ! Taxonomy::is_supported( $tax ) ) continue;
 
 			$singular_name   = Taxonomy::get_label( $tax );
-			$primary_term_id = Data\Plugin\Post::get_primary_term_id( $post_id, $tax );
+			$primary_term_id = Data\Plugin\Post::get_primary_term_id( Query::get_the_real_admin_id(), $tax );
 
 			$taxonomies[ $tax ] = [
 				'name'    => $tax,
@@ -840,20 +844,33 @@ public static function get_primaryterm_scripts() {
 			];
 		}
 
-		if ( Query::is_block_editor() ) {
+		if ( $is_list_edit ) {
 			$vars = [
-				'id'   => 'tsf-pt-gb',
-				'name' => 'pt-gb',
+				'id'   => 'tsf-pt-le',
+				'name' => 'pt-le',
 			];
-			$deps = [ 'tsf', 'tsf-ays', 'wp-hooks', 'wp-element', 'wp-components', 'wp-data', 'wp-util' ];
+			$deps = [ 'tsf', 'wp-util' ];
 		} else {
-			$vars = [
-				'id'   => 'tsf-pt',
-				'name' => 'pt',
-			];
-			$deps = [ 'tsf', 'tsf-ays', 'wp-util' ];
+			// If not list edit, we're in the post editor.
+			if ( Query::is_block_editor() ) {
+				$vars = [
+					'id'   => 'tsf-pt-gb',
+					'name' => 'pt-gb',
+				];
+				$deps = [ 'tsf', 'tsf-ays', 'wp-hooks', 'wp-element', 'wp-components', 'wp-data', 'wp-util' ];
+			} else {
+				$vars = [
+					'id'   => 'tsf-pt',
+					'name' => 'pt',
+				];
+				$deps = [ 'tsf', 'tsf-ays', 'wp-util' ];
+			}
 		}
 
+		$tmpl_file = $is_list_edit
+			? Template::get_view_location( 'templates/list/primary-term-selector' )
+			: Template::get_view_location( 'templates/inpost/primary-term-selector' );
+
 		return [
 			[
 				'id'       => 'tsf-pt',
@@ -879,7 +896,7 @@ public static function get_primaryterm_scripts() {
 					],
 				],
 				'tmpl'     => [
-					'file' => Template::get_view_location( 'templates/inpost/primary-term-selector' ),
+					'file' => $tmpl_file,
 				],
 			],
 		];

inc/classes/admin/settings/listedit.class.php

@@ -256,6 +256,8 @@ public function output_column_contents_for_post( $column_name, $post_id ) {
 			HTML::make_data_attributes( [ 'le' => $data ] )
 		);
 
+		$primary_terms = [];
+
 		if ( $is_homepage ) {
 			// When the homepage title is set, we can safely get the custom field.
 			$_has_home_title     = (bool) \strlen( Data\Plugin::get_option( 'homepage_title' ) );
@@ -281,6 +283,8 @@ public function output_column_contents_for_post( $column_name, $post_id ) {
 
 			$permastruct               = Meta\URI\Utils::get_url_permastruct( $generator_args );
 			$is_post_type_hierarchical = false; // Homepage cannot have a parent page.
+
+			$primary_terms = []; // Homepage cannot have terms -- at least... why would anyone.
 		} else {
 			static $memo = [];
 
@@ -298,7 +302,7 @@ public function output_column_contents_for_post( $column_name, $post_id ) {
 			$is_canonical_ref_locked = false;
 			$default_canonical       = Meta\URI::get_generated_url( $generator_args );
 
-			$memo['post_type']                 ??= Query::get_admin_post_type();
+			$memo['post_type']                 ??= Query::get_post_type_real_id( $post_id );
 			$memo['permastruct']               ??= Meta\URI\Utils::get_url_permastruct( $generator_args );
 			$memo['is_post_type_hierarchical'] ??= \is_post_type_hierarchical( $memo['post_type'] );
 
@@ -321,25 +325,30 @@ public function output_column_contents_for_post( $column_name, $post_id ) {
 			}
 
 			// Only hierarchical taxonomies can be used in the URL.
-			// TODO filter post_tag here.
-			$memo['taxonomies'] ??= $post_type ? Taxonomy::get_hierarchical( 'names', $post_type ) : [];
+			$memo['taxonomies'] ??= array_diff(
+				$post_type ? Taxonomy::get_hierarchical( 'names', $post_type ) : [],
+				// post_tag isn't hierarchical by default, but it can be filtered to be.
+				// It's broken in Core when used in the permastruct. Nobody should be using %post_tag%.
+				[ 'post_tag' ],
+			);
 
 			$taxonomies               = $memo['taxonomies'];
 			$parent_term_slugs_by_tax = [];
+			$primary_term_ids         = [];
+
+			// Store primary term IDs for later use.
+			foreach ( $taxonomies as $taxonomy )
+				$primary_term_ids[ $taxonomy ] = Data\Plugin\Post::get_primary_term_id( $post_id, $taxonomy );
 
 			// Yes, on its surface, this is a very expensive procedure.
 			// However, WordPress needs to walk all the terms already to create the post links.
 			// Hence, it ought to net to zero impact.
 			foreach ( $taxonomies as $taxonomy ) {
 				if ( str_contains( $permastruct, "%$taxonomy%" ) ) {
-					// Broken in Core. Skip writing cache. We may reach this line 200 times, but nobody should be using %post_tag% anyway.
-					if ( 'post_tag' === $taxonomy ) continue;
-
-					$parent_term_slugs_by_tax[ $taxonomy ] = [];
 					// There's no need to test for hierarchy, because we want the full structure anyway (third parameter).
 					foreach (
 						Data\Term::get_term_parents(
-							Data\Plugin\Post::get_primary_term_id( $post_id, $taxonomy ),
+							$primary_term_ids[ $taxonomy ],
 							$taxonomy,
 							true,
 						)
@@ -367,6 +376,14 @@ public function output_column_contents_for_post( $column_name, $post_id ) {
 					];
 				}
 			}
+
+			foreach ( $taxonomies as $taxonomy ) {
+				$primary_terms[ "primary_term_{$taxonomy}" ] = [
+					'value'    => $primary_term_ids[ $taxonomy ] ?? 0,
+					'isSelect' => true,
+					'taxonomy' => $taxonomy,
+				];
+			}
 		}
 
 		printf(
@@ -376,7 +393,8 @@ public function output_column_contents_for_post( $column_name, $post_id ) {
 			// phpcs:disable WordPress.Security.EscapeOutput -- make_data_attributes escapes.
 			HTML::make_data_attributes( [
 				'lePostData' => [
-					'isFront' => Query::is_static_front_page( $generator_args['id'] ),
+					'isFront'      => Query::is_static_front_page( $generator_args['id'] ),
+					'primaryTerms' => $primary_terms,
 				],
 			] ),
 			// phpcs:enable WordPress.Security.EscapeOutput

inc/classes/data/admin/post.class.php

@@ -90,16 +90,14 @@ public static function update_meta( $post_id ) {
 	 *              2. Now allows updating during `WP_AJAX`.
 	 * @since 5.0.0 1. Moved from `\The_SEO_Framework\Load`.
 	 *              2. Renamed from `_save_inpost_primary_term`.
+	 * @since 5.1.3 Now supports quick-edit and bulk-edit.
 	 *
 	 * @param int $post_id The post ID.
 	 * @return void
 	 */
 	public static function update_primary_term( $post_id ) {
 
-		// The 'autodescription' index should only be used when using the editor.
-		// Quick and bulk-edit should be halted here.
-		if ( empty( $_POST['autodescription'] ) ) return;
-
+		// This resolves a quirk, since wp_insert_post() has no proper guard.
 		$post_id = \get_post( $post_id )->ID ?? null;
 
 		if ( empty( $post_id ) ) return;
@@ -113,25 +111,70 @@ public static function update_primary_term( $post_id ) {
 		 */
 		if ( \wp_is_post_autosave( $post_id ) || \wp_is_post_revision( $post_id ) ) return;
 
-		// Check that the user is allowed to edit the post. Nonce checks are done in bulk later.
 		if ( ! \current_user_can( 'edit_post', $post_id ) ) return;
 
-		$post_type = \get_post_type( $post_id ) ?: false;
+		$post_type = \get_post_type( $post_id );
 		// Can this even fail?
 		if ( empty( $post_type ) ) return;
 
-		foreach ( Taxonomy::get_hierarchical( 'names', $post_type ) as $taxonomy ) {
-			// Redundant. Fortified.
-			if ( ! \wp_verify_nonce(
-				$_POST[ static::$nonce_name . "_pt_{$taxonomy}" ] ?? '', // If empty, wp_verify_nonce will return false.
-				static::$nonce_action . '_pt',
-			) ) continue;
-
-			Data\Plugin\Post::update_primary_term_id(
-				$post_id,
-				$taxonomy,
-				\absint( $_POST['autodescription'][ "_primary_term_{$taxonomy}" ] ?? 0 ),
-			);
+		// Determine edit type: post-edit, quick-edit, or bulk-edit
+		if ( ! empty( $_POST['autodescription'] ) ) {
+			// Post-edit
+			foreach ( Taxonomy::get_hierarchical( 'names', $post_type ) as $taxonomy ) {
+				if ( ! \wp_verify_nonce(
+					$_POST[ static::$nonce_name . "_pt_{$taxonomy}" ] ?? '',
+					static::$nonce_action . '_pt',
+				) ) continue;
+
+				Data\Plugin\Post::update_primary_term_id(
+					$post_id,
+					$taxonomy,
+					\absint( $_POST['autodescription'][ "_primary_term_{$taxonomy}" ] ?? 0 ),
+				);
+			}
+		} elseif ( ! empty( $_POST['autodescription-quick'] ) ) {
+			// Quick-edit
+			if ( ! \check_ajax_referer( 'inlineeditnonce', '_inline_edit', false ) ) return;
+
+			foreach ( Taxonomy::get_hierarchical( 'names', $post_type ) as $taxonomy ) {
+				if ( ! isset( $_POST['autodescription-quick'][ "primary_term_{$taxonomy}" ] ) ) continue;
+
+				$term_id = \absint( \wp_unslash( $_POST['autodescription-quick'][ "primary_term_{$taxonomy}" ] ) );
+
+				if ( $term_id > 0 )
+					Data\Plugin\Post::update_primary_term_id( $post_id, $taxonomy, $term_id );
+			}
+		} elseif ( ! empty( $_REQUEST['autodescription-bulk'] ) ) {
+			// Bulk-edit
+			static $verified_bulk_referer = false;
+
+			if ( ! $verified_bulk_referer ) {
+				\check_admin_referer( 'bulk-posts' );
+				$verified_bulk_referer = true;
+			}
+
+			foreach ( Taxonomy::get_hierarchical( 'names', $post_type ) as $taxonomy ) {
+				if ( ! isset( $_REQUEST['autodescription-bulk'][ "primary_term_{$taxonomy}" ] ) ) continue;
+
+				$value = $_REQUEST['autodescription-bulk'][ "primary_term_{$taxonomy}" ];
+
+				if ( 'nochange' === $value ) continue;
+
+				$term_id = \absint( $value );
+
+				if ( $term_id > 0 ) {
+					$terms = \get_the_terms( $post_id, $taxonomy );
+
+					if ( $terms && ! \is_wp_error( $terms ) ) {
+						$valid_term_ids = \array_column( $terms, 'term_id' );
+
+						if ( \in_array( $term_id, $valid_term_ids, true ) )
+							Data\Plugin\Post::update_primary_term_id( $post_id, $taxonomy, $term_id );
+					}
+				} else {
+					Data\Plugin\Post::update_primary_term_id( $post_id, $taxonomy, 0 );
+				}
+			}
 		}
 	}
 
@@ -221,6 +264,7 @@ private static function update_via_quick_edit( $post_id ) {
 
 				case 'canonical':
 					$new_data['_genesis_canonical_uri'] = $value;
+					break;
 			}
 		}
 

inc/classes/helper/query.class.php

@@ -419,6 +419,7 @@ public static function is_post_edit() {
 	 *
 	 * @since 2.6.0
 	 * @since 5.0.0 Moved from `\The_SEO_Framework\Load`.
+	 * @todo should be renamed to is_list_edit()
 	 * @global \WP_Screen $current_screen
 	 *
 	 * @return bool We're on the edit screen.

inc/classes/meta/robots/factory.class.php

@@ -73,8 +73,10 @@ class Factory {
 	 * @return Factory $this
 	 */
 	public function set( $args = null, $options = 0 ) {
+
 		static::$args    = $args;
 		static::$options = $options;
+
 		return $this;
 	}
 
@@ -86,6 +88,7 @@ public function set( $args = null, $options = 0 ) {
 	 * @generator
 	 */
 	public static function generator() {
+
 		// phpcs:ignore Generic.CodeAnalysis.AssignmentInCondition.Found -- Shhh. It's OK.
 		while ( true ) switch ( $sender = yield static::START ) {
 			case 'noindex':

inc/classes/meta/robots/front.class.php

@@ -98,7 +98,7 @@ protected static function assert_no( $type ) {
 			}
 		}
 
-		globals:
+		globals: {
 			yield 'globals_site' => (bool) Data\Plugin::get_option( "site_$type" );
 
 			if ( Query::is_real_front_page() ) {
@@ -134,6 +134,7 @@ protected static function assert_no( $type ) {
 			} elseif ( Query::is_singular() ) {
 				yield 'globals_post_type' => Robots::is_post_type_robots_set( $type, Query::get_current_post_type() );
 			}
+		}
 
 		// We assert options here for a jump to index_protection might be unaware.
 		index_protection: if ( $asserting_noindex && ! ( static::$options & ROBOTS_IGNORE_PROTECTION ) ) {
@@ -170,6 +171,7 @@ protected static function assert_no( $type ) {
 	 * @param string $pass The passage to assert.
 	 */
 	private static function assert_noindex_query_pass( $pass ) {
+
 		switch ( $pass ) {
 			case 'paged_home':
 				yield 'paged_home' =>

inc/classes/meta/robots/main.class.php

@@ -141,7 +141,7 @@ public function get( $get = null ) {
 		$start     = $factory::START;
 		$generator = $factory->set(
 			$this->args,
-			$options
+			$options,
 		)::generator();
 
 		$results = [];

inc/views/post/settings.php

@@ -561,15 +561,16 @@
 				}
 
 				// Only hierarchical taxonomies can be used in the URL.
-				// TODO filter post_tag here.
-				$taxonomies               = $post_type ? Taxonomy::get_hierarchical( 'names', $post_type ) : [];
+				$taxonomies = array_diff(
+					$post_type ? Taxonomy::get_hierarchical( 'names', $post_type ) : [],
+					// post_tag isn't hierarchical by default, but it can be filtered to be.
+					// It's broken in Core when used in the permastruct. Nobody should be using %post_tag%.
+					[ 'post_tag' ],
+				);
 				$parent_term_slugs_by_tax = [];
 
 				foreach ( $taxonomies as $taxonomy ) {
 					if ( str_contains( $permastruct, "%$taxonomy%" ) ) {
-						// Broken in Core. Skip.
-						if ( 'post_tag' === $taxonomy ) continue;
-
 						// There's no need to test for hierarchy, because we want the full structure anyway (third parameter).
 						foreach (
 							Data\Term::get_term_parents(

inc/views/templates/list/index.php

@@ -0,0 +1,6 @@
+<?php
+/**
+ * Art is the elimination of the unnecessary.
+ *
+ * - Pablo Ruiz Picasso
+ */