Skip to content

Tests: Add unit test coverage for permalink_anchor() #14486

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rejaulalomkhan wants to merge 2 commits into
base: trunk
Choose a base branch
from
+152 −0
Open

Tests: Add unit test coverage for permalink_anchor() #14486

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
64b1e8f
Tests: Add unit test coverage for `permalink_anchor()`
rejaulalomkhan Oct 19, 2026
311e076
Tests: Use a literal expected slug in the permalink_anchor() special …
rejaulalomkhan Oct 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
152 changes: 152 additions & 0 deletions tests/phpunit/tests/link/permalinkAnchor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,152 @@
<?php
/**
* Tests for the `permalink_anchor()` function.
*
* @group link
* @group post
*
* @covers ::permalink_anchor
*/
class Tests_Link_PermalinkAnchor extends WP_UnitTestCase {

/**
* Test post ID.
*
* @var int
*/
protected static $post_id;

/**
* Sets up shared fixtures for the test class.
*
* @param WP_UnitTest_Factory $factory Unit test factory.
*/
public static function wpSetUpBeforeClass( WP_UnitTest_Factory $factory ) {
self::$post_id = $factory->post->create(
array(
'post_title' => 'Test Post Title',
)
);
}

/**
* Sets up the global $post object before each test method.
*/
public function set_up() {
parent::set_up();
$GLOBALS['post'] = get_post( self::$post_id );
}

/**
* Tears down the global $post object after each test method.
*/
public function tear_down() {
unset( $GLOBALS['post'] );
parent::tear_down();
}

/**
* Tests that permalink_anchor() outputs the post ID anchor by default when no argument is passed.
*
* @ticket 65819
*/
public function test_permalink_anchor_default_mode_id() {
$expected = '<a id="post-' . self::$post_id . '"></a>';

$this->assertSame( $expected, get_echo( 'permalink_anchor' ) );
}

/**
* Tests that permalink_anchor() outputs the post ID anchor when explicitly passing 'id'.
*
* @ticket 65819
*/
public function test_permalink_anchor_explicit_mode_id() {
$expected = '<a id="post-' . self::$post_id . '"></a>';

$this->assertSame( $expected, get_echo( 'permalink_anchor', array( 'id' ) ) );
}

/**
* Tests that permalink_anchor() handles mode case-insensitively for 'id'.
*
* @ticket 65819
*/
public function test_permalink_anchor_mode_id_case_insensitive() {
$expected = '<a id="post-' . self::$post_id . '"></a>';

$this->assertSame( $expected, get_echo( 'permalink_anchor', array( 'ID' ) ) );
$this->assertSame( $expected, get_echo( 'permalink_anchor', array( 'Id' ) ) );
}

/**
* Tests that permalink_anchor() outputs the sanitized title anchor when passing 'title'.
*
* @ticket 65819
*/
public function test_permalink_anchor_mode_title() {
$expected = '<a id="test-post-title-' . self::$post_id . '"></a>';

$this->assertSame( $expected, get_echo( 'permalink_anchor', array( 'title' ) ) );
}

/**
* Tests that permalink_anchor() handles mode case-insensitively for 'title'.
*
* @ticket 65819
*/
public function test_permalink_anchor_mode_title_case_insensitive() {
$expected = '<a id="test-post-title-' . self::$post_id . '"></a>';

$this->assertSame( $expected, get_echo( 'permalink_anchor', array( 'TITLE' ) ) );
$this->assertSame( $expected, get_echo( 'permalink_anchor', array( 'Title' ) ) );
}

/**
* Tests that permalink_anchor() properly sanitizes titles containing special characters.
*
* @ticket 65819
*/
public function test_permalink_anchor_mode_title_with_special_characters() {
$special_post_id = self::factory()->post->create(
array(
'post_title' => 'Special Characters & Symbols: 100% Valid!',
)
);

$GLOBALS['post'] = get_post( $special_post_id );

$expected = '<a id="special-characters-symbols-100-valid-' . $special_post_id . '"></a>';

$this->assertSame( $expected, get_echo( 'permalink_anchor', array( 'title' ) ) );
}

@lancewillett lancewillett Oct 19, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please use a literal expected slug for this fixed special-character title, appending only the generated post ID. Calling sanitize_title() to construct the expectation repeats the production dependency: a change in its handling of punctuation would change both actual and expected output together. The literal expectation will make this particular case protect the output described by its name.


/**
* Tests that permalink_anchor() falls back to id mode for unrecognized mode arguments.
*
* @ticket 65819
*
* @dataProvider data_unrecognized_modes
*
* @param string $mode Mode to pass.
*/
public function test_permalink_anchor_unrecognized_mode_falls_back_to_id( $mode ) {
$expected = '<a id="post-' . self::$post_id . '"></a>';

$this->assertSame( $expected, get_echo( 'permalink_anchor', array( $mode ) ) );
}

/**
* Data provider for test_permalink_anchor_unrecognized_mode_falls_back_to_id().
*
* @return array[]
*/
public static function data_unrecognized_modes() {
return array(
'empty string' => array( '' ),
'arbitrary string' => array( 'custom' ),
'invalid mode slug' => array( 'slug' ),
'numeric string mode' => array( '123' ),
);
}
}
Loading