1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
<?php
/**
* Unit test factory for terms.
*
* Note: The below @method notations are defined solely for the benefit of IDEs,
* as a way to indicate expected return values from the given factory methods.
*
* @method int|WP_Error create( $args = array(), $generation_definitions = null )
* @method WP_Term|WP_Error|null create_and_get( $args = array(), $generation_definitions = null )
* @method (int|WP_Error)[] create_many( $count, $args = array(), $generation_definitions = null )
*/
class WP_UnitTest_Factory_For_Term extends WP_UnitTest_Factory_For_Thing {
private $taxonomy;
const DEFAULT_TAXONOMY = 'post_tag';
public function __construct( $factory = null, $taxonomy = null ) {
parent::__construct( $factory );
$this->taxonomy = $taxonomy ? $taxonomy : self::DEFAULT_TAXONOMY;
$this->default_generation_definitions = array(
'name' => new WP_UnitTest_Generator_Sequence( 'Term %s' ),
'taxonomy' => $this->taxonomy,
'description' => new WP_UnitTest_Generator_Sequence( 'Term description %s' ),
);
}
/**
* Creates a term object.
*
* @since UT (3.7.0)
*
* @param array $args Array of arguments for inserting a term.
*
* @return int|WP_Error The term ID on success, WP_Error object on failure.
*/
public function create_object( $args ) {
$args = array_merge( array( 'taxonomy' => $this->taxonomy ), $args );
$term_id_pair = wp_insert_term( $args['name'], $args['taxonomy'], $args );
if ( is_wp_error( $term_id_pair ) ) {
return $term_id_pair;
}
return $term_id_pair['term_id'];
}
/**
* Updates the term.
*
* @since UT (3.7.0)
* @since 6.2.0 Returns a WP_Error object on failure.
*
* @param int|object $term The term to update.
* @param array $fields Array of arguments for updating a term.
*
* @return int|WP_Error The term ID on success, WP_Error object on failure.
*/
public function update_object( $term, $fields ) {
$fields = array_merge( array( 'taxonomy' => $this->taxonomy ), $fields );
if ( is_object( $term ) ) {
$taxonomy = $term->taxonomy;
}
$term_id_pair = wp_update_term( $term, $taxonomy, $fields );
if ( is_wp_error( $term_id_pair ) ) {
return $term_id_pair;
}
return $term_id_pair['term_id'];
}
/**
* Attach terms to the given post.
*
* @since UT (3.7.0)
*
* @param int $post_id The post ID.
* @param string|array $terms An array of terms to set for the post, or a string of terms
* separated by commas. Hierarchical taxonomies must always pass IDs rather
* than names so that children with the same names but different parents
* aren't confused.
* @param string $taxonomy Taxonomy name.
* @param bool $append Optional. If true, don't delete existing terms, just add on. If false,
* replace the terms with the new terms. Default true.
*
* @return array|false|WP_Error Array of term taxonomy IDs of affected terms. WP_Error or false on failure.
*/
public function add_post_terms( $post_id, $terms, $taxonomy, $append = true ) {
return wp_set_post_terms( $post_id, $terms, $taxonomy, $append );
}
/**
* Create a term and returns it as an object.
*
* @since 4.3.0
*
* @param array $args Array or string of arguments for inserting a term.
* @param null $generation_definitions The default values.
*
* @return WP_Term|WP_Error|null WP_Term on success. WP_Error if taxonomy does not exist. Null for miscellaneous failure.
*/
public function create_and_get( $args = array(), $generation_definitions = null ) {
$term_id = $this->create( $args, $generation_definitions );
if ( is_wp_error( $term_id ) ) {
return $term_id;
}
$taxonomy = isset( $args['taxonomy'] ) ? $args['taxonomy'] : $this->taxonomy;
return get_term( $term_id, $taxonomy );
}
/**
* Retrieves the term by a given ID.
*
* @since UT (3.7.0)
*
* @param int $term_id ID of the term to retrieve.
*
* @return WP_Term|WP_Error|null WP_Term on success. WP_Error if taxonomy does not exist. Null for miscellaneous failure.
*/
public function get_object_by_id( $term_id ) {
return get_term( $term_id, $this->taxonomy );
}
}
|
