<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[55019] trunk/tests/phpunit: Tests: Bring some consistency to creating and updating objects in factory classes.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/55019">55019</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/55019","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2022-12-28 14:07:16 +0000 (Wed, 28 Dec 2022)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>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], <a href="https://core.trac.wordpress.org/changeset/27178">[27178]</a>, <a href="https://core.trac.wordpress.org/changeset/32659">[32659]</a>, <a href="https://core.trac.wordpress.org/changeset/34855">[34855]</a>, <a href="https://core.trac.wordpress.org/changeset/37563">[37563]</a>, <a href="https://core.trac.wordpress.org/changeset/40968">[40968]</a>, <a href="https://core.trac.wordpress.org/changeset/44497">[44497]</a>, <a href="https://core.trac.wordpress.org/changeset/46262">[46262]</a>.
See <a href="https://core.trac.wordpress.org/ticket/56793">#56793</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunktestsphpunitincludesabstracttestcasephp">trunk/tests/phpunit/includes/abstract-testcase.php</a></li>
<li><a href="#trunktestsphpunitincludesfactoryclasswpunittestfactorycallbackaftercreatephp">trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-callback-after-create.php</a></li>
<li><a href="#trunktestsphpunitincludesfactoryclasswpunittestfactoryforattachmentphp">trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-attachment.php</a></li>
<li><a href="#trunktestsphpunitincludesfactoryclasswpunittestfactoryforblogphp">trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-blog.php</a></li>
<li><a href="#trunktestsphpunitincludesfactoryclasswpunittestfactoryforbookmarkphp">trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-bookmark.php</a></li>
<li><a href="#trunktestsphpunitincludesfactoryclasswpunittestfactoryforcommentphp">trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-comment.php</a></li>
<li><a href="#trunktestsphpunitincludesfactoryclasswpunittestfactoryfornetworkphp">trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-network.php</a></li>
<li><a href="#trunktestsphpunitincludesfactoryclasswpunittestfactoryforpostphp">trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-post.php</a></li>
<li><a href="#trunktestsphpunitincludesfactoryclasswpunittestfactoryfortermphp">trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-term.php</a></li>
<li><a href="#trunktestsphpunitincludesfactoryclasswpunittestfactoryforthingphp">trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-thing.php</a></li>
<li><a href="#trunktestsphpunitincludesfactoryclasswpunittestfactoryforuserphp">trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-user.php</a></li>
<li><a href="#trunktestsphpunittestspostwpInsertPostphp">trunk/tests/phpunit/tests/post/wpInsertPost.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunktestsphpunitincludesabstracttestcasephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/includes/abstract-testcase.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/includes/abstract-testcase.php 2022-12-27 12:21:35 UTC (rev 55018)
+++ trunk/tests/phpunit/includes/abstract-testcase.php 2022-12-28 14:07:16 UTC (rev 55019)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1522,10 +1522,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Creates an attachment post from an uploaded file.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.4.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 6.2.0 Returns a WP_Error object on failure.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $upload Array of information about the uploaded file, provided by wp_upload_bits().
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $parent_post_id Optional. Parent post ID.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return int|WP_Error The attachment ID on success. The value 0 or WP_Error on failure.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return int|WP_Error The attachment ID on success, WP_Error object on failure.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function _make_attachment( $upload, $parent_post_id = 0 ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $type = '';
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1547,9 +1548,18 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'guid' => $upload['url'],
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $id = wp_insert_attachment( $attachment, $upload['file'], $parent_post_id );
- wp_update_attachment_metadata( $id, wp_generate_attachment_metadata( $id, $upload['file'] ) );
- return $id;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $attachment_id = wp_insert_attachment( $attachment, $upload['file'], $parent_post_id, true );
+
+ if ( is_wp_error( $attachment_id ) ) {
+ return $attachment_id;
+ }
+
+ wp_update_attachment_metadata(
+ $attachment_id,
+ wp_generate_attachment_metadata( $attachment_id, $upload['file'] )
+ );
+
+ return $attachment_id;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span></span></pre></div>
<a id="trunktestsphpunitincludesfactoryclasswpunittestfactorycallbackaftercreatephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-callback-after-create.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-callback-after-create.php 2022-12-27 12:21:35 UTC (rev 55018)
+++ trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-callback-after-create.php 2022-12-28 14:07:16 UTC (rev 55019)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -10,6 +10,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * WP_UnitTest_Factory_Callback_After_Create constructor.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since UT (3.7.0)
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param callable $callback A callback function.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function __construct( $callback ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -19,11 +21,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Calls the set callback on a given object.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param mixed $object The object to apply the callback on.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since UT (3.7.0)
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return mixed The possibly altered object.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $object_id ID of the object to apply the callback on.
+ *
+ * @return mixed Updated object field.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function call( $object ) {
- return call_user_func( $this->callback, $object );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function call( $object_id ) {
+ return call_user_func( $this->callback, $object_id );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunitincludesfactoryclasswpunittestfactoryforattachmentphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-attachment.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-attachment.php 2022-12-27 12:21:35 UTC (rev 55018)
+++ trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-attachment.php 2022-12-28 14:07:16 UTC (rev 55019)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1,10 +1,23 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <?php
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/**
+ * Unit test factory for attachments.
+ *
+ * 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_Post|WP_Error create_and_get( $args = array(), $generation_definitions = null )
+ * @method (int|WP_Error)[] create_many( $count, $args = array(), $generation_definitions = null )
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> class WP_UnitTest_Factory_For_Attachment extends WP_UnitTest_Factory_For_Post {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Create an attachment fixture.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since UT (3.7.0)
+ * @since 6.2.0 Returns a WP_Error object on failure.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param array $args {
</span><span class="cx" style="display: block; padding: 0 10px"> * Array of arguments. Accepts all arguments that can be passed to
</span><span class="cx" style="display: block; padding: 0 10px"> * wp_insert_attachment(), in addition to the following:
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -14,7 +27,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $legacy_parent Deprecated.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $legacy_args Deprecated.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return int|WP_Error The attachment ID on success. The value 0 or WP_Error on failure.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return int|WP_Error The attachment ID on success, WP_Error object on failure.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function create_object( $args, $legacy_parent = 0, $legacy_args = array() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> // Backward compatibility for legacy argument format.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -33,16 +46,19 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $args
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return wp_insert_attachment( $r, $r['file'], $r['post_parent'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return wp_insert_attachment( $r, $r['file'], $r['post_parent'], true );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Saves an attachment.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.4.0
+ * @since 6.2.0 Returns a WP_Error object on failure.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $file The file name to create attachment object for.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $parent ID of the post to attach the file to.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return int|WP_Error The attachment ID on success. The value 0 or WP_Error on failure.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return int|WP_Error The attachment ID on success, WP_Error object on failure.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function create_upload_object( $file, $parent = 0 ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $contents = file_get_contents( $file );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -68,9 +84,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Save the data.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $id = wp_insert_attachment( $attachment, $upload['file'], $parent );
- wp_update_attachment_metadata( $id, wp_generate_attachment_metadata( $id, $upload['file'] ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $attachment_id = wp_insert_attachment( $attachment, $upload['file'], $parent, true );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return $id;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( is_wp_error( $attachment_id ) ) {
+ return $attachment_id;
+ }
+
+ wp_update_attachment_metadata(
+ $attachment_id,
+ wp_generate_attachment_metadata( $attachment_id, $upload['file'] )
+ );
+
+ return $attachment_id;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunitincludesfactoryclasswpunittestfactoryforblogphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-blog.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-blog.php 2022-12-27 12:21:35 UTC (rev 55018)
+++ trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-blog.php 2022-12-28 14:07:16 UTC (rev 55019)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -6,9 +6,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Note: The below @method notations are defined solely for the benefit of IDEs,
</span><span class="cx" style="display: block; padding: 0 10px"> * as a way to indicate expected return values from the given factory methods.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @method int create( $args = array(), $generation_definitions = null )
- * @method WP_Site create_and_get( $args = array(), $generation_definitions = null )
- * @method int[] create_many( $count, $args = array(), $generation_definitions = null )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @method int|WP_Error create( $args = array(), $generation_definitions = null )
+ * @method WP_Site|WP_Error create_and_get( $args = array(), $generation_definitions = null )
+ * @method (int|WP_Error)[] create_many( $count, $args = array(), $generation_definitions = null )
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> class WP_UnitTest_Factory_For_Blog extends WP_UnitTest_Factory_For_Thing {
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunktestsphpunitincludesfactoryclasswpunittestfactoryforbookmarkphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-bookmark.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-bookmark.php 2022-12-27 12:21:35 UTC (rev 55018)
+++ trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-bookmark.php 2022-12-28 14:07:16 UTC (rev 55019)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -8,9 +8,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.6.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @method int create( $args = array(), $generation_definitions = null )
- * @method object create_and_get( $args = array(), $generation_definitions = null )
- * @method int[] create_many( $count, $args = array(), $generation_definitions = null )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @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 )
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> class WP_UnitTest_Factory_For_Bookmark extends WP_UnitTest_Factory_For_Thing {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -22,15 +22,52 @@
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * 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.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> public function create_object( $args ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return wp_insert_link( $args );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return wp_insert_link( $args, true );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * 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.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> public function update_object( $link_id, $fields ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $fields['link_id'] = $link_id;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return wp_update_link( $fields );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ $result = wp_update_link( $fields );
+
+ if ( 0 === $result ) {
+ return new WP_Error( 'link_update_error', __( 'Could not update link.' ) );
+ }
+
+ return $result;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * 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.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> public function get_object_by_id( $link_id ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return get_bookmark( $link_id );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunitincludesfactoryclasswpunittestfactoryforcommentphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-comment.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-comment.php 2022-12-27 12:21:35 UTC (rev 55018)
+++ trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-comment.php 2022-12-28 14:07:16 UTC (rev 55019)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -6,9 +6,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Note: The below @method notations are defined solely for the benefit of IDEs,
</span><span class="cx" style="display: block; padding: 0 10px"> * as a way to indicate expected return values from the given factory methods.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @method int create( $args = array(), $generation_definitions = null )
- * @method WP_Comment create_and_get( $args = array(), $generation_definitions = null )
- * @method int[] create_many( $count, $args = array(), $generation_definitions = null )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @method int|WP_Error create( $args = array(), $generation_definitions = null )
+ * @method WP_Comment|WP_Error create_and_get( $args = array(), $generation_definitions = null )
+ * @method (int|WP_Error)[] create_many( $count, $args = array(), $generation_definitions = null )
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> class WP_UnitTest_Factory_For_Comment extends WP_UnitTest_Factory_For_Thing {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -25,30 +25,53 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Inserts a comment.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since UT (3.7.0)
+ * @since 6.2.0 Returns a WP_Error object on failure.
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param array $args The comment details.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return int|false The comment's ID on success, false on failure.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return int|WP_Error The comment ID on success, WP_Error object on failure.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function create_object( $args ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return wp_insert_comment( $this->addslashes_deep( $args ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ global $wpdb;
+
+ $comment_id = wp_insert_comment( $this->addslashes_deep( $args ) );
+
+ if ( false === $comment_id ) {
+ return new WP_Error(
+ 'db_insert_error',
+ __( 'Could not insert comment into the database.' ),
+ $wpdb->last_error
+ );
+ }
+
+ return $comment_id;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Updates a comment.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since UT (3.7.0)
+ * @since 6.2.0 Returns a WP_Error object on failure.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param int $comment_id The comment ID.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $fields The comment details.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return int The value 1 if the comment was updated, 0 if not updated.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return int|WP_Error The value 1 if the comment was updated, 0 if not updated.
+ * WP_Error object on failure.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function update_object( $comment_id, $fields ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $fields['comment_ID'] = $comment_id;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return wp_update_comment( $this->addslashes_deep( $fields ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return wp_update_comment( $this->addslashes_deep( $fields ), true );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Creates multiple comments on a given post.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since UT (3.7.0)
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param int $post_id ID of the post to create comments for.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $count Total amount of comments to create.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $args The comment details.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -64,6 +87,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Retrieves a comment by a given ID.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since UT (3.7.0)
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param int $comment_id ID of the comment to retrieve.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return WP_Comment|null WP_Comment object on success, null on failure.
</span></span></pre></div>
<a id="trunktestsphpunitincludesfactoryclasswpunittestfactoryfornetworkphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-network.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-network.php 2022-12-27 12:21:35 UTC (rev 55018)
+++ trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-network.php 2022-12-28 14:07:16 UTC (rev 55019)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -6,9 +6,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Note: The below @method notations are defined solely for the benefit of IDEs,
</span><span class="cx" style="display: block; padding: 0 10px"> * as a way to indicate expected return values from the given factory methods.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @method int create( $args = array(), $generation_definitions = null )
- * @method WP_Network create_and_get( $args = array(), $generation_definitions = null )
- * @method int[] create_many( $count, $args = array(), $generation_definitions = null )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @method int|WP_Error create( $args = array(), $generation_definitions = null )
+ * @method WP_Network|WP_Error create_and_get( $args = array(), $generation_definitions = null )
+ * @method (int|WP_Error)[] create_many( $count, $args = array(), $generation_definitions = null )
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> class WP_UnitTest_Factory_For_Network extends WP_UnitTest_Factory_For_Thing {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -23,6 +23,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Creates a network object.
+ *
+ * @since 3.9.0
+ * @since 6.2.0 Returns a WP_Error object on failure.
+ *
+ * @param array $args Arguments for the network object.
+ *
+ * @return int|WP_Error The network ID on success, WP_Error object on failure.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> public function create_object( $args ) {
</span><span class="cx" style="display: block; padding: 0 10px"> require_once ABSPATH . 'wp-admin/includes/upgrade.php';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -32,12 +42,43 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $email = get_userdata( $args['user'] )->user_email;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- populate_network( $args['network_id'], $args['domain'], $email, $args['title'], $args['path'], $args['subdomain_install'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $result = populate_network(
+ $args['network_id'],
+ $args['domain'],
+ $email,
+ $args['title'],
+ $args['path'],
+ $args['subdomain_install']
+ );
+
+ if ( is_wp_error( $result ) ) {
+ return $result;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> return (int) $args['network_id'];
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Updates a network object. Not implemented.
+ *
+ * @since 3.9.0
+ *
+ * @param int $network_id ID of the network to update.
+ * @param array $fields The fields to update.
+ *
+ * @return void
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> public function update_object( $network_id, $fields ) {}
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Retrieves a network by a given ID.
+ *
+ * @since 3.9.0
+ *
+ * @param int $network_id ID of the network to retrieve.
+ *
+ * @return WP_Network|null The network object on success, null on failure.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> public function get_object_by_id( $network_id ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return get_network( $network_id );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunitincludesfactoryclasswpunittestfactoryforpostphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-post.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-post.php 2022-12-27 12:21:35 UTC (rev 55018)
+++ trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-post.php 2022-12-28 14:07:16 UTC (rev 55019)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -6,9 +6,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Note: The below @method notations are defined solely for the benefit of IDEs,
</span><span class="cx" style="display: block; padding: 0 10px"> * as a way to indicate expected return values from the given factory methods.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @method int create( $args = array(), $generation_definitions = null )
- * @method WP_Post create_and_get( $args = array(), $generation_definitions = null )
- * @method int[] create_many( $count, $args = array(), $generation_definitions = null )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @method int|WP_Error create( $args = array(), $generation_definitions = null )
+ * @method WP_Post|WP_Error create_and_get( $args = array(), $generation_definitions = null )
+ * @method (int|WP_Error)[] create_many( $count, $args = array(), $generation_definitions = null )
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> class WP_UnitTest_Factory_For_Post extends WP_UnitTest_Factory_For_Thing {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -26,30 +26,38 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Creates a post object.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since UT (3.7.0)
+ * @since 6.2.0 Returns a WP_Error object on failure.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param array $args Array with elements for the post.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return int The post ID on success. The value 0 on failure.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return int|WP_Error The post ID on success, WP_Error object on failure.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function create_object( $args ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return wp_insert_post( $args );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return wp_insert_post( $args, true );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Updates an existing post object.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since UT (3.7.0)
+ * @since 6.2.0 Returns a WP_Error object on failure.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param int $post_id ID of the post to update.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $fields Post data.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return int The post ID on success. The value 0 on failure.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return int|WP_Error The post ID on success, WP_Error object on failure.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function update_object( $post_id, $fields ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $fields['ID'] = $post_id;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return wp_update_post( $fields );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return wp_update_post( $fields, true );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Retrieves a post by a given ID.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since UT (3.7.0)
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param int $post_id ID of the post to retrieve.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return WP_Post|null WP_Post object on success, null on failure.
</span></span></pre></div>
<a id="trunktestsphpunitincludesfactoryclasswpunittestfactoryfortermphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-term.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-term.php 2022-12-27 12:21:35 UTC (rev 55018)
+++ trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-term.php 2022-12-28 14:07:16 UTC (rev 55019)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -6,9 +6,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Note: The below @method notations are defined solely for the benefit of IDEs,
</span><span class="cx" style="display: block; padding: 0 10px"> * as a way to indicate expected return values from the given factory methods.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @method int create( $args = array(), $generation_definitions = null )
- * @method WP_Term create_and_get( $args = array(), $generation_definitions = null )
- * @method int[] create_many( $count, $args = array(), $generation_definitions = null )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @method int|WP_Error create( $args = array(), $generation_definitions = null )
+ * @method WP_Term|WP_Error|null create_and_get( $args = array(), $generation_definitions = null )
+ * @method (int|WP_Error)[] create_many( $count, $args = array(), $generation_definitions = null )
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> class WP_UnitTest_Factory_For_Term extends WP_UnitTest_Factory_For_Thing {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -28,16 +28,20 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Creates a term object.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $args Array or string of arguments for inserting a term.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since UT (3.7.0)
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return array|WP_Error
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $args Array of arguments for inserting a term.
+ *
+ * @return int|WP_Error The term ID on success, WP_Error object on failure.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function create_object( $args ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $args = array_merge( array( 'taxonomy' => $this->taxonomy ), $args );
</span><span class="cx" style="display: block; padding: 0 10px"> $term_id_pair = wp_insert_term( $args['name'], $args['taxonomy'], $args );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( is_wp_error( $term_id_pair ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return $term_id_pair;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> return $term_id_pair['term_id'];
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -44,17 +48,27 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Updates the term.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int|object $term The term to update.
- * @param array|string $fields The context in which to relate the term to the object.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since UT (3.7.0)
+ * @since 6.2.0 Returns a WP_Error object on failure.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return int The term ID.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int|object $term The term to update.
+ * @param array $fields Array of arguments for updating a term.
+ *
+ * @return int|WP_Error The term ID on success, WP_Error object on failure.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function update_object( $term, $fields ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $fields = array_merge( array( 'taxonomy' => $this->taxonomy ), $fields );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( is_object( $term ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $taxonomy = $term->taxonomy;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $term_id_pair = wp_update_term( $term, $taxonomy, $fields );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ if ( is_wp_error( $term_id_pair ) ) {
+ return $term_id_pair;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> return $term_id_pair['term_id'];
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -61,6 +75,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Attach terms to the given post.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since UT (3.7.0)
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param int $post_id The post ID.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string|array $terms An array of terms to set for the post, or a string of terms
</span><span class="cx" style="display: block; padding: 0 10px"> * separated by commas. Hierarchical taxonomies must always pass IDs rather
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -79,6 +95,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Create a term and returns it as an object.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.3.0
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param array $args Array or string of arguments for inserting a term.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param null $generation_definitions The default values.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -92,6 +110,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $taxonomy = isset( $args['taxonomy'] ) ? $args['taxonomy'] : $this->taxonomy;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> return get_term( $term_id, $taxonomy );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -98,6 +117,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Retrieves the term by a given ID.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since UT (3.7.0)
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param int $term_id ID of the term to retrieve.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return WP_Term|WP_Error|null WP_Term on success. WP_Error if taxonomy does not exist. Null for miscellaneous failure.
</span></span></pre></div>
<a id="trunktestsphpunitincludesfactoryclasswpunittestfactoryforthingphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-thing.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-thing.php 2022-12-27 12:21:35 UTC (rev 55018)
+++ trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-thing.php 2022-12-28 14:07:16 UTC (rev 55019)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -9,12 +9,19 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public $factory;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Creates a new factory, which will create objects of a specific Thing
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Creates a new factory, which will create objects of a specific Thing.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param object $factory Global factory that can be used to create other objects on the system
- * @param array $default_generation_definitions Defines what default values should the properties of the object have. The default values
- * can be generators -- an object with next() method. There are some default generators: {@link WP_UnitTest_Generator_Sequence},
- * {@link WP_UnitTest_Generator_Locale_Name}, {@link WP_UnitTest_Factory_Callback_After_Create}.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since UT (3.7.0)
+ *
+ * @param object $factory Global factory that can be used to create other objects
+ * on the system.
+ * @param array $default_generation_definitions Defines what default values should the properties
+ * of the object have. The default values can be generators --
+ * an object with the next() method.
+ * There are some default generators:
+ * - {@link WP_UnitTest_Generator_Sequence}
+ * - {@link WP_UnitTest_Generator_Locale_Name}
+ * - {@link WP_UnitTest_Factory_Callback_After_Create}
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function __construct( $factory, $default_generation_definitions = array() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->factory = $factory;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -22,11 +29,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Creates an object.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Creates an object and returns its ID.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since UT (3.7.0)
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param array $args The arguments.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return mixed The result. Can be anything.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return int|WP_Error The object ID on success, WP_Error object on failure.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> abstract public function create_object( $args );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -33,20 +42,26 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Updates an existing object.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int $object The object ID.
- * @param array $fields The values to update.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since UT (3.7.0)
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return mixed The result. Can be anything.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $object_id The object ID.
+ * @param array $fields The values to update.
+ *
+ * @return int|WP_Error The object ID on success, WP_Error object on failure.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- abstract public function update_object( $object, $fields );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ abstract public function update_object( $object_id, $fields );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Creates an object.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Creates an object and returns its ID.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $args Optional. The arguments for the object to create. Default is empty array.
- * @param null $generation_definitions Optional. The default values for the object. Default is null.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since UT (3.7.0)
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return mixed The result. Can be anything.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $args Optional. The arguments for the object to create.
+ * Default empty array.
+ * @param null $generation_definitions Optional. The default values for the object.
+ * Default null.
+ *
+ * @return int|WP_Error The object ID on success, WP_Error object on failure.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function create( $args = array(), $generation_definitions = null ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_null( $generation_definitions ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -54,28 +69,35 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $generated_args = $this->generate_args( $args, $generation_definitions, $callbacks );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $created = $this->create_object( $generated_args );
- if ( ! $created || is_wp_error( $created ) ) {
- return $created;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $object_id = $this->create_object( $generated_args );
+
+ if ( ! $object_id || is_wp_error( $object_id ) ) {
+ return $object_id;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $callbacks ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $updated_fields = $this->apply_callbacks( $callbacks, $created );
- $save_result = $this->update_object( $created, $updated_fields );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $updated_fields = $this->apply_callbacks( $callbacks, $object_id );
+ $save_result = $this->update_object( $object_id, $updated_fields );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! $save_result || is_wp_error( $save_result ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return $save_result;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return $created;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ return $object_id;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Creates an object and returns its object.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Creates and returns an object.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $args Optional. The arguments for the object to create. Default is empty array.
- * @param null $generation_definitions Optional. The default values for the object. Default is null.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since UT (3.7.0)
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return mixed The created object. Can be anything.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $args Optional. The arguments for the object to create.
+ * Default empty array.
+ * @param null $generation_definitions Optional. The default values for the object.
+ * Default null.
+ *
+ * @return mixed The created object. Can be anything. WP_Error object on failure.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function create_and_get( $args = array(), $generation_definitions = null ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $object_id = $this->create( $args, $generation_definitions );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -90,6 +112,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Retrieves an object by ID.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since UT (3.7.0)
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param int $object_id The object ID.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return mixed The object. Can be anything.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -99,17 +123,23 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Creates multiple objects.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since UT (3.7.0)
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param int $count Amount of objects to create.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $args Optional. The arguments for the object to create. Default is empty array.
- * @param null $generation_definitions Optional. The default values for the object. Default is null.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $args Optional. The arguments for the object to create.
+ * Default empty array.
+ * @param null $generation_definitions Optional. The default values for the object.
+ * Default null.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function create_many( $count, $args = array(), $generation_definitions = null ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $results = array();
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> for ( $i = 0; $i < $count; $i++ ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $results[] = $this->create( $args, $generation_definitions );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> return $results;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -117,10 +147,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Combines the given arguments with the generation_definitions (defaults) and applies
</span><span class="cx" style="display: block; padding: 0 10px"> * possibly set callbacks on it.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $args Optional. The arguments to combine with defaults. Default is empty array.
- * @param array|null $generation_definitions Optional. The defaults. Default is null.
- * @param array|null $callbacks Optional. Array with callbacks to apply on the fields. Default is null.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since UT (3.7.0)
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $args Optional. The arguments to combine with defaults.
+ * Default empty array.
+ * @param array|null $generation_definitions Optional. The defaults. Default null.
+ * @param array|null $callbacks Optional. Array with callbacks to apply on the fields.
+ * Default null.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return array|WP_Error Combined array on success. WP_Error when default value is incorrent.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function generate_args( $args = array(), $generation_definitions = null, &$callbacks = null ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -144,7 +178,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> } elseif ( is_object( $generator ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $args[ $field_name ] = sprintf( $generator->get_template_string(), $incr );
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return new WP_Error( 'invalid_argument', 'Factory default value should be either a scalar or an generator object.' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return new WP_Error(
+ 'invalid_argument',
+ 'Factory default value should be either a scalar or an generator object.'
+ );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -156,17 +193,20 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Applies the callbacks on the created object.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since UT (3.7.0)
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param WP_UnitTest_Factory_Callback_After_Create[] $callbacks Array with callback functions.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param mixed $created The object to apply callbacks for.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $object_id ID of the object to apply callbacks for.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array The altered fields.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function apply_callbacks( $callbacks, $created ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function apply_callbacks( $callbacks, $object_id ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $updated_fields = array();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $callbacks as $field_name => $generator ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $updated_fields[ $field_name ] = $generator->call( $created );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $updated_fields[ $field_name ] = $generator->call( $object_id );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> return $updated_fields;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -173,6 +213,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Instantiates a callback objects for the given function name.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since UT (3.7.0)
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $function The callback function.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return WP_UnitTest_Factory_Callback_After_Create
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -184,6 +226,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Adds slashes to the given value.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since UT (3.7.0)
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param array|object|string|mixed $value The value to add slashes to.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array|string The value with the possibly applied slashes.
</span></span></pre></div>
<a id="trunktestsphpunitincludesfactoryclasswpunittestfactoryforuserphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-user.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-user.php 2022-12-27 12:21:35 UTC (rev 55018)
+++ trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-user.php 2022-12-28 14:07:16 UTC (rev 55019)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -6,9 +6,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Note: The below @method notations are defined solely for the benefit of IDEs,
</span><span class="cx" style="display: block; padding: 0 10px"> * as a way to indicate expected return values from the given factory methods.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @method int create( $args = array(), $generation_definitions = null )
- * @method WP_User create_and_get( $args = array(), $generation_definitions = null )
- * @method int[] create_many( $count, $args = array(), $generation_definitions = null )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @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 )
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> class WP_UnitTest_Factory_For_User extends WP_UnitTest_Factory_For_Thing {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -24,6 +24,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Inserts an user.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since UT (3.7.0)
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param array $args The user data to insert.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return int|WP_Error The user ID on success, WP_Error object on failure.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -35,6 +37,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Updates the user data.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since UT (3.7.0)
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param int $user_id ID of the user to update.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $fields The user data to update.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -48,6 +52,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Retrieves the user for a given ID.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since UT (3.7.0)
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param int $user_id ID of the user ID to retrieve.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return WP_User The user object.
</span></span></pre></div>
<a id="trunktestsphpunittestspostwpInsertPostphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/post/wpInsertPost.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/post/wpInsertPost.php 2022-12-27 12:21:35 UTC (rev 55018)
+++ trunk/tests/phpunit/tests/post/wpInsertPost.php 2022-12-28 14:07:16 UTC (rev 55019)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1192,7 +1192,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'post_status' => 'draft',
</span><span class="cx" style="display: block; padding: 0 10px"> )
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertSame( 0, $post_id );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertWPError( $post_id );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $post_id = self::factory()->post->create(
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1201,7 +1201,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'post_status' => 'draft',
</span><span class="cx" style="display: block; padding: 0 10px"> )
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertSame( 0, $post_id );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertWPError( $post_id );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Empty post_date_gmt without floating status
</span><span class="cx" style="display: block; padding: 0 10px"> $post_id = self::factory()->post->create(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1210,7 +1210,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'post_status' => 'publish',
</span><span class="cx" style="display: block; padding: 0 10px"> )
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertSame( 0, $post_id );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertWPError( $post_id );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $post_id = self::factory()->post->create(
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1219,7 +1219,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'post_status' => 'publish',
</span><span class="cx" style="display: block; padding: 0 10px"> )
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertSame( 0, $post_id );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertWPError( $post_id );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Valid post_date_gmt
</span><span class="cx" style="display: block; padding: 0 10px"> $post_id = self::factory()->post->create(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1228,7 +1228,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'post_date_gmt' => $post_date_gmt,
</span><span class="cx" style="display: block; padding: 0 10px"> )
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertSame( 0, $post_id );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertWPError( $post_id );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Invalid post_date_gmt
</span><span class="cx" style="display: block; padding: 0 10px"> $post_id = self::factory()->post->create(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1237,7 +1237,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'post_date_gmt' => $invalid_date,
</span><span class="cx" style="display: block; padding: 0 10px"> )
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertSame( 0, $post_id );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertWPError( $post_id );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span></span></pre>
</div>
</div>
</body>
</html>