64892 get_submit_button() should support "compact" button shorthand

[nirav7707]

Core trac: https://core.trac.wordpress.org/ticket/64892

Test:
Large

Compact

Small

[github-actions]

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props niravsherasiya7707, wildworks, motylanogha.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

[github-actions]

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

• All changes will be lost when closing a tab with a Playground instance.
• All changes will be lost when refreshing the page.
• A fresh instance is created each time the link below is clicked.
• Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
  it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

[t-hamano]

Thanks for the PR! Can you update the following PHPDocs?

wordpress-develop/src/wp-admin/includes/template.php

Line 2564 in 77850fb

* include 'primary', 'small', and 'large'. Default 'primary'.

wordpress-develop/src/wp-admin/includes/template.php

Line 2588 in 77850fb

* include 'primary', 'small', and 'large'. Default 'primary large'.

[t-hamano]

LGTM!

[wppoland]

get_submit_button() currently has no test coverage, so here are tests that lock in the new compact shorthand alongside the existing ones. The compact, primary compact, and standalone-compact cases fail on trunk and pass with this PR; the rest document existing behavior.

Goes in tests/phpunit/tests/admin/includesTemplate.php:

	/**
	 * Ensures the 'compact' button variation is recognized as a shorthand and
	 * rendered as the `button-compact` CSS class.
	 *
	 * @ticket 64892
	 *
	 * @covers ::get_submit_button
	 */
	public function test_get_submit_button_supports_compact_shorthand() {
		$button = get_submit_button( 'Save', 'compact', 'submit', false );

		$this->assertStringContainsString(
			'class="button button-compact"',
			$button,
			'The "compact" type was not converted to the "button-compact" shorthand class.'
		);
	}

	/**
	 * Ensures recognized button shorthands are converted to their `button-*`
	 * classes, while non-shorthand values are passed through verbatim.
	 *
	 * @ticket 64892
	 *
	 * @covers ::get_submit_button
	 *
	 * @dataProvider data_get_submit_button_shorthand_classes
	 *
	 * @param string $type           The button type passed to get_submit_button().
	 * @param string $expected_class The expected value of the class attribute.
	 */
	public function test_get_submit_button_shorthand_classes( $type, $expected_class ) {
		$button = get_submit_button( 'Save', $type, 'submit', false );

		$this->assertStringContainsString(
			'class="' . $expected_class . '"',
			$button,
			"The button type \"{$type}\" did not produce the expected class attribute."
		);
	}

	/**
	 * Data provider.
	 *
	 * @return array[]
	 */
	public function data_get_submit_button_shorthand_classes() {
		return array(
			'primary'           => array( 'primary', 'button button-primary' ),
			'small'             => array( 'small', 'button button-small' ),
			'large'             => array( 'large', 'button button-large' ),
			'compact'           => array( 'compact', 'button button-compact' ),
			'primary + compact' => array( 'primary compact', 'button button-primary button-compact' ),
			'secondary skipped' => array( 'secondary', 'button' ),
			'custom passthru'   => array( 'my-custom-class', 'button my-custom-class' ),
		);
	}

Happy to push these as a commit if preferred.

[t-hamano]

@wppoland Thanks for the suggestion!

@nirav7707. Could you add some unit tests?

Additionally, all instances where submit_button() is called would benefit from using the shorthand, like so:

diff --git a/src/wp-admin/includes/media.php b/src/wp-admin/includes/media.php
index 71ae2a9eea..d960373dbc 100644
--- a/src/wp-admin/includes/media.php
+++ b/src/wp-admin/includes/media.php
@@ -2905,7 +2905,7 @@ function media_upload_library_form( $errors ) {
                        </select>
                <?php } ?>
 
-               <?php submit_button( __( 'Filter &#187;' ), 'button-compact', 'post-query-submit', false ); ?>
+               <?php submit_button( __( 'Filter &#187;' ), 'compact', 'post-query-submit', false ); ?>
 
        </div>

[t-hamano]

Hi @nirav7707, Do you have the bandwidth to address the following feedback? Thank you!

@nirav7707. Could you add some unit tests?

Additionally, all instances where submit_button() is called would benefit from using the shorthand, like so:

[t-hamano]

Additionally, all instances where submit_button() is called would benefit from using the shorthand, like so:

Addressed in be35955

[t-hamano]

get_submit_button() currently has no test coverage, so here are tests that lock in the new compact shorthand alongside the existing ones. The compact, primary compact, and standalone-compact cases fail on trunk and pass with this PR; the rest document existing behavior.

Thank you for your suggestion! I've pushed the unit tests referring to your code. 24c2790

[github-actions]

A commit was made that fixes the Trac ticket referenced in the description of this pull request.

SVN changeset: 62756
GitHub commit: e7f523f

This PR will be closed, but please confirm the accuracy of this and reopen if there is more work to be done.

[wppoland]

Verified the unit tests locally on the branch, they pass successfully: OK (35 tests, 119 assertions).