mirror of
https://github.com/gosticks/wordpress-develop.git
synced 2026-05-29 15:44:27 +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
75 lines
2.1 KiB
PHP
75 lines
2.1 KiB
PHP
<?php
|
|
|
|
/**
|
|
* Factory for creating fixtures for the deprecated Links/Bookmarks API.
|
|
*
|
|
* 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.
|
|
*
|
|
* @since 4.6.0
|
|
*
|
|
* @method int|WP_Error create( $args = array(), $generation_definitions = null )
|
|
* @method object|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_Bookmark extends WP_UnitTest_Factory_For_Thing {
|
|
|
|
public function __construct( $factory = null ) {
|
|
parent::__construct( $factory );
|
|
$this->default_generation_definitions = array(
|
|
'link_name' => new WP_UnitTest_Generator_Sequence( 'Bookmark name %s' ),
|
|
'link_url' => new WP_UnitTest_Generator_Sequence( 'Bookmark URL %s' ),
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Creates a link object.
|
|
*
|
|
* @since 4.6.0
|
|
* @since 6.2.0 Returns a WP_Error object on failure.
|
|
*
|
|
* @param array $args Arguments for the link object.
|
|
*
|
|
* @return int|WP_Error The link ID on success, WP_Error object on failure.
|
|
*/
|
|
public function create_object( $args ) {
|
|
return wp_insert_link( $args, true );
|
|
}
|
|
|
|
/**
|
|
* Updates a link object.
|
|
*
|
|
* @since 4.6.0
|
|
* @since 6.2.0 Returns a WP_Error object on failure.
|
|
*
|
|
* @param int $link_id ID of the link to update.
|
|
* @param array $fields The fields to update.
|
|
*
|
|
* @return int|WP_Error The link ID on success, WP_Error object on failure.
|
|
*/
|
|
public function update_object( $link_id, $fields ) {
|
|
$fields['link_id'] = $link_id;
|
|
|
|
$result = wp_update_link( $fields );
|
|
|
|
if ( 0 === $result ) {
|
|
return new WP_Error( 'link_update_error', __( 'Could not update link.' ) );
|
|
}
|
|
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* Retrieves a link by a given ID.
|
|
*
|
|
* @since 4.6.0
|
|
*
|
|
* @param int $link_id ID of the link to retrieve.
|
|
*
|
|
* @return object|null The link object on success, null on failure.
|
|
*/
|
|
public function get_object_by_id( $link_id ) {
|
|
return get_bookmark( $link_id );
|
|
}
|
|
}
|