feat: add settings page, and show placeholder if no credit #9

dkoo · 2021-08-23T20:20:50Z

Adds a new settings page for Image Credits options under the WP Admin > Settings > Media menu (placed there because this plugin has no dependencies on other Newspack products). New options available:

Image Credit Class Name: Lets you set the CSS class name given to the span that wraps image credit strings. This defaults to image-credit, which was previously hard-coded, so it shouldn't change behavior for sites that are already using the plugin.
Image Credit Label: Lets you change the label printed before image credits. This defaults to Credit: , which was previously hard-coded, so it shouldn't change behavior for sites that are already using the plugin.
Placeholder Image: Lets you choose an image from the media library to be displayed in place of any image that lacks a credit. This should help publishers avoid legal trouble in the event of messy migrations that fail to bring over all credit data. Will work for featured images, core/image blocks, and jetpack/slideshow blocks.

Note: The options have been moved to the Media settings page instead of living in their own standalone page.

To test:

The first two options (class name and label) are straightforward: test with the default options, then with updated options, and then with empty options. Verify that the settings are respected on the front-end for all three contexts (featured image, core image block, Jetpack slideshow block).
For the placeholder image, first verify that without choosing any image, behavior is unchanged. Images are rendered as usual with or without a credit.
Choose a placeholder image from the Media Library, then save.
Now verify that any images that lack a credit are replaced by the chosen placeholder image (just the image, not the caption or anything else having to do with the image) in all contexts.
Add a credit to images that are missing them and verify that after a refresh, the images render instead of the placeholder.
Remove the placeholder in settings, save, and verify that all images behave as usual.

dkoo · 2021-08-23T22:02:12Z

Also adds a newspack_image_credits_media_credit filter on the credits data output, as suggested by @benlk.

…ne page

miguelpeixe

It's working great! Crazy to see all my images being replaced for a placeholder 😅

I've left some comments for small adjustments and there's also a tiny but very annoying UX detail: when I write the credit name to the image, I then press tab to start writing the next field. This action fires a save action and after it succeeds the field I'm writing loses focus and I start triggering keyboard shortcuts 😆 . I don't know why this happens only to the image credits fields.

miguelpeixe · 2021-08-24T20:32:42Z

includes/class-newspack-image-credits-settings.php

+			[
+				'description' => __( 'A label to prefix all image credits. Leave blank to display no prefix.', 'newspack-image-credits' ),
+				'key'         => 'newspack_image_credits_prefix_label',
+				'label'       => __( 'Image Credit Label', 'newpack-listings' ),


Need to change the domain from newspack-listing to newspack-image-credits

Whoops! Updated in fcc3699

miguelpeixe · 2021-08-24T20:32:52Z

includes/class-newspack-image-credits-settings.php

+			[
+				'description' => __( 'A placeholder image to be displayed in place of images without credits. If none is chosen, the image will be displayed normally whether or not it has a credit.', 'newspack-image-credits' ),
+				'key'         => 'newspack_image_credits_placeholder',
+				'label'       => __( 'Placeholder Image', 'newpack-listings' ),


Need to change the domain from newspack-listing to newspack-image-credits

Whoops! Updated in fcc3699

miguelpeixe · 2021-08-24T20:37:26Z

includes/class-newspack-image-credits.php

+	 */
+	public static function add_media_credit( $fields, $post ) {
+		$credit_info = self::get_media_credit( $post->ID );
+        $fields['media_credit'] = [


Update indentation from space to tabs.

Updated in fcc3699

miguelpeixe · 2021-08-24T20:41:00Z

package.json

+		"prettier": "https://github.com/Automattic/wp-prettier/releases/download/wp-1.16.4/wp-prettier-1.16.4.tgz",
+		"stylelint": "^13.12.0",
+		"stylelint-config-prettier": "^8.0.1",
+		"stylelint-config-wordpress": "^17.0.0",


Non-blocking: stylelint-config-wordpress has been deprecated in favor of @wordpress/stylelint-config. Should we start using the maintained package?

Updated in 1fcfcbe

…nt-config-wordpress

dkoo · 2021-08-24T22:42:02Z

when I write the credit name to the image, I then press tab to start writing the next field. This action fires a save action and after it succeeds the field I'm writing loses focus and I start triggering keyboard shortcuts 😆 . I don't know why this happens only to the image credits fields.

@miguelpeixe I'm also not sure why this is, but the fields are added using the attachment_fields_to_edit and attachment_fields_to_save filter hooks. I don't see any options available here to change focus/blur behavior.

miguelpeixe

It's probably a core issue. Thank you for the updates! 💯

dkoo added 2 commits August 23, 2021 14:04

feat: add settings page, and show placeholder if no credit

c3676b3

feat: inherit size of original image request

c19f83d

dkoo added the enhancement New feature or request label Aug 23, 2021

dkoo requested a review from a team August 23, 2021 20:20

dkoo self-assigned this Aug 23, 2021

dkoo added 2 commits August 23, 2021 14:30

feat: add release script

22c0953

chore: remove console.logs

8c14a01

dkoo linked an issue Aug 23, 2021 that may be closed by this pull request

Show placeholder image if no credit #8

Closed

feat: add filter for credit; fix undefined variable warning

c78ed6c

dkoo added 3 commits August 23, 2021 16:49

feat: move settings fields to Media settings page instead of standalo…

8a4bd0b

…ne page

fix: allow saving from media page

cdd34fd

chore: remove unneeded files from release package

10d1f54

miguelpeixe suggested changes Aug 24, 2021

View reviewed changes

dkoo added 2 commits August 24, 2021 16:34

fix: feedback from code review

fcc3699

chore: use @wordpress/stylelint-config in favor of deprecated styleli…

1fcfcbe

…nt-config-wordpress

dkoo requested a review from miguelpeixe August 24, 2021 22:40

miguelpeixe approved these changes Aug 25, 2021

View reviewed changes

dkoo merged commit c42b853 into master Aug 25, 2021

dkoo deleted the feat/settings-and-placeholder branch August 25, 2021 19:21

dkoo mentioned this pull request Sep 17, 2021

feat: integrate newspack-image-credits into main plugin and wizard UI Automattic/newspack-plugin#1147

Merged

6 tasks

gamebits mentioned this pull request Oct 10, 2021

Add ability to change"Credit:" caption prefix. #3

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add settings page, and show placeholder if no credit #9

feat: add settings page, and show placeholder if no credit #9

dkoo commented Aug 23, 2021 •

edited

Loading

dkoo commented Aug 23, 2021

miguelpeixe left a comment

miguelpeixe Aug 24, 2021

dkoo Aug 24, 2021

miguelpeixe Aug 24, 2021

dkoo Aug 24, 2021

miguelpeixe Aug 24, 2021

dkoo Aug 24, 2021

miguelpeixe Aug 24, 2021 •

edited

Loading

dkoo Aug 24, 2021

dkoo commented Aug 24, 2021

miguelpeixe left a comment

feat: add settings page, and show placeholder if no credit #9

feat: add settings page, and show placeholder if no credit #9

Conversation

dkoo commented Aug 23, 2021 • edited Loading

dkoo commented Aug 23, 2021

miguelpeixe left a comment

Choose a reason for hiding this comment

miguelpeixe Aug 24, 2021

Choose a reason for hiding this comment

dkoo Aug 24, 2021

Choose a reason for hiding this comment

miguelpeixe Aug 24, 2021

Choose a reason for hiding this comment

dkoo Aug 24, 2021

Choose a reason for hiding this comment

miguelpeixe Aug 24, 2021

Choose a reason for hiding this comment

dkoo Aug 24, 2021

Choose a reason for hiding this comment

miguelpeixe Aug 24, 2021 • edited Loading

Choose a reason for hiding this comment

dkoo Aug 24, 2021

Choose a reason for hiding this comment

dkoo commented Aug 24, 2021

miguelpeixe left a comment

Choose a reason for hiding this comment

dkoo commented Aug 23, 2021 •

edited

Loading

miguelpeixe Aug 24, 2021 •

edited

Loading