Skip to content

Commit 9fa2e3f

Browse files
committed
Docs: Correct the canonical test helper return type.
Document the return type of `WP_Canonical_UnitTestCase::get_canonical()` as `string` instead of a variable name. Developed in: #14271 Props soean. See #65860. git-svn-id: https://develop.svn.wordpress.org/trunk@65102 602fd350-edb4-49c9-b593-d223f7449a82
1 parent 2809258 commit 9fa2e3f

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

‎tests/phpunit/includes/testcase-canonical.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -347,8 +347,8 @@ public function assertCanonical( $test_url, $expected, $ticket = 0, $expected_do
347347
*
348348
* @param string $test_url Should be relative to the site "front", ie /category/uncategorized/
349349
* as opposed to http://example.com/category/uncategorized/
350-
* @return $can_url Returns the original $test_url if no canonical can be generated, otherwise returns
351-
* the fully-qualified URL as generated by redirect_canonical().
350+
* @return string Returns the original $test_url if no canonical can be generated, otherwise returns
351+
* the fully-qualified URL as generated by redirect_canonical().
352352
*/
353353
public function get_canonical( $test_url ) {
354354
if ( isset( $_SERVER['HTTP_HOST'] ) ) {

0 commit comments

Comments
 (0)