Make WordPress Core


Ignore:
Timestamp:
12/28/2022 02:07:16 PM (18 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-bookmark.php

    r46586 r55019  
    99 * @since 4.6.0
    1010 *
    11  * @method int create( $args = array(), $generation_definitions = null )
    12  * @method object create_and_get( $args = array(), $generation_definitions = null )
    13  * @method int[] create_many( $count, $args = array(), $generation_definitions = null )
     11 * @method int|WP_Error    create( $args = array(), $generation_definitions = null )
     12 * @method object|WP_Error create_and_get( $args = array(), $generation_definitions = null )
     13 * @method (int|WP_Error)[] create_many( $count, $args = array(), $generation_definitions = null )
    1414 */
    1515class WP_UnitTest_Factory_For_Bookmark extends WP_UnitTest_Factory_For_Thing {
     
    2323    }
    2424
     25    /**
     26     * Creates a link object.
     27     *
     28     * @since 4.6.0
     29     * @since 6.2.0 Returns a WP_Error object on failure.
     30     *
     31     * @param array $args Arguments for the link object.
     32     *
     33     * @return int|WP_Error The link ID on success, WP_Error object on failure.
     34     */
    2535    public function create_object( $args ) {
    26         return wp_insert_link( $args );
     36        return wp_insert_link( $args, true );
    2737    }
    2838
     39    /**
     40     * Updates a link object.
     41     *
     42     * @since 4.6.0
     43     * @since 6.2.0 Returns a WP_Error object on failure.
     44     *
     45     * @param int   $link_id ID of the link to update.
     46     * @param array $fields  The fields to update.
     47     *
     48     * @return int|WP_Error The link ID on success, WP_Error object on failure.
     49     */
    2950    public function update_object( $link_id, $fields ) {
    3051        $fields['link_id'] = $link_id;
    31         return wp_update_link( $fields );
     52
     53        $result = wp_update_link( $fields );
     54
     55        if ( 0 === $result ) {
     56            return new WP_Error( 'link_update_error', __( 'Could not update link.' ) );
     57        }
     58
     59        return $result;
    3260    }
    3361
     62    /**
     63     * Retrieves a link by a given ID.
     64     *
     65     * @since 4.6.0
     66     *
     67     * @param int $link_id ID of the link to retrieve.
     68     *
     69     * @return object|null The link object on success, null on failure.
     70     */
    3471    public function get_object_by_id( $link_id ) {
    3572        return get_bookmark( $link_id );
Note: See TracChangeset for help on using the changeset viewer.