Merge pull request #7 from arunbasillal/branch-3.1

Branch 3.1

Author: arunbasillal

README.md

@@ -47,7 +47,7 @@ What the pro add-on you get these additional features:
 * Use post title as alt text. If image is not attached to a post, image filename will be used instead.
 * Use post title as caption. If image is not attached to a post, image filename will be used instead.
 * Use post title as description. If image is not attached to a post, image filename will be used instead.
-* Build your own attributes using custom tags like `%filename%`, `%posttitle%`, `%sitetitle%`, `%yoastfocuskw%`, `%rankmathfocuskw%`. Each custom tag will be replaced  with it's value. You can combine them as you please!
+* Build your own attributes using custom tags like `%filename%`, `%posttitle%`, `%sitetitle%`, `%category%`, `%tag%`, `%yoastfocuskw%`, `%rankmathfocuskw%`, `%seopresstargetkw%`. Each custom tag will be replaced  with it's value. You can combine them as you please!
 * Use Yoast Focus Keyword and Rank Math Focus Keyword as image attributes.
 * Clear any image attribute by setting it as blank / empty. 
 * Exclude images from Bulk Updater. A meta box and a checkbox is added to the `Media Library` > `Edit Media` sidebar. When checked, the bulk updater will not update the attributes of that image in the media library or in posts / products where the image is used.
@@ -68,21 +68,26 @@ What the pro add-on you get these additional features:
 * Clean the actual image filename after upload.
 * Choose to turn off any of the above mentioned features.
 
-With the pro bulk updater you can:
+With the Image Attributes Pro bulk updater you can:
 
 * Update image title and alt text for images inserted into posts and custom post types. Not just the media library. [What is the difference?](https://imageattributespro.com/how-wordpress-store-image-attributes/?utm_source=github&utm_medium=readme.md)
 * Fine tune all settings. Choose what to update.
 * Update image titles / alt text in media library only. Image titles / alt text in existing posts will be left unchanged.
 * Update image titles / alt text in media library and existing posts.
 * Update image titles / alt text in media library and existing posts only if no title / alt text is set. Existing image titles / alt text will not be changed.
 * Update image caption and description in the media library. Existing image captions and descriptions can be preserved.
-* Build your own attributes using custom tags like `%filename%`, `%posttitle%`, `%sitetitle%`, `%yoastfocuskw%`, `%rankmathfocuskw%`. Each custom tag will be replaced  with it's value. You can combine them as you please!
+* Build your own attributes using custom tags like `%filename%`, `%posttitle%`, `%sitetitle%`, `%category%`, `%tag%`, `%yoastfocuskw%`, `%rankmathfocuskw%`, `%seopresstargetkw%`. Each custom tag will be replaced  with it's value. You can combine them as you please!
 * Choose to turn off any of the above mentioned features.
 * Modify auto generated image attributes using the [iaffpro_image_attributes filter](https://imageattributespro.com/codex/iaffpro_image_attributes/?utm_source=github&utm_medium=readme.md).
 * Choose specific post types to bulk update using the [iaffpro_included_post_types filter](https://imageattributespro.com/codex/iaffpro_included_post_types/?utm_source=github&utm_medium=readme.md).
 * Disable updating of attributes in media library completely using the [iaffpro_update_media_library filter](https://imageattributespro.com/codex/iaffpro_update_media_library/?utm_source=github&utm_medium=readme.md).
 * Add or remove custom image attributes using the [iaffpro_html_image_markup_post_update filter](https://imageattributespro.com/codex/iaffpro_html_image_markup_post_update/?utm_source=github&utm_medium=readme.md)
 
+Other Image Attributes Pro features:
+
+* Bulk Update image attributes from WordPress Media Library. Select images and choose `Update image attributes` Bulk action in Media Library (list view). [Read more.](https://imageattributespro.com/bulk-actions/?utm_source=github&utm_medium=readme.md)
+* Bulk Update image attributes from WordPress admin page for Posts, Pages and WooCommerce Products. Select the posts, pages or WooCommerce products in bulk and choose "Update image attributes" Bulk action. [Read more.](https://imageattributespro.com/bulk-actions/?utm_source=github&utm_medium=readme.md)
+
 For screenshots, FAQ and further details, please see the [product website](https://imageattributespro.com/?utm_source=github&utm_medium=readme.md).
 
 ## Installation

admin/iaff_image-attributes-from-filename-admin-setup.php

@@ -275,14 +275,14 @@ function iaff_settings_validater_and_sanitizer( $settings ) {
 	$settings['bu_custom_filter']	= sanitize_text_field( $settings['bu_custom_filter'] );
 
 	// Sanitize Custom Attributes
-	$settings['custom_attribute_title'] 		= sanitize_text_field( $settings['custom_attribute_title'] );
-	$settings['custom_attribute_bu_title'] 		= sanitize_text_field( $settings['custom_attribute_bu_title'] );
-	$settings['custom_attribute_alt_text'] 		= sanitize_text_field( $settings['custom_attribute_alt_text'] );
-	$settings['custom_attribute_bu_alt_text'] 	= sanitize_text_field( $settings['custom_attribute_bu_alt_text'] );
-	$settings['custom_attribute_caption'] 		= sanitize_text_field( $settings['custom_attribute_caption'] );
-	$settings['custom_attribute_bu_caption'] 	= sanitize_text_field( $settings['custom_attribute_bu_caption'] );
-	$settings['custom_attribute_description'] 	= sanitize_text_field( $settings['custom_attribute_description'] );
-	$settings['custom_attribute_bu_description'] 	= sanitize_text_field( $settings['custom_attribute_bu_description'] );
+	$settings['custom_attribute_title'] 			= iaff_sanitize_text_field( $settings['custom_attribute_title'] );
+	$settings['custom_attribute_bu_title'] 			= iaff_sanitize_text_field( $settings['custom_attribute_bu_title'] );
+	$settings['custom_attribute_alt_text'] 			= iaff_sanitize_text_field( $settings['custom_attribute_alt_text'] );
+	$settings['custom_attribute_bu_alt_text'] 		= iaff_sanitize_text_field( $settings['custom_attribute_bu_alt_text'] );
+	$settings['custom_attribute_caption'] 			= iaff_sanitize_text_field( $settings['custom_attribute_caption'] );
+	$settings['custom_attribute_bu_caption'] 		= iaff_sanitize_text_field( $settings['custom_attribute_bu_caption'] );
+	$settings['custom_attribute_description'] 		= iaff_sanitize_text_field( $settings['custom_attribute_description'] );
+	$settings['custom_attribute_bu_description'] 	= iaff_sanitize_text_field( $settings['custom_attribute_bu_description'] );
 
 	// Validating Regex
 	if( @preg_match( $settings['regex_filter'], null ) === false ) {
@@ -297,6 +297,28 @@ function iaff_settings_validater_and_sanitizer( $settings ) {
 	return $settings;
 }
 
+/**
+ * Extend sanitize_text_field() to preserve %category% custom attribute tag.
+ * 
+ * sanitize_text_field() converts %category% to tegory%.
+ * Here %category% is replaced with IAFF_CATEGORY_CUSTOM_TAG keyword before sanitization. 
+ * Then IAFF_CATEGORY_CUSTOM_TAG is replaced with %category% after sanitization. 
+ * 
+ * @since 3.1
+ * 
+ * @param (String) $str String to be sanitized.
+ * 
+ * @return (String) Sanitized string with %category% preserved. 
+ */
+function iaff_sanitize_text_field( $str ) {
+
+	$str = str_replace( '%category%', 'IAFF_CATEGORY_CUSTOM_TAG', $str );
+	$str = sanitize_text_field( $str );
+	$str = str_replace( 'IAFF_CATEGORY_CUSTOM_TAG', '%category%', $str );
+
+	return $str;
+}
+
 /**
  * Set global default values for settings
  *
@@ -379,9 +401,17 @@ function iaff_custom_attribute_tags() {
 		'filename'		=> __( 'Image filename', 'auto-image-attributes-from-filename-with-bulk-updater' ),
 		'posttitle'		=> __( 'Title of the post, page or product where the image is used', 'auto-image-attributes-from-filename-with-bulk-updater' ),
 		'sitetitle'		=> __( 'Site Title defined in WordPress General Settings', 'auto-image-attributes-from-filename-with-bulk-updater' ),
-		'yoastfocuskw'		=> __( 'Yoast Focus Keyword', 'auto-image-attributes-from-filename-with-bulk-updater' ),
-		'rankmathfocuskw'	=> __( 'Rank Math Focus Keyword', 'auto-image-attributes-from-filename-with-bulk-updater' ),
+		'category'		=> __( 'Post or Product Category', 'auto-image-attributes-from-filename-with-bulk-updater' ),
+		'tag'			=> __( 'Post or Product Tag', 'auto-image-attributes-from-filename-with-bulk-updater' ),
 	);
 
-	return $available_tags;
+	/**
+	 * Filter the custom attribute tags. 
+	 * Used by Image Attributes Pro to add custom tags like %yoastfocuskw% and %rankmathfocuskw% dynamically. 
+	 * 
+	 * @since 3.1
+	 * 
+	 * @param $available_tags (array) Array containing all custom attribute tags.
+	 */
+	return apply_filters( 'iaff_custom_attribute_tags', $available_tags );
 }

admin/iaff_image-attributes-from-filename-admin-ui-render.php

@@ -1050,13 +1050,21 @@ function iaff_admin_interface_render () {
 						<input class="button-secondary iaff-bulk-updater-buttons iaff_stop_bulk_updater_button" type="submit" name="Stop Bulk Updater" value="<?php _e( 'Stop Bulk Updater', 'auto-image-attributes-from-filename-with-bulk-updater' ) ?>" disabled />
 					</p>
 
-					<h2 class="showh2"><?php _e('Reset Counter', 'auto-image-attributes-from-filename-with-bulk-updater') ?></h2>
+					<h2 class="showh2"><?php _e('Tools', 'auto-image-attributes-from-filename-with-bulk-updater') ?></h2>
 
-					<p><?php _e('To restart processing images from the beginning (the oldest upload first), reset the counter.', 'auto-image-attributes-from-filename-with-bulk-updater') ?></p> 
-					
-					<span class="reset-counter-button">
-						<?php submit_button( __('Reset Counter', 'auto-image-attributes-from-filename-with-bulk-updater'), 'iaff_reset_counter_button' ); ?>
-					</span>
+					<p><?php _e('To restart processing images from the beginning (the oldest upload first), reset the counter.', 'auto-image-attributes-from-filename-with-bulk-updater') ?></p>
+
+					<?php if ( apply_filters( 'iaff_debug_mode', false ) ) { ?>
+						<p><?php printf( __( 'If Bulk Updater is stuck, refresh the page, skip current image and try running the bulk updater again. <a href="%s" target="_blank">Read more.</a>', 'auto-image-attributes-from-filename-with-bulk-updater' ), 'https://imageattributespro.com/fix-bulk-updater-stuck-on-same-image/?utm_source=iaff-basic&utm_medium=skip-image-button' ); ?></p>
+					<?php } ?>
+
+					<p class="submit">
+						<input class="button-secondary iaff-bulk-updater-buttons iaff_reset_counter_button" type="submit" name="Reset Counter" value="<?php _e( 'Reset Counter', 'auto-image-attributes-from-filename-with-bulk-updater' ) ?>" />
+						
+						<?php if ( apply_filters( 'iaff_debug_mode', false ) ) { ?>
+							<input class="button-secondary iaff-bulk-updater-buttons iaff_skip_image_button" type="submit" name="Skip Image" value="<?php _e( 'Skip Image', 'auto-image-attributes-from-filename-with-bulk-updater' ) ?>" />
+						<?php } ?>
+					</p>
 
 					<!-- Event log -->
 					<div id="bulk-updater-results">

admin/iaff_image-attributes-from-filename-do.php

@@ -81,9 +81,12 @@ function iaff_rename_old_image() {
 
 	// Image Attributes Pro
 	if ( iaff_is_pro() ) {
+
+		// Get the object of the image form image ID.
+		$image_object = get_post( $image->ID );
 
 		// Running the pro module
-		iaffpro_auto_image_attributes_pro($image, true);
+		iaffpro_auto_image_attributes_pro( $image_object, true );
 
 	} else {
 
@@ -192,6 +195,11 @@ function iaff_before_bulk_updater() {
 	// Security Check
 	check_ajax_referer( 'iaff_before_bulk_updater_nonce', 'security' );
 
+	/**
+	 * Action hook that is fired at the start of the Bulk Updater before updating any image.
+	 * 
+	 * @link https://imageattributespro.com/codex/iaff_before_bulk_updater/
+	 */
 	do_action('iaff_before_bulk_updater');
 }
 add_action( 'wp_ajax_iaff_before_bulk_updater', 'iaff_before_bulk_updater' );
@@ -206,10 +214,41 @@ function iaff_after_bulk_updater() {
 	// Security Check
 	check_ajax_referer( 'iaff_after_bulk_updater_nonce', 'security' );
 
+	/**
+	 * Action hook that is fired at the end of the Bulk Updater after updating all images.
+	 * 
+	 * @link https://imageattributespro.com/codex/iaff_after_bulk_updater/
+	 */
 	do_action('iaff_after_bulk_updater');
 }
 add_action( 'wp_ajax_iaff_after_bulk_updater', 'iaff_after_bulk_updater');
 
+/**
+ * Increment the counter by one to skip one image.
+ * 
+ * @since 3.1
+ */
+function iaff_bulk_updater_skip_image() {
+	
+	// Security Check
+	check_ajax_referer( 'iaff_bulk_updater_skip_image_nonce', 'security' );
+	
+	// Retrieve Counter
+	$counter = get_option( 'iaff_bulk_updater_counter' );
+	$counter = intval ( $counter );
+
+	// Increment counter and update it
+	$counter++;
+	update_option( 'iaff_bulk_updater_counter', $counter );
+	
+	$response = array(
+		'message'			=> __( 'One image skipped.', 'auto-image-attributes-from-filename-with-bulk-updater' ),
+		'remaining_images'	=> iaff_count_remaining_images( true ),
+	);
+	wp_send_json( $response );
+}
+add_action( 'wp_ajax_iaff_bulk_updater_skip_image', 'iaff_bulk_updater_skip_image' );
+
 /**
  * Bulk Updater Ajax
  *
@@ -396,6 +435,21 @@ function iaff_do_bulk_updater(iaff_test=false) {
 			});
 			$('#iaff-reset-counter-dialog').dialog('open');
 		});
+
+		// Skip Image Button
+		$('.iaff_skip_image_button').click( function() {
+			
+			data = {
+				action: 'iaff_bulk_updater_skip_image',
+				security: '<?php echo wp_create_nonce( "iaff_bulk_updater_skip_image_nonce" ); ?>'
+			};
+
+			$.post(ajaxurl, data, function (response) {
+				$('#bulk-updater-log').append('<p class="iaff-green"><span class="dashicons dashicons-yes"></span>' + response.message + '</p>');
+				$('#bulk-updater-log').append('<p>Number of Images Remaining: ' + response.remaining_images + '</p>');
+				$("#bulk-updater-log").animate({scrollTop:$("#bulk-updater-log")[0].scrollHeight - $("#bulk-updater-log").height()},200);
+			});
+		});
 
 	});	
 	</script> <?php

iaff_image-attributes-from-filename.php

@@ -5,7 +5,7 @@
  * Description: Automatically Add Image Title, Image Caption, Description And Alt Text From Image Filename. Since this plugin includes a bulk updater this can update both existing images in the Media Library and new images. 
  * Author: Arun Basil Lal
  * Author URI: https://imageattributespro.com/?utm_source=plugin-header&utm_medium=author-uri
- * Version: 3.0
+ * Version: 3.1
  * Text Domain: auto-image-attributes-from-filename-with-bulk-updater
  * Domain Path: /languages
  * License: GPL v2 - http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
@@ -67,7 +67,7 @@
  * @since 1.3
  */
 if ( ! defined( 'IAFF_VERSION_NUM' ) ) {
-	define( 'IAFF_VERSION_NUM', '3.0' );
+	define( 'IAFF_VERSION_NUM', '3.1' );
 }
 
 /**