mirror of
https://github.com/gosticks/wordpress-develop.git
synced 2026-05-25 13:44:30 +00:00
d0fc6ddc71
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. git-svn-id: https://develop.svn.wordpress.org/trunk@55019 602fd350-edb4-49c9-b593-d223f7449a82
65 lines
1.8 KiB
PHP
65 lines
1.8 KiB
PHP
<?php
|
|
|
|
/**
|
|
* Unit test factory for users.
|
|
*
|
|
* 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_User|WP_Error 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_User extends WP_UnitTest_Factory_For_Thing {
|
|
|
|
public function __construct( $factory = null ) {
|
|
parent::__construct( $factory );
|
|
$this->default_generation_definitions = array(
|
|
'user_login' => new WP_UnitTest_Generator_Sequence( 'User %s' ),
|
|
'user_pass' => 'password',
|
|
'user_email' => new WP_UnitTest_Generator_Sequence( 'user_%s@example.org' ),
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Inserts an user.
|
|
*
|
|
* @since UT (3.7.0)
|
|
*
|
|
* @param array $args The user data to insert.
|
|
*
|
|
* @return int|WP_Error The user ID on success, WP_Error object on failure.
|
|
*/
|
|
public function create_object( $args ) {
|
|
return wp_insert_user( $args );
|
|
}
|
|
|
|
/**
|
|
* Updates the user data.
|
|
*
|
|
* @since UT (3.7.0)
|
|
*
|
|
* @param int $user_id ID of the user to update.
|
|
* @param array $fields The user data to update.
|
|
*
|
|
* @return int|WP_Error The user ID on success, WP_Error object on failure.
|
|
*/
|
|
public function update_object( $user_id, $fields ) {
|
|
$fields['ID'] = $user_id;
|
|
return wp_update_user( $fields );
|
|
}
|
|
|
|
/**
|
|
* Retrieves the user for a given ID.
|
|
*
|
|
* @since UT (3.7.0)
|
|
*
|
|
* @param int $user_id ID of the user ID to retrieve.
|
|
*
|
|
* @return WP_User The user object.
|
|
*/
|
|
public function get_object_by_id( $user_id ) {
|
|
return new WP_User( $user_id );
|
|
}
|
|
}
|