Make WordPress Core


Ignore:
Timestamp:
12/28/2022 02:07:16 PM (19 months ago)
Author:
SergeyBiryukov
Message:

Tests: Bring some consistency to creating and updating objects in factory classes.

In various unit test factory classes, some of the create_object() and update_object() methods returned a WP_Error object on failure, while a few others were documented to do so, but did not in practice, instead returning the value 0 or false, or not accounting for a failure at all.

This commit aims to handle this in a consistent way by updating the methods to always return the object ID on success and a WP_Error object on failure.

Includes:

  • Updating and correcting the relevant documentation parts.
  • Adding missing documentation and @since tags in some classes.
  • Renaming some variables to clarify that it is the object ID which is passed around, not the object itself.

Follow-up to [760/tests], [838/tests], [922/tests], [948/tests], [985/tests], [27178], [32659], [34855], [37563], [40968], [44497], [46262].

See #56793.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-network.php

    r46831 r55019  
    77 * as a way to indicate expected return values from the given factory methods.
    88 *
    9  * @method int create( $args = array(), $generation_definitions = null )
    10  * @method WP_Network create_and_get( $args = array(), $generation_definitions = null )
    11  * @method int[] create_many( $count, $args = array(), $generation_definitions = null )
     9 * @method int|WP_Error        create( $args = array(), $generation_definitions = null )
     10 * @method WP_Network|WP_Error create_and_get( $args = array(), $generation_definitions = null )
     11 * @method (int|WP_Error)[]    create_many( $count, $args = array(), $generation_definitions = null )
    1212 */
    1313class WP_UnitTest_Factory_For_Network extends WP_UnitTest_Factory_For_Thing {
     
    2424    }
    2525
     26    /**
     27     * Creates a network object.
     28     *
     29     * @since 3.9.0
     30     * @since 6.2.0 Returns a WP_Error object on failure.
     31     *
     32     * @param array $args Arguments for the network object.
     33     *
     34     * @return int|WP_Error The network ID on success, WP_Error object on failure.
     35     */
    2636    public function create_object( $args ) {
    2737        require_once ABSPATH . 'wp-admin/includes/upgrade.php';
     
    3343        }
    3444
    35         populate_network( $args['network_id'], $args['domain'], $email, $args['title'], $args['path'], $args['subdomain_install'] );
     45        $result = populate_network(
     46            $args['network_id'],
     47            $args['domain'],
     48            $email,
     49            $args['title'],
     50            $args['path'],
     51            $args['subdomain_install']
     52        );
     53
     54        if ( is_wp_error( $result ) ) {
     55            return $result;
     56        }
     57
    3658        return (int) $args['network_id'];
    3759    }
    3860
     61    /**
     62     * Updates a network object. Not implemented.
     63     *
     64     * @since 3.9.0
     65     *
     66     * @param int   $network_id ID of the network to update.
     67     * @param array $fields  The fields to update.
     68     *
     69     * @return void
     70     */
    3971    public function update_object( $network_id, $fields ) {}
    4072
     73    /**
     74     * Retrieves a network by a given ID.
     75     *
     76     * @since 3.9.0
     77     *
     78     * @param int $network_id ID of the network to retrieve.
     79     *
     80     * @return WP_Network|null The network object on success, null on failure.
     81     */
    4182    public function get_object_by_id( $network_id ) {
    4283        return get_network( $network_id );
Note: See TracChangeset for help on using the changeset viewer.