Add image credits edit capabilities to the edit theme modal (#662)

* add image credits edit capabilities * fix typo and add translation mark Co-authored-by: Aki Hamano <[email protected]> --------- Co-authored-by: Aki Hamano <[email protected]>
WordPress · Jun 3, 2024 · ee38f23 · ee38f23
1 parent c3666a5
commit ee38f23
Show file tree

Hide file tree

Showing 3 changed files with 65 additions and 3 deletions.
diff --git a/includes/class-create-block-theme-api.php b/includes/class-create-block-theme-api.php
@@ -555,6 +555,7 @@ private function sanitize_theme_data( $theme ) {
 		$sanitized_theme['screenshot']          = sanitize_text_field( $theme['screenshot'] ?? '' );
 		$sanitized_theme['recommended_plugins'] = sanitize_textarea_field( $theme['recommended_plugins'] ?? '' );
 		$sanitized_theme['font_credits']        = sanitize_textarea_field( $theme['font_credits'] ?? '' );
+		$sanitized_theme['image_credits']       = sanitize_textarea_field( $theme['image_credits'] ?? '' );
 		$sanitized_theme['template']            = '';
 		$sanitized_theme['slug']                = sanitize_title( $theme['name'] );
 		$sanitized_theme['text_domain']         = $sanitized_theme['slug'];

diff --git a/src/editor-sidebar/metadata-editor-modal.js b/src/editor-sidebar/metadata-editor-modal.js
@@ -50,6 +50,7 @@ export const ThemeMetadataEditorModal = ( { onRequestClose } ) => {
 		tags_custom: '',
 		recommended_plugins: '',
 		font_credits: '',
+		image_credits: '',
 		subfolder: '',
 	} );
 
@@ -70,6 +71,7 @@ export const ThemeMetadataEditorModal = ( { onRequestClose } ) => {
 			screenshot: themeData.screenshot,
 			recommended_plugins: readmeData.recommended_plugins,
 			font_credits: readmeData.fonts,
+			image_credits: readmeData.images,
 			subfolder:
 				themeData.stylesheet.lastIndexOf( '/' ) > 1
 					? themeData.stylesheet.substring(
@@ -291,6 +293,38 @@ ${ __( 'Source', 'create-block-theme' ) }` }
 					}
 				/>
 
+				<TextareaControl
+					label={ __( 'Image Credits', 'create-block-theme' ) }
+					help={
+						<>
+							{ __(
+								'Credits for the images bundled with the theme.',
+								'create-block-theme'
+							) }
+							<br />
+							<ExternalLink
+								href={ __(
+									'https://make.wordpress.org/themes/handbook/review/required/#1-licensing-copyright',
+									'create-block-theme'
+								) }
+							>
+								{ __( 'Read more.', 'create-block-theme' ) }
+							</ExternalLink>
+						</>
+					}
+					// eslint-disable-next-line @wordpress/i18n-no-collapsible-whitespace
+					placeholder={ __(
+						`Image filename
+Image source URL
+Image license`,
+						'create-block-theme'
+					) }
+					value={ theme.image_credits }
+					onChange={ ( value ) =>
+						setTheme( { ...theme, image_credits: value } )
+					}
+				/>
+
 				<BaseControl>
 					<BaseControl.VisualLabel>
 						{ __( 'Screenshot', 'create-block-theme' ) }

diff --git a/tests/CbtThemeReadme/create.php b/tests/CbtThemeReadme/create.php
@@ -29,13 +29,15 @@ public function test_create( $data ) {
 		$expected_php_version         = 'Requires PHP: ' . $data['required_php_version'];
 		$expected_license             = 'License: ' . $data['license'];
 		$expected_license_uri         = 'License URI: ' . $data['license_uri'];
-		$expected_image_credits       = '== Images ==' . $data['image_credits'];
+		$expected_font_credits        = '== Fonts ==' .
+			( isset( $data['font_credits'] ) ? $data['font_credits'] : '' );
+		$expected_image_credits       = '== Images ==' .
+			( isset( $data['image_credits'] ) ? $data['image_credits'] : '' );
 		$expected_recommended_plugins = '== Recommended Plugins ==' . $data['recommended_plugins'];
 
 		$this->assertStringContainsString( $expected_name, $readme_without_newlines, 'The expected name is missing.' );
 		$this->assertStringContainsString( $expected_author, $readme_without_newlines, 'The expected author is missing.' );
 		$this->assertStringContainsString( $expected_wp_version, $readme_without_newlines, 'The expected WP version is missing.' );
-		$this->assertStringContainsString( $expected_image_credits, $readme_without_newlines, 'The expected image credits are missing.' );
 		$this->assertStringContainsString( $expected_recommended_plugins, $readme_without_newlines, 'The expected recommended plugins are missing.' );
 
 		// Assetion specific to child themes.
@@ -58,8 +60,17 @@ public function test_create( $data ) {
 
 		// Assertion specific to font credits.
 		if ( isset( $data['font_credits'] ) ) {
-			$expected_font_credits = '== Fonts ==' . $data['font_credits'];
 			$this->assertStringContainsString( $expected_font_credits, $readme_without_newlines, 'The expected font credits are missing.' );
+		} else {
+			$this->assertStringNotContainsString( $expected_font_credits, $readme_without_newlines, 'The font credits title should not be present if font credits were not defined.' );
+		}
+
+		// Assertion specific to imagee credits.
+		if ( isset( $data['image_credits'] ) ) {
+			$this->assertStringContainsString( $expected_image_credits, $readme_without_newlines, 'The expected image credits are missing.' );
+		} else {
+			$this->assertStringNotContainsString( $expected_image_credits, $readme_without_newlines, 'The image credits title should not be present if image_credits were not defined.' );
+
 		}
 	}
 
@@ -130,8 +141,24 @@ public function data_test_create() {
 					'required_php_version' => '10.0',
 					'license'              => 'GPLv2 or later',
 					'license_uri'          => 'https://www.gnu.org/licenses/gpl-2.0.html',
+					'recommended_plugins'  => 'The theme is best used with the following plugins: Plugin 1, Plugin 2, Plugin 3.',
 					'image_credits'        => 'The images were taken from https://example.org and have a CC0 license.',
+				),
+			),
+			'missing image credits'            => array(
+				'data' => array(
+					'name'                 => 'My Theme',
+					'description'          => 'New theme description',
+					'uri'                  => 'https://example.com',
+					'author'               => 'New theme author',
+					'author_uri'           => 'https://example.com/author',
+					'copyright_year'       => '2077',
+					'wp_version'           => '12.12',
+					'required_php_version' => '10.0',
+					'license'              => 'GPLv2 or later',
+					'license_uri'          => 'https://www.gnu.org/licenses/gpl-2.0.html',
 					'recommended_plugins'  => 'The theme is best used with the following plugins: Plugin 1, Plugin 2, Plugin 3.',
+					'font_credits'         => 'Font credit example text',
 				),
 			),
 			// TODO: Add more test cases.