Skip to content

gw-require-alt-text-description-post-image.php: Added snippet for requiring Alt Text and Description in Post Image Field. #1077

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
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

gw-require-alt-text-description-post-image.php: Added snippet for requiring Alt Text and Description in Post Image Field. #1077

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
36 changes: 36 additions & 0 deletions gravity-forms/gw-require-alt-text-description-post-image.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
<?php
/**
* Gravity Wiz // Gravity Forms // Required Alt Text & Description for Post Image Field
* https://gravitywiz.com/
*
* Ensures the Alt Text and Description for the Post Image field are required if the field is marked as required.
*
* Instruction Video: https://www.loom.com/share/6d0e70da14c64f5ea40d0aa0f918684d
*
* Plugin Name: Gravity Forms - Required Alt Text & Description for Post Image Field
* Plugin URI: https://gravitywiz.com/
* Description: Ensures the Alt Text and Description for the Post Image field are required if the field is marked as required.
* Author: Gravity Wiz
* Version: 1.0
* Author URI: https://gravitywiz.com/
*/
add_filter( 'gform_field_validation', function ( $result, $value, $form, $field ) {
if ( $field->type == 'post_image' && $field->displayAlt && $field->displayDescription && $field->wasRequired ) {

$alt_text = $value[ $field->id . '.2' ];
$description = $value[ $field->id . '.7' ];

if ( ! $alt_text && ! $description ) {
$result['is_valid'] = false;
$result['message'] = 'Check Post Image. Please enter Alt Text and Description.';
} elseif ( ! $alt_text ) {
$result['is_valid'] = false;
$result['message'] = 'Check Post Image. Please enter Alt Text.';
} elseif ( ! $description ) {
$result['is_valid'] = false;
$result['message'] = 'Check Post Image. Please enter Description.';
}
Comment on lines +23 to +32
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Implement internationalization for user-facing messages.

Error messages should use WordPress internationalization functions to support translation. Also, consider using more robust empty value checking with empty() instead of just negation.

- if ( ! $alt_text && ! $description ) {
+ if ( empty( $alt_text ) && empty( $description ) ) {
  	$result['is_valid'] = false;
-   $result['message']  = 'Check Post Image. Please enter Alt Text and Description.';
+   $result['message']  = esc_html__( 'Check Post Image. Please enter Alt Text and Description.', 'gw-require-alt-text' );
- } elseif ( ! $alt_text ) {
+ } elseif ( empty( $alt_text ) ) {
  	$result['is_valid'] = false;
-   $result['message']  = 'Check Post Image. Please enter Alt Text.';
+   $result['message']  = esc_html__( 'Check Post Image. Please enter Alt Text.', 'gw-require-alt-text' );
- } elseif ( ! $description ) {
+ } elseif ( empty( $description ) ) {
  	$result['is_valid'] = false;
-   $result['message']  = 'Check Post Image. Please enter Description.';
+   $result['message']  = esc_html__( 'Check Post Image. Please enter Description.', 'gw-require-alt-text' );
  }
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
if ( ! $alt_text && ! $description ) {
$result['is_valid'] = false;
$result['message'] = 'Check Post Image. Please enter Alt Text and Description.';
} elseif ( ! $alt_text ) {
$result['is_valid'] = false;
$result['message'] = 'Check Post Image. Please enter Alt Text.';
} elseif ( ! $description ) {
$result['is_valid'] = false;
$result['message'] = 'Check Post Image. Please enter Description.';
}
if ( empty( $alt_text ) && empty( $description ) ) {
$result['is_valid'] = false;
$result['message'] = esc_html__( 'Check Post Image. Please enter Alt Text and Description.', 'gw-require-alt-text' );
} elseif ( empty( $alt_text ) ) {
$result['is_valid'] = false;
$result['message'] = esc_html__( 'Check Post Image. Please enter Alt Text.', 'gw-require-alt-text' );
} elseif ( empty( $description ) ) {
$result['is_valid'] = false;
$result['message'] = esc_html__( 'Check Post Image. Please enter Description.', 'gw-require-alt-text' );
}


}
return $result;
}, 10, 4 );
Loading