Changeset 44497 for trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-term.php

Timestamp:

01/09/2019 05:43:14 AM (6 years ago)

Author:

pento

Message:

Docs: Add docblocks for the PHPUnit factory objects.

Props andizer.
Fixes #44521.

File:

• trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-term.php (modified) (5 diffs)

trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-term.php

@@ -25 +25 @@
     }
 
+    /**
+     * Creates a term object.
+     *
+     * @param array $args Array or string of arguments for inserting a term.
+     *
+     * @return array|WP_Error
+     */
     function create_object( $args ) {
         $args         = array_merge( array( 'taxonomy' => $this->taxonomy ), $args );
@@ -34 +41 @@
     }
 
+    /**
+     * Updates the term.
+     *
+     * @param int|object   $term   The term to update.
+     * @param array|string $fields The context in which to relate the term to the object.
+     *
+     * @return int The term id.
+     */
     function update_object( $term, $fields ) {
         $fields = array_merge( array( 'taxonomy' => $this->taxonomy ), $fields );
@@ -43 +58 @@
     }
 
+    /**
+     * Attach terms on the given post.
+     *
+     * @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.
+     */
     function add_post_terms( $post_id, $terms, $taxonomy, $append = true ) {
         return wp_set_post_terms( $post_id, $terms, $taxonomy, $append );
@@ -48 +77 @@
 
     /**
-     * @return array|null|WP_Error|WP_Term
+     * Create a term and returns it as a object.
+     *
+     * @param array $args                   Array or string of arguments for inserting a term.
+     * @param null  $generation_definitions The default values.
+     *
+     * @return null|WP_Error|WP_Term WP_Term on success. WP_error if taxonomy does not exist. Null for miscellaneous failure.
      */
     function create_and_get( $args = array(), $generation_definitions = null ) {
@@ -56 +90 @@
     }
 
+    /**
+     * Retrieves the term by given term id.
+     *
+     * @param int $term_id The term id to retrieve.
+     *
+     * @return null|WP_Error|WP_Term WP_Term on success. WP_error if taxonomy does not exist. Null for miscellaneous failure.
+     */
     function get_object_by_id( $term_id ) {
         return get_term( $term_id, $this->taxonomy );