vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2025-10-16 12:05:38 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Coding Standards: Replace CRLF line breaks with LF.

Browse Source 
Run `npm run grunt format:php:error` to correct the EOL sequence for:

* `tests/phpunit/tests/functions/wpAdminNotice.php`
* `tests/phpunit/tests/functions/wpGetAdminNotice.php`

See #59650.



git-svn-id: https://develop.svn.wordpress.org/trunk@57100 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Peter Wilson 2023-11-10 00:07:59 +00:00
parent 7287ff5263
commit a4a4f3a1dc
2 changed files with 652 additions and 652 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

652
tests/phpunit/tests/functions/wpAdminNotice.php
View File

@ -1,326 +1,326 @@
<?php
/**
* Tests for `wp_admin_notice()`.
*
* @group functions
*
* @covers ::wp_admin_notice
*/
class Tests_Functions_WpAdminNotice extends WP_UnitTestCase {
/**
* Tests that `wp_admin_notice()` outputs the expected admin notice markup.
*
* @ticket 57791
*
* @dataProvider data_should_output_admin_notice
*
* @param string $message The message to output.
* @param array $args Arguments for the admin notice.
* @param string $expected The expected admin notice markup.
*/
public function test_should_output_admin_notice( $message, $args, $expected ) {
ob_start();
wp_admin_notice( $message, $args );
$actual = ob_get_clean();
$this->assertSame( $expected, $actual );
}
/**
* Data provider.
*
* @return array[]
*/
public function data_should_output_admin_notice() {
return array(
'defaults' => array(
'message' => 'A notice with defaults.',
'args' => array(),
'expected' => '<div class="notice"><p>A notice with defaults.</p></div>',
),
'an empty message (used for templates)' => array(
'message' => '',
'args' => array(
'type' => 'error',
'dismissible' => true,
'id' => 'message',
'additional_classes' => array( 'inline', 'hidden' ),
),
'expected' => '<div id="message" class="notice notice-error is-dismissible inline hidden"><p></p></div>',
),
'an empty message (used for templates) without paragraph wrapping' => array(
'message' => '',
'args' => array(
'type' => 'error',
'dismissible' => true,
'id' => 'message',
'additional_classes' => array( 'inline', 'hidden' ),
'paragraph_wrap' => false,
),
'expected' => '<div id="message" class="notice notice-error is-dismissible inline hidden"></div>',
),
'an "error" notice' => array(
'message' => 'An "error" notice.',
'args' => array(
'type' => 'error',
),
'expected' => '<div class="notice notice-error"><p>An "error" notice.</p></div>',
),
'a "success" notice' => array(
'message' => 'A "success" notice.',
'args' => array(
'type' => 'success',
),
'expected' => '<div class="notice notice-success"><p>A "success" notice.</p></div>',
),
'a "warning" notice' => array(
'message' => 'A "warning" notice.',
'args' => array(
'type' => 'warning',
),
'expected' => '<div class="notice notice-warning"><p>A "warning" notice.</p></div>',
),
'an "info" notice' => array(
'message' => 'An "info" notice.',
'args' => array(
'type' => 'info',
),
'expected' => '<div class="notice notice-info"><p>An "info" notice.</p></div>',
),
'a type that already starts with "notice-"' => array(
'message' => 'A type that already starts with "notice-".',
'args' => array(
'type' => 'notice-info',
),
'expected' => '<div class="notice notice-notice-info"><p>A type that already starts with "notice-".</p></div>',
),
'a dismissible notice' => array(
'message' => 'A dismissible notice.',
'args' => array(
'dismissible' => true,
),
'expected' => '<div class="notice is-dismissible"><p>A dismissible notice.</p></div>',
),
'no type and an ID' => array(
'message' => 'A notice with an ID.',
'args' => array(
'id' => 'message',
),
'expected' => '<div id="message" class="notice"><p>A notice with an ID.</p></div>',
),
'a type and an ID' => array(
'message' => 'A warning notice with an ID.',
'args' => array(
'type' => 'warning',
'id' => 'message',
),
'expected' => '<div id="message" class="notice notice-warning"><p>A warning notice with an ID.</p></div>',
),
'no type and additional classes' => array(
'message' => 'A notice with additional classes.',
'args' => array(
'additional_classes' => array( 'error', 'notice-alt' ),
),
'expected' => '<div class="notice error notice-alt"><p>A notice with additional classes.</p></div>',
),
'a type and additional classes' => array(
'message' => 'A warning notice with additional classes.',
'args' => array(
'type' => 'warning',
'additional_classes' => array( 'error', 'notice-alt' ),
),
'expected' => '<div class="notice notice-warning error notice-alt"><p>A warning notice with additional classes.</p></div>',
),
'a dismissible notice with a type and additional classes' => array(
'message' => 'A dismissible warning notice with a type and additional classes.',
'args' => array(
'type' => 'warning',
'dismissible' => true,
'additional_classes' => array( 'error', 'notice-alt' ),
),
'expected' => '<div class="notice notice-warning is-dismissible error notice-alt"><p>A dismissible warning notice with a type and additional classes.</p></div>',
),
'a notice without paragraph wrapping' => array(
'message' => '<span>A notice without paragraph wrapping.</span>',
'args' => array(
'paragraph_wrap' => false,
),
'expected' => '<div class="notice"><span>A notice without paragraph wrapping.</span></div>',
),
'an unsafe type' => array(
'message' => 'A notice with an unsafe type.',
'args' => array(
'type' => '"><script>alert("Howdy,admin!");</script>',
),
'expected' => '<div class="notice notice-">alert("Howdy,admin!");"&gt;<p>A notice with an unsafe type.</p></div>',
),
'an unsafe ID' => array(
'message' => 'A notice with an unsafe ID.',
'args' => array(
'id' => '"><script>alert( "Howdy, admin!" );</script> <div class="notice',
),
'expected' => '<div id="">alert( "Howdy, admin!" ); <div class="notice"><p>A notice with an unsafe ID.</p></div>',
),
'unsafe additional classes' => array(
'message' => 'A notice with unsafe additional classes.',
'args' => array(
'additional_classes' => array( '"><script>alert( "Howdy, admin!" );</script> <div class="notice' ),
),
'expected' => '<div class="notice ">alert( "Howdy, admin!" ); <div class="notice"><p>A notice with unsafe additional classes.</p></div>',
),
'a type that is not a string' => array(
'message' => 'A notice with a type that is not a string.',
'args' => array(
'type' => array(),
),
'expected' => '<div class="notice"><p>A notice with a type that is not a string.</p></div>',
),
'a type with only empty space' => array(
'message' => 'A notice with a type with only empty space.',
'args' => array(
'type' => " \t\r\n",
),
'expected' => '<div class="notice"><p>A notice with a type with only empty space.</p></div>',
),
'an ID that is not a string' => array(
'message' => 'A notice with an ID that is not a string.',
'args' => array(
'id' => array( 'message' ),
),
'expected' => '<div class="notice"><p>A notice with an ID that is not a string.</p></div>',
),
'an ID with only empty space' => array(
'message' => 'A notice with an ID with only empty space.',
'args' => array(
'id' => " \t\r\n",
),
'expected' => '<div class="notice"><p>A notice with an ID with only empty space.</p></div>',
),
'dismissible as a truthy value rather than (bool) true' => array(
'message' => 'A notice with dismissible as a truthy value rather than (bool) true.',
'args' => array(
'dismissible' => 1,
),
'expected' => '<div class="notice"><p>A notice with dismissible as a truthy value rather than (bool) true.</p></div>',
),
'additional classes that are not an array' => array(
'message' => 'A notice with additional classes that are not an array.',
'args' => array(
'additional_classes' => 'class-1 class-2 class-3',
),
'expected' => '<div class="notice"><p>A notice with additional classes that are not an array.</p></div>',
),
'additional attribute with a value' => array(
'message' => 'A notice with an additional attribute with a value.',
'args' => array(
'attributes' => array( 'aria-live' => 'assertive' ),
),
'expected' => '<div class="notice" aria-live="assertive"><p>A notice with an additional attribute with a value.</p></div>',
),
'additional hidden attribute' => array(
'message' => 'A notice with the hidden attribute.',
'args' => array(
'attributes' => array( 'hidden' => true ),
),
'expected' => '<div class="notice" hidden><p>A notice with the hidden attribute.</p></div>',
),
'additional attribute no associative keys' => array(
'message' => 'A notice with a boolean attribute without an associative key.',
'args' => array(
'attributes' => array( 'hidden' ),
),
'expected' => '<div class="notice" hidden><p>A notice with a boolean attribute without an associative key.</p></div>',
),
'additional attribute with role' => array(
'message' => 'A notice with an additional attribute role.',
'args' => array(
'attributes' => array( 'role' => 'alert' ),
),
'expected' => '<div class="notice" role="alert"><p>A notice with an additional attribute role.</p></div>',
),
'multiple additional attributes' => array(
'message' => 'A notice with multiple additional attributes.',
'args' => array(
'attributes' => array(
'role' => 'alert',
'data-test' => -1,
),
),
'expected' => '<div class="notice" role="alert" data-test="-1"><p>A notice with multiple additional attributes.</p></div>',
),
'data attribute with unsafe value' => array(
'message' => 'A notice with an additional attribute with an unsafe value.',
'args' => array(
'attributes' => array( 'data-unsafe' => '<script>alert( "Howdy, admin!" );</script>' ),
),
'expected' => '<div class="notice" data-unsafe="&lt;script&gt;alert( &quot;Howdy, admin!&quot; );&lt;/script&gt;"><p>A notice with an additional attribute with an unsafe value.</p></div>',
),
'additional invalid attribute' => array(
'message' => 'A notice with an additional attribute that is invalid.',
'args' => array(
'attributes' => array( 'not-valid' => 'not-valid' ),
),
'expected' => '<div class="notice"><p>A notice with an additional attribute that is invalid.</p></div>',
),
'multiple attributes with "role", invalid, data-*, numeric, and boolean' => array(
'message' => 'A notice with multiple attributes with "role", invalid, "data-*", numeric, and boolean.',
'args' => array(
'attributes' => array(
'role' => 'alert',
'disabled' => 'disabled',
'data-name' => 'my-name',
'data-id' => 1,
'hidden',
),
),
'expected' => '<div class="notice" role="alert" data-name="my-name" data-id="1" hidden><p>A notice with multiple attributes with "role", invalid, "data-*", numeric, and boolean.</p></div>',
),
'paragraph wrapping as a falsy value rather than (bool) false' => array(
'message' => 'A notice with paragraph wrapping as a falsy value rather than (bool) false.',
'args' => array(
'paragraph_wrap' => 0,
),
'expected' => '<div class="notice"><p>A notice with paragraph wrapping as a falsy value rather than (bool) false.</p></div>',
),
);
}
/**
* Tests that `_doing_it_wrong()` is thrown when a 'type' containing spaces is passed.
*
* @ticket 57791
*
* @expectedIncorrectUsage wp_get_admin_notice
*/
public function test_should_throw_doing_it_wrong_with_a_type_containing_spaces() {
ob_start();
wp_admin_notice(
'A type containing spaces.',
array( 'type' => 'first second third fourth' )
);
$actual = ob_get_clean();
$this->assertSame(
'<div class="notice notice-first second third fourth"><p>A type containing spaces.</p></div>',
$actual
);
}
/**
* Tests that `wp_admin_notice()` fires the 'wp_admin_notice' action.
*
* @ticket 57791
*/
public function test_should_fire_wp_admin_notice_action() {
$action = new MockAction();
add_action( 'wp_admin_notice', array( $action, 'action' ) );
ob_start();
wp_admin_notice( 'A notice.', array( 'type' => 'success' ) );
ob_end_clean();
$this->assertSame( 1, $action->get_call_count() );
}
}
<?php
/**
* Tests for `wp_admin_notice()`.
*
* @group functions
*
* @covers ::wp_admin_notice
*/
class Tests_Functions_WpAdminNotice extends WP_UnitTestCase {
/**
* Tests that `wp_admin_notice()` outputs the expected admin notice markup.
*
* @ticket 57791
*
* @dataProvider data_should_output_admin_notice
*
* @param string $message The message to output.
* @param array $args Arguments for the admin notice.
* @param string $expected The expected admin notice markup.
*/
public function test_should_output_admin_notice( $message, $args, $expected ) {
ob_start();
wp_admin_notice( $message, $args );
$actual = ob_get_clean();
$this->assertSame( $expected, $actual );
}
/**
* Data provider.
*
* @return array[]
*/
public function data_should_output_admin_notice() {
return array(
'defaults' => array(
'message' => 'A notice with defaults.',
'args' => array(),
'expected' => '<div class="notice"><p>A notice with defaults.</p></div>',
),
'an empty message (used for templates)' => array(
'message' => '',
'args' => array(
'type' => 'error',
'dismissible' => true,
'id' => 'message',
'additional_classes' => array( 'inline', 'hidden' ),
),
'expected' => '<div id="message" class="notice notice-error is-dismissible inline hidden"><p></p></div>',
),
'an empty message (used for templates) without paragraph wrapping' => array(
'message' => '',
'args' => array(
'type' => 'error',
'dismissible' => true,
'id' => 'message',
'additional_classes' => array( 'inline', 'hidden' ),
'paragraph_wrap' => false,
),
'expected' => '<div id="message" class="notice notice-error is-dismissible inline hidden"></div>',
),
'an "error" notice' => array(
'message' => 'An "error" notice.',
'args' => array(
'type' => 'error',
),
'expected' => '<div class="notice notice-error"><p>An "error" notice.</p></div>',
),
'a "success" notice' => array(
'message' => 'A "success" notice.',
'args' => array(
'type' => 'success',
),
'expected' => '<div class="notice notice-success"><p>A "success" notice.</p></div>',
),
'a "warning" notice' => array(
'message' => 'A "warning" notice.',
'args' => array(
'type' => 'warning',
),
'expected' => '<div class="notice notice-warning"><p>A "warning" notice.</p></div>',
),
'an "info" notice' => array(
'message' => 'An "info" notice.',
'args' => array(
'type' => 'info',
),
'expected' => '<div class="notice notice-info"><p>An "info" notice.</p></div>',
),
'a type that already starts with "notice-"' => array(
'message' => 'A type that already starts with "notice-".',
'args' => array(
'type' => 'notice-info',
),
'expected' => '<div class="notice notice-notice-info"><p>A type that already starts with "notice-".</p></div>',
),
'a dismissible notice' => array(
'message' => 'A dismissible notice.',
'args' => array(
'dismissible' => true,
),
'expected' => '<div class="notice is-dismissible"><p>A dismissible notice.</p></div>',
),
'no type and an ID' => array(
'message' => 'A notice with an ID.',
'args' => array(
'id' => 'message',
),
'expected' => '<div id="message" class="notice"><p>A notice with an ID.</p></div>',
),
'a type and an ID' => array(
'message' => 'A warning notice with an ID.',
'args' => array(
'type' => 'warning',
'id' => 'message',
),
'expected' => '<div id="message" class="notice notice-warning"><p>A warning notice with an ID.</p></div>',
),
'no type and additional classes' => array(
'message' => 'A notice with additional classes.',
'args' => array(
'additional_classes' => array( 'error', 'notice-alt' ),
),
'expected' => '<div class="notice error notice-alt"><p>A notice with additional classes.</p></div>',
),
'a type and additional classes' => array(
'message' => 'A warning notice with additional classes.',
'args' => array(
'type' => 'warning',
'additional_classes' => array( 'error', 'notice-alt' ),
),
'expected' => '<div class="notice notice-warning error notice-alt"><p>A warning notice with additional classes.</p></div>',
),
'a dismissible notice with a type and additional classes' => array(
'message' => 'A dismissible warning notice with a type and additional classes.',
'args' => array(
'type' => 'warning',
'dismissible' => true,
'additional_classes' => array( 'error', 'notice-alt' ),
),
'expected' => '<div class="notice notice-warning is-dismissible error notice-alt"><p>A dismissible warning notice with a type and additional classes.</p></div>',
),
'a notice without paragraph wrapping' => array(
'message' => '<span>A notice without paragraph wrapping.</span>',
'args' => array(
'paragraph_wrap' => false,
),
'expected' => '<div class="notice"><span>A notice without paragraph wrapping.</span></div>',
),
'an unsafe type' => array(
'message' => 'A notice with an unsafe type.',
'args' => array(
'type' => '"><script>alert("Howdy,admin!");</script>',
),
'expected' => '<div class="notice notice-">alert("Howdy,admin!");"&gt;<p>A notice with an unsafe type.</p></div>',
),
'an unsafe ID' => array(
'message' => 'A notice with an unsafe ID.',
'args' => array(
'id' => '"><script>alert( "Howdy, admin!" );</script> <div class="notice',
),
'expected' => '<div id="">alert( "Howdy, admin!" ); <div class="notice"><p>A notice with an unsafe ID.</p></div>',
),
'unsafe additional classes' => array(
'message' => 'A notice with unsafe additional classes.',
'args' => array(
'additional_classes' => array( '"><script>alert( "Howdy, admin!" );</script> <div class="notice' ),
),
'expected' => '<div class="notice ">alert( "Howdy, admin!" ); <div class="notice"><p>A notice with unsafe additional classes.</p></div>',
),
'a type that is not a string' => array(
'message' => 'A notice with a type that is not a string.',
'args' => array(
'type' => array(),
),
'expected' => '<div class="notice"><p>A notice with a type that is not a string.</p></div>',
),
'a type with only empty space' => array(
'message' => 'A notice with a type with only empty space.',
'args' => array(
'type' => " \t\r\n",
),
'expected' => '<div class="notice"><p>A notice with a type with only empty space.</p></div>',
),
'an ID that is not a string' => array(
'message' => 'A notice with an ID that is not a string.',
'args' => array(
'id' => array( 'message' ),
),
'expected' => '<div class="notice"><p>A notice with an ID that is not a string.</p></div>',
),
'an ID with only empty space' => array(
'message' => 'A notice with an ID with only empty space.',
'args' => array(
'id' => " \t\r\n",
),
'expected' => '<div class="notice"><p>A notice with an ID with only empty space.</p></div>',
),
'dismissible as a truthy value rather than (bool) true' => array(
'message' => 'A notice with dismissible as a truthy value rather than (bool) true.',
'args' => array(
'dismissible' => 1,
),
'expected' => '<div class="notice"><p>A notice with dismissible as a truthy value rather than (bool) true.</p></div>',
),
'additional classes that are not an array' => array(
'message' => 'A notice with additional classes that are not an array.',
'args' => array(
'additional_classes' => 'class-1 class-2 class-3',
),
'expected' => '<div class="notice"><p>A notice with additional classes that are not an array.</p></div>',
),
'additional attribute with a value' => array(
'message' => 'A notice with an additional attribute with a value.',
'args' => array(
'attributes' => array( 'aria-live' => 'assertive' ),
),
'expected' => '<div class="notice" aria-live="assertive"><p>A notice with an additional attribute with a value.</p></div>',
),
'additional hidden attribute' => array(
'message' => 'A notice with the hidden attribute.',
'args' => array(
'attributes' => array( 'hidden' => true ),
),
'expected' => '<div class="notice" hidden><p>A notice with the hidden attribute.</p></div>',
),
'additional attribute no associative keys' => array(
'message' => 'A notice with a boolean attribute without an associative key.',
'args' => array(
'attributes' => array( 'hidden' ),
),
'expected' => '<div class="notice" hidden><p>A notice with a boolean attribute without an associative key.</p></div>',
),
'additional attribute with role' => array(
'message' => 'A notice with an additional attribute role.',
'args' => array(
'attributes' => array( 'role' => 'alert' ),
),
'expected' => '<div class="notice" role="alert"><p>A notice with an additional attribute role.</p></div>',
),
'multiple additional attributes' => array(
'message' => 'A notice with multiple additional attributes.',
'args' => array(
'attributes' => array(
'role' => 'alert',
'data-test' => -1,
),
),
'expected' => '<div class="notice" role="alert" data-test="-1"><p>A notice with multiple additional attributes.</p></div>',
),
'data attribute with unsafe value' => array(
'message' => 'A notice with an additional attribute with an unsafe value.',
'args' => array(
'attributes' => array( 'data-unsafe' => '<script>alert( "Howdy, admin!" );</script>' ),
),
'expected' => '<div class="notice" data-unsafe="&lt;script&gt;alert( &quot;Howdy, admin!&quot; );&lt;/script&gt;"><p>A notice with an additional attribute with an unsafe value.</p></div>',
),
'additional invalid attribute' => array(
'message' => 'A notice with an additional attribute that is invalid.',
'args' => array(
'attributes' => array( 'not-valid' => 'not-valid' ),
),
'expected' => '<div class="notice"><p>A notice with an additional attribute that is invalid.</p></div>',
),
'multiple attributes with "role", invalid, data-*, numeric, and boolean' => array(
'message' => 'A notice with multiple attributes with "role", invalid, "data-*", numeric, and boolean.',
'args' => array(
'attributes' => array(
'role' => 'alert',
'disabled' => 'disabled',
'data-name' => 'my-name',
'data-id' => 1,
'hidden',
),
),
'expected' => '<div class="notice" role="alert" data-name="my-name" data-id="1" hidden><p>A notice with multiple attributes with "role", invalid, "data-*", numeric, and boolean.</p></div>',
),
'paragraph wrapping as a falsy value rather than (bool) false' => array(
'message' => 'A notice with paragraph wrapping as a falsy value rather than (bool) false.',
'args' => array(
'paragraph_wrap' => 0,
),
'expected' => '<div class="notice"><p>A notice with paragraph wrapping as a falsy value rather than (bool) false.</p></div>',
),
);
}
/**
* Tests that `_doing_it_wrong()` is thrown when a 'type' containing spaces is passed.
*
* @ticket 57791
*
* @expectedIncorrectUsage wp_get_admin_notice
*/
public function test_should_throw_doing_it_wrong_with_a_type_containing_spaces() {
ob_start();
wp_admin_notice(
'A type containing spaces.',
array( 'type' => 'first second third fourth' )
);
$actual = ob_get_clean();
$this->assertSame(
'<div class="notice notice-first second third fourth"><p>A type containing spaces.</p></div>',
$actual
);
}
/**
* Tests that `wp_admin_notice()` fires the 'wp_admin_notice' action.
*
* @ticket 57791
*/
public function test_should_fire_wp_admin_notice_action() {
$action = new MockAction();
add_action( 'wp_admin_notice', array( $action, 'action' ) );
ob_start();
wp_admin_notice( 'A notice.', array( 'type' => 'success' ) );
ob_end_clean();
$this->assertSame( 1, $action->get_call_count() );
}
}

652
tests/phpunit/tests/functions/wpGetAdminNotice.php
View File

@ -1,326 +1,326 @@
<?php
/**
* Tests for `wp_get_admin_notice()`.
*
* @group functions
*
* @covers ::wp_get_admin_notice
*/
class Tests_Functions_WpGetAdminNotice extends WP_UnitTestCase {
/**
* Tests that `wp_get_admin_notice()` returns the expected admin notice markup.
*
* @ticket 57791
*
* @dataProvider data_should_return_admin_notice
*
* @param string $message The message.
* @param array $args Arguments for the admin notice.
* @param string $expected The expected admin notice markup.
*/
public function test_should_return_admin_notice( $message, $args, $expected ) {
$this->assertSame( $expected, wp_get_admin_notice( $message, $args ) );
}
/**
* Data provider.
*
* @return array[]
*/
public function data_should_return_admin_notice() {
return array(
'defaults' => array(
'message' => 'A notice with defaults.',
'args' => array(),
'expected' => '<div class="notice"><p>A notice with defaults.</p></div>',
),
'an empty message (used for templates)' => array(
'message' => '',
'args' => array(
'type' => 'error',
'dismissible' => true,
'id' => 'message',
'additional_classes' => array( 'inline', 'hidden' ),
),
'expected' => '<div id="message" class="notice notice-error is-dismissible inline hidden"><p></p></div>',
),
'an empty message (used for templates) without paragraph wrapping' => array(
'message' => '',
'args' => array(
'type' => 'error',
'dismissible' => true,
'id' => 'message',
'additional_classes' => array( 'inline', 'hidden' ),
'paragraph_wrap' => false,
),
'expected' => '<div id="message" class="notice notice-error is-dismissible inline hidden"></div>',
),
'an "error" notice' => array(
'message' => 'An "error" notice.',
'args' => array(
'type' => 'error',
),
'expected' => '<div class="notice notice-error"><p>An "error" notice.</p></div>',
),
'a "success" notice' => array(
'message' => 'A "success" notice.',
'args' => array(
'type' => 'success',
),
'expected' => '<div class="notice notice-success"><p>A "success" notice.</p></div>',
),
'a "warning" notice' => array(
'message' => 'A "warning" notice.',
'args' => array(
'type' => 'warning',
),
'expected' => '<div class="notice notice-warning"><p>A "warning" notice.</p></div>',
),
'an "info" notice' => array(
'message' => 'An "info" notice.',
'args' => array(
'type' => 'info',
),
'expected' => '<div class="notice notice-info"><p>An "info" notice.</p></div>',
),
'a type that already starts with "notice-"' => array(
'message' => 'A type that already starts with "notice-".',
'args' => array(
'type' => 'notice-info',
),
'expected' => '<div class="notice notice-notice-info"><p>A type that already starts with "notice-".</p></div>',
),
'a dismissible notice' => array(
'message' => 'A dismissible notice.',
'args' => array(
'dismissible' => true,
),
'expected' => '<div class="notice is-dismissible"><p>A dismissible notice.</p></div>',
),
'no type and an ID' => array(
'message' => 'A notice with an ID.',
'args' => array(
'id' => 'message',
),
'expected' => '<div id="message" class="notice"><p>A notice with an ID.</p></div>',
),
'a type and an ID' => array(
'message' => 'A warning notice with an ID.',
'args' => array(
'type' => 'warning',
'id' => 'message',
),
'expected' => '<div id="message" class="notice notice-warning"><p>A warning notice with an ID.</p></div>',
),
'no type and additional classes' => array(
'message' => 'A notice with additional classes.',
'args' => array(
'additional_classes' => array( 'error', 'notice-alt' ),
),
'expected' => '<div class="notice error notice-alt"><p>A notice with additional classes.</p></div>',
),
'a type and additional classes' => array(
'message' => 'A warning notice with additional classes.',
'args' => array(
'type' => 'warning',
'additional_classes' => array( 'error', 'notice-alt' ),
),
'expected' => '<div class="notice notice-warning error notice-alt"><p>A warning notice with additional classes.</p></div>',
),
'a dismissible notice with a type and additional classes' => array(
'message' => 'A dismissible warning notice with a type and additional classes.',
'args' => array(
'type' => 'warning',
'dismissible' => true,
'additional_classes' => array( 'error', 'notice-alt' ),
),
'expected' => '<div class="notice notice-warning is-dismissible error notice-alt"><p>A dismissible warning notice with a type and additional classes.</p></div>',
),
'a notice without paragraph wrapping' => array(
'message' => '<span>A notice without paragraph wrapping.</span>',
'args' => array(
'paragraph_wrap' => false,
),
'expected' => '<div class="notice"><span>A notice without paragraph wrapping.</span></div>',
),
'an unsafe type' => array(
'message' => 'A notice with an unsafe type.',
'args' => array(
'type' => '"><script>alert("Howdy,admin!");</script>',
),
'expected' => '<div class="notice notice-"><script>alert("Howdy,admin!");</script>"><p>A notice with an unsafe type.</p></div>',
),
'an unsafe ID' => array(
'message' => 'A notice with an unsafe ID.',
'args' => array(
'id' => '"><script>alert( "Howdy, admin!" );</script> <div class="notice',
),
'expected' => '<div id=""><script>alert( "Howdy, admin!" );</script> <div class="notice" class="notice"><p>A notice with an unsafe ID.</p></div>',
),
'unsafe additional classes' => array(
'message' => 'A notice with unsafe additional classes.',
'args' => array(
'additional_classes' => array( '"><script>alert( "Howdy, admin!" );</script> <div class="notice' ),
),
'expected' => '<div class="notice "><script>alert( "Howdy, admin!" );</script> <div class="notice"><p>A notice with unsafe additional classes.</p></div>',
),
'a type that is not a string' => array(
'message' => 'A notice with a type that is not a string.',
'args' => array(
'type' => array(),
),
'expected' => '<div class="notice"><p>A notice with a type that is not a string.</p></div>',
),
'a type with only empty space' => array(
'message' => 'A notice with a type with only empty space.',
'args' => array(
'type' => " \t\r\n",
),
'expected' => '<div class="notice"><p>A notice with a type with only empty space.</p></div>',
),
'an ID that is not a string' => array(
'message' => 'A notice with an ID that is not a string.',
'args' => array(
'id' => array( 'message' ),
),
'expected' => '<div class="notice"><p>A notice with an ID that is not a string.</p></div>',
),
'an ID with only empty space' => array(
'message' => 'A notice with an ID with only empty space.',
'args' => array(
'id' => " \t\r\n",
),
'expected' => '<div class="notice"><p>A notice with an ID with only empty space.</p></div>',
),
'dismissible as a truthy value rather than (bool) true' => array(
'message' => 'A notice with dismissible as a truthy value rather than (bool) true.',
'args' => array(
'dismissible' => 1,
),
'expected' => '<div class="notice"><p>A notice with dismissible as a truthy value rather than (bool) true.</p></div>',
),
'additional classes that are not an array' => array(
'message' => 'A notice with additional classes that are not an array.',
'args' => array(
'additional_classes' => 'class-1 class-2 class-3',
),
'expected' => '<div class="notice"><p>A notice with additional classes that are not an array.</p></div>',
),
'additional attribute with a value' => array(
'message' => 'A notice with an additional attribute with a value.',
'args' => array(
'attributes' => array( 'aria-live' => 'assertive' ),
),
'expected' => '<div class="notice" aria-live="assertive"><p>A notice with an additional attribute with a value.</p></div>',
),
'additional hidden attribute' => array(
'message' => 'A notice with the hidden attribute.',
'args' => array(
'attributes' => array( 'hidden' => true ),
),
'expected' => '<div class="notice" hidden><p>A notice with the hidden attribute.</p></div>',
),
'additional attribute no associative keys' => array(
'message' => 'A notice with a boolean attribute without an associative key.',
'args' => array(
'attributes' => array( 'hidden' ),
),
'expected' => '<div class="notice" hidden><p>A notice with a boolean attribute without an associative key.</p></div>',
),
'additional attribute with role' => array(
'message' => 'A notice with an additional attribute role.',
'args' => array(
'attributes' => array( 'role' => 'alert' ),
),
'expected' => '<div class="notice" role="alert"><p>A notice with an additional attribute role.</p></div>',
),
'multiple additional attributes' => array(
'message' => 'A notice with multiple additional attributes.',
'args' => array(
'attributes' => array(
'role' => 'alert',
'data-test' => -1,
),
),
'expected' => '<div class="notice" role="alert" data-test="-1"><p>A notice with multiple additional attributes.</p></div>',
),
'data attribute with unsafe value' => array(
'message' => 'A notice with an additional attribute with an unsafe value.',
'args' => array(
'attributes' => array( 'data-unsafe' => '<script>alert( "Howdy, admin!" );</script>' ),
),
'expected' => '<div class="notice" data-unsafe="&lt;script&gt;alert( &quot;Howdy, admin!&quot; );&lt;/script&gt;"><p>A notice with an additional attribute with an unsafe value.</p></div>',
),
'multiple attributes with "role", invalid, data-*, numeric, and boolean' => array(
'message' => 'A notice with multiple attributes with "role", invalid, "data-*", numeric, and boolean.',
'args' => array(
'attributes' => array(
'role' => 'alert',
'disabled' => 'disabled',
'data-name' => 'my-name',
'data-id' => 1,
'hidden',
),
),
'expected' => '<div class="notice" role="alert" disabled="disabled" data-name="my-name" data-id="1" hidden><p>A notice with multiple attributes with "role", invalid, "data-*", numeric, and boolean.</p></div>',
),
'paragraph wrapping as a falsy value rather than (bool) false' => array(
'message' => 'A notice with paragraph wrapping as a falsy value rather than (bool) false.',
'args' => array(
'paragraph_wrap' => 0,
),
'expected' => '<div class="notice"><p>A notice with paragraph wrapping as a falsy value rather than (bool) false.</p></div>',
),
);
}
/**
* Tests that `wp_get_admin_notice()` throws a `_doing_it_wrong()` when
* a 'type' containing spaces is passed.
*
* @ticket 57791
*
* @expectedIncorrectUsage wp_get_admin_notice
*/
public function test_should_throw_doing_it_wrong_with_a_type_containing_spaces() {
$this->assertSame(
'<div class="notice notice-first second third fourth"><p>A type containing spaces.</p></div>',
wp_get_admin_notice(
'A type containing spaces.',
array( 'type' => 'first second third fourth' )
)
);
}
/**
* Tests that `wp_get_admin_notice()` applies filters.
*
* @ticket 57791
*
* @dataProvider data_should_apply_filters
*
* @param string $hook_name The name of the filter hook.
*/
public function test_should_apply_filters( $hook_name ) {
$filter = new MockAction();
add_filter( $hook_name, array( $filter, 'filter' ) );
wp_get_admin_notice( 'A notice.', array( 'type' => 'success' ) );
$this->assertSame( 1, $filter->get_call_count() );
}
/**
* Data provider.
*
* @return array[]
*/
public function data_should_apply_filters() {
return array(
'wp_admin_notice_args' => array( 'hook_name' => 'wp_admin_notice_args' ),
'wp_admin_notice_markup' => array( 'hook_name' => 'wp_admin_notice_markup' ),
);
}
}
<?php
/**
* Tests for `wp_get_admin_notice()`.
*
* @group functions
*
* @covers ::wp_get_admin_notice
*/
class Tests_Functions_WpGetAdminNotice extends WP_UnitTestCase {
/**
* Tests that `wp_get_admin_notice()` returns the expected admin notice markup.
*
* @ticket 57791
*
* @dataProvider data_should_return_admin_notice
*
* @param string $message The message.
* @param array $args Arguments for the admin notice.
* @param string $expected The expected admin notice markup.
*/
public function test_should_return_admin_notice( $message, $args, $expected ) {
$this->assertSame( $expected, wp_get_admin_notice( $message, $args ) );
}
/**
* Data provider.
*
* @return array[]
*/
public function data_should_return_admin_notice() {
return array(
'defaults' => array(
'message' => 'A notice with defaults.',
'args' => array(),
'expected' => '<div class="notice"><p>A notice with defaults.</p></div>',
),
'an empty message (used for templates)' => array(
'message' => '',
'args' => array(
'type' => 'error',
'dismissible' => true,
'id' => 'message',
'additional_classes' => array( 'inline', 'hidden' ),
),
'expected' => '<div id="message" class="notice notice-error is-dismissible inline hidden"><p></p></div>',
),
'an empty message (used for templates) without paragraph wrapping' => array(
'message' => '',
'args' => array(
'type' => 'error',
'dismissible' => true,
'id' => 'message',
'additional_classes' => array( 'inline', 'hidden' ),
'paragraph_wrap' => false,
),
'expected' => '<div id="message" class="notice notice-error is-dismissible inline hidden"></div>',
),
'an "error" notice' => array(
'message' => 'An "error" notice.',
'args' => array(
'type' => 'error',
),
'expected' => '<div class="notice notice-error"><p>An "error" notice.</p></div>',
),
'a "success" notice' => array(
'message' => 'A "success" notice.',
'args' => array(
'type' => 'success',
),
'expected' => '<div class="notice notice-success"><p>A "success" notice.</p></div>',
),
'a "warning" notice' => array(
'message' => 'A "warning" notice.',
'args' => array(
'type' => 'warning',
),
'expected' => '<div class="notice notice-warning"><p>A "warning" notice.</p></div>',
),
'an "info" notice' => array(
'message' => 'An "info" notice.',
'args' => array(
'type' => 'info',
),
'expected' => '<div class="notice notice-info"><p>An "info" notice.</p></div>',
),
'a type that already starts with "notice-"' => array(
'message' => 'A type that already starts with "notice-".',
'args' => array(
'type' => 'notice-info',
),
'expected' => '<div class="notice notice-notice-info"><p>A type that already starts with "notice-".</p></div>',
),
'a dismissible notice' => array(
'message' => 'A dismissible notice.',
'args' => array(
'dismissible' => true,
),
'expected' => '<div class="notice is-dismissible"><p>A dismissible notice.</p></div>',
),
'no type and an ID' => array(
'message' => 'A notice with an ID.',
'args' => array(
'id' => 'message',
),
'expected' => '<div id="message" class="notice"><p>A notice with an ID.</p></div>',
),
'a type and an ID' => array(
'message' => 'A warning notice with an ID.',
'args' => array(
'type' => 'warning',
'id' => 'message',
),
'expected' => '<div id="message" class="notice notice-warning"><p>A warning notice with an ID.</p></div>',
),
'no type and additional classes' => array(
'message' => 'A notice with additional classes.',
'args' => array(
'additional_classes' => array( 'error', 'notice-alt' ),
),
'expected' => '<div class="notice error notice-alt"><p>A notice with additional classes.</p></div>',
),
'a type and additional classes' => array(
'message' => 'A warning notice with additional classes.',
'args' => array(
'type' => 'warning',
'additional_classes' => array( 'error', 'notice-alt' ),
),
'expected' => '<div class="notice notice-warning error notice-alt"><p>A warning notice with additional classes.</p></div>',
),
'a dismissible notice with a type and additional classes' => array(
'message' => 'A dismissible warning notice with a type and additional classes.',
'args' => array(
'type' => 'warning',
'dismissible' => true,
'additional_classes' => array( 'error', 'notice-alt' ),
),
'expected' => '<div class="notice notice-warning is-dismissible error notice-alt"><p>A dismissible warning notice with a type and additional classes.</p></div>',
),
'a notice without paragraph wrapping' => array(
'message' => '<span>A notice without paragraph wrapping.</span>',
'args' => array(
'paragraph_wrap' => false,
),
'expected' => '<div class="notice"><span>A notice without paragraph wrapping.</span></div>',
),
'an unsafe type' => array(
'message' => 'A notice with an unsafe type.',
'args' => array(
'type' => '"><script>alert("Howdy,admin!");</script>',
),
'expected' => '<div class="notice notice-"><script>alert("Howdy,admin!");</script>"><p>A notice with an unsafe type.</p></div>',
),
'an unsafe ID' => array(
'message' => 'A notice with an unsafe ID.',
'args' => array(
'id' => '"><script>alert( "Howdy, admin!" );</script> <div class="notice',
),
'expected' => '<div id=""><script>alert( "Howdy, admin!" );</script> <div class="notice" class="notice"><p>A notice with an unsafe ID.</p></div>',
),
'unsafe additional classes' => array(
'message' => 'A notice with unsafe additional classes.',
'args' => array(
'additional_classes' => array( '"><script>alert( "Howdy, admin!" );</script> <div class="notice' ),
),
'expected' => '<div class="notice "><script>alert( "Howdy, admin!" );</script> <div class="notice"><p>A notice with unsafe additional classes.</p></div>',
),
'a type that is not a string' => array(
'message' => 'A notice with a type that is not a string.',
'args' => array(
'type' => array(),
),
'expected' => '<div class="notice"><p>A notice with a type that is not a string.</p></div>',
),
'a type with only empty space' => array(
'message' => 'A notice with a type with only empty space.',
'args' => array(
'type' => " \t\r\n",
),
'expected' => '<div class="notice"><p>A notice with a type with only empty space.</p></div>',
),
'an ID that is not a string' => array(
'message' => 'A notice with an ID that is not a string.',
'args' => array(
'id' => array( 'message' ),
),
'expected' => '<div class="notice"><p>A notice with an ID that is not a string.</p></div>',
),
'an ID with only empty space' => array(
'message' => 'A notice with an ID with only empty space.',
'args' => array(
'id' => " \t\r\n",
),
'expected' => '<div class="notice"><p>A notice with an ID with only empty space.</p></div>',
),
'dismissible as a truthy value rather than (bool) true' => array(
'message' => 'A notice with dismissible as a truthy value rather than (bool) true.',
'args' => array(
'dismissible' => 1,
),
'expected' => '<div class="notice"><p>A notice with dismissible as a truthy value rather than (bool) true.</p></div>',
),
'additional classes that are not an array' => array(
'message' => 'A notice with additional classes that are not an array.',
'args' => array(
'additional_classes' => 'class-1 class-2 class-3',
),
'expected' => '<div class="notice"><p>A notice with additional classes that are not an array.</p></div>',
),
'additional attribute with a value' => array(
'message' => 'A notice with an additional attribute with a value.',
'args' => array(
'attributes' => array( 'aria-live' => 'assertive' ),
),
'expected' => '<div class="notice" aria-live="assertive"><p>A notice with an additional attribute with a value.</p></div>',
),
'additional hidden attribute' => array(
'message' => 'A notice with the hidden attribute.',
'args' => array(
'attributes' => array( 'hidden' => true ),
),
'expected' => '<div class="notice" hidden><p>A notice with the hidden attribute.</p></div>',
),
'additional attribute no associative keys' => array(
'message' => 'A notice with a boolean attribute without an associative key.',
'args' => array(
'attributes' => array( 'hidden' ),
),
'expected' => '<div class="notice" hidden><p>A notice with a boolean attribute without an associative key.</p></div>',
),
'additional attribute with role' => array(
'message' => 'A notice with an additional attribute role.',
'args' => array(
'attributes' => array( 'role' => 'alert' ),
),
'expected' => '<div class="notice" role="alert"><p>A notice with an additional attribute role.</p></div>',
),
'multiple additional attributes' => array(
'message' => 'A notice with multiple additional attributes.',
'args' => array(
'attributes' => array(
'role' => 'alert',
'data-test' => -1,
),
),
'expected' => '<div class="notice" role="alert" data-test="-1"><p>A notice with multiple additional attributes.</p></div>',
),
'data attribute with unsafe value' => array(
'message' => 'A notice with an additional attribute with an unsafe value.',
'args' => array(
'attributes' => array( 'data-unsafe' => '<script>alert( "Howdy, admin!" );</script>' ),
),
'expected' => '<div class="notice" data-unsafe="&lt;script&gt;alert( &quot;Howdy, admin!&quot; );&lt;/script&gt;"><p>A notice with an additional attribute with an unsafe value.</p></div>',
),
'multiple attributes with "role", invalid, data-*, numeric, and boolean' => array(
'message' => 'A notice with multiple attributes with "role", invalid, "data-*", numeric, and boolean.',
'args' => array(
'attributes' => array(
'role' => 'alert',
'disabled' => 'disabled',
'data-name' => 'my-name',
'data-id' => 1,
'hidden',
),
),
'expected' => '<div class="notice" role="alert" disabled="disabled" data-name="my-name" data-id="1" hidden><p>A notice with multiple attributes with "role", invalid, "data-*", numeric, and boolean.</p></div>',
),
'paragraph wrapping as a falsy value rather than (bool) false' => array(
'message' => 'A notice with paragraph wrapping as a falsy value rather than (bool) false.',
'args' => array(
'paragraph_wrap' => 0,
),
'expected' => '<div class="notice"><p>A notice with paragraph wrapping as a falsy value rather than (bool) false.</p></div>',
),
);
}
/**
* Tests that `wp_get_admin_notice()` throws a `_doing_it_wrong()` when
* a 'type' containing spaces is passed.
*
* @ticket 57791
*
* @expectedIncorrectUsage wp_get_admin_notice
*/
public function test_should_throw_doing_it_wrong_with_a_type_containing_spaces() {
$this->assertSame(
'<div class="notice notice-first second third fourth"><p>A type containing spaces.</p></div>',
wp_get_admin_notice(
'A type containing spaces.',
array( 'type' => 'first second third fourth' )
)
);
}
/**
* Tests that `wp_get_admin_notice()` applies filters.
*
* @ticket 57791
*
* @dataProvider data_should_apply_filters
*
* @param string $hook_name The name of the filter hook.
*/
public function test_should_apply_filters( $hook_name ) {
$filter = new MockAction();
add_filter( $hook_name, array( $filter, 'filter' ) );
wp_get_admin_notice( 'A notice.', array( 'type' => 'success' ) );
$this->assertSame( 1, $filter->get_call_count() );
}
/**
* Data provider.
*
* @return array[]
*/
public function data_should_apply_filters() {
return array(
'wp_admin_notice_args' => array( 'hook_name' => 'wp_admin_notice_args' ),
'wp_admin_notice_markup' => array( 'hook_name' => 'wp_admin_notice_markup' ),
);
}
}