11<?php
22/**
3- * Primary_Term_Rest class file
3+ * Create WordPress Plugin Features: Primary_Term_Rest class
44 *
55 * @package create-wordpress-plugin
66 */
77
88namespace Create_WordPress_Plugin \Features ;
9- use function Create_WordPress_Plugin \register_meta_helper ;
109
1110use Alley \WP \Types \Feature ;
11+ use WP_Term ;
1212
13+ /**
14+ * Feature: Adds a REST API field for the primary term.
15+ *
16+ * @package create-wordpress-plugin
17+ */
1318final class Primary_Term_Rest implements Feature {
1419 /**
1520 * Set up.
1621 *
17- * @param array $taxonomies The taxonomies to support primary term for.
22+ * @param string[] $taxonomies The taxonomies to support primary term for.
1823 */
1924 public function __construct (
2025 private readonly array $ taxonomies'category ' ],
@@ -28,18 +33,17 @@ public function boot(): void {
2833 }
2934
3035 /**
31- * Adds support for subheadline to the `post` post type.
32- * Registers the meta field only for post types that support subheadline.
36+ * Adds the create_wordpress_plugin_primary_term field to the REST API to return the primary term for a post.
3337 */
34- public function register_rest_field () {
38+ public function register_rest_field (): void {
3539 register_rest_field (
3640 'post ' ,
3741 'create_wordpress_plugin_primary_term ' ,
3842 [
3943 'get_callback ' => [ $ this 'rest_callback ' ],
4044 'update_callback ' => null ,
4145 'schema ' => [
42- 'description ' => __ ( 'The primary term for the post. ' ),
46+ 'description ' => __ ( 'The primary term for the post. ' , ' create-wordpress-plugin '
4347 'type ' => [
4448 'term_name ' => 'string ' ,
4549 'term_id ' => 'integer ' ,
@@ -51,13 +55,18 @@ public function register_rest_field() {
5155 }
5256
5357 /**
54- * Callback functionf for the rest field.
58+ * Callback function for the REST field.
59+ *
60+ * @param array $request The REST request.
61+ *
62+ * @phpstan-param array{id: int} $request
5563 *
56- * @param \WP_REST_Reqest $request The rest request.
57- * @return array
64+ * @return array An array containing taxonomy slugs as keys with term objects as values.
65+ *
66+ * @phpstan-return array<string, array{term_name?: string, term_id?: int, term_link?: string}>
5867 */
59- public function rest_callback ( $ request
60- $ output
68+ public function rest_callback ( array $ request: array {
69+ $ output = [];
6170 $ post_id$ request'id ' ];
6271 foreach ( $ this taxonomies as $ taxonomy
6372 $ output$ taxonomy$ this get_primary_term ( $ post_id$ taxonomy
@@ -66,39 +75,46 @@ public function rest_callback( $request ) {
6675 }
6776
6877 /**
69- * Gets the primary term for the post.
78+ * Gets the primary term for the post for a given taxonomy .
7079 *
71- * @param int $post_id The post id.
80+ * @param int $post_id The post id.
7281 * @param string $taxonomy The taxonomy to get the primary term for.
73- * @return array
82+ *
83+ * @return array An array containing the term name, ID, and link.
84+ *
85+ * @phpstan-return array{term_name?: string, term_id?: int, term_link?: string}
7486 */
75- public function get_primary_term ( $ post_id$ taxonomy
87+ public function get_primary_term ( int $ post_idstring $ taxonomyarray {
88+ $ term
7689 if ( function_exists ( 'yoast_get_primary_term_id ' ) ) {
7790 $ primary_term_idyoast_get_primary_term_id ( $ taxonomy$ post_id
7891 }
7992 if ( empty ( $ primary_term_id
8093 $ termsget_the_terms ( $ post_id$ taxonomy
81- if ( ! empty ( $ terms
94+ if ( ! empty ( $ terms[ 0 ]-> term_id ) ) {
8295 $ primary_term_id$ terms0 ]->term_id ;
8396 }
8497 }
85- if ( empty ( $ primary_term_id
86- $ term
87- } else {
98+ if ( ! empty ( $ primary_term_id
8899 $ primary_termget_term ( $ primary_term_id$ taxonomy
89- $ term
90- 'term_name ' => $ primary_termname ,
91- 'term_id ' => $ primary_termterm_id ,
92- 'term_link ' => get_term_link ( $ primary_term
93- ];
100+ if ( $ primary_terminstanceof WP_Term ) {
101+ $ term_linkget_term_link ( $ primary_term
102+ $ term
103+ 'term_name ' => $ primary_termname ,
104+ 'term_id ' => $ primary_termterm_id ,
105+ 'term_link ' => ! is_wp_error ( $ term_link$ term_link'' ,
106+ ];
107+ }
94108 }
95109 /**
96110 * Filters the primary term for the post.
97111 *
98112 * @param array $term The primary term for the post.
99113 * @param int $id The post ID.
100114 * @param string $taxonomy The taxonomy.
115+ *
116+ * @phpstan-param array{term_name?: string, term_id?: int, term_link?: string} $term
101117 */
102- return \ apply_filters'create_wordpress_plugin_primary_term ' , $ term$ post_id$ taxonomy
118+ return apply_filters ( 'create_wordpress_plugin_primary_term ' , $ term$ post_id$ taxonomy
103119 }
104120}
0 commit comments