Enhancement/921 Add Custom and ACF Field targeting for Excerpt Generation #969

faisal-alvi · 2025-08-08T13:19:48Z

Description of the Change

This PR implements custom field targeting for the ClassifAI excerpt generation feature, allowing users to save generated excerpts to custom fields beyond the default WordPress excerpt field. This enhancement supports editorial workflows that use structured content blocks, custom meta fields, or ACF fields for storing excerpts, etc.

Added support for targeting custom meta fields (e.g., editorial_subtitle, custom_excerpt, dek)
Integrated ACF field support for seamless ACF integration
Maintained default excerpt field as primary option
Added fallback mechanisms for field detection and value retrieval
New "Target field" setting in excerpt generation configuration
Dropdown selection for field type (Default excerpt, Custom meta, ACF field)
Dynamic field selection based on chosen field type
ACF field integration with automatic field detection
Classic Editor: Full custom field support with real-time updates and field detection
Block Editor: Integrated custom field display and synchronization
Context-aware messaging for different field types
Multiple detection methods for ACF fields (data attributes, field keys, DOM structure)
Flexible meta field detection and updating

New Setting Field:

Block Editor (Custom Field):

Block Editor (ACF):

Classic Editor (ACF):

Closes #921

How to test the Change

Custom Meta Field Testing:
- Create custom meta fields (e.g., editorial_subtitle, custom_excerpt)
- Configure excerpt generation to target custom meta fields
- Generate excerpts and verify they save to the correct fields
ACF Field Testing:
- Install/activate ACF plugin
- Create ACF fields (text/textarea)
- Configure excerpt generation to target ACF fields
- Test excerpt generation and field updates
Editor Testing:
- Test in both classic and block editors
- Verify real-time field updates
- Confirm proper field detection and synchronization
Settings Testing:
- Navigate to ClassifAI settings > Language Processing > Excerpt Generation
- Verify "Target field" dropdown with all options
- Test field type switching and configuration saving

Credits

Props @jeffpaul @faisal-alvi @iamdharmesh

Changelog Entry

Added - Add custom field targeting for Excerpt Generation

…ration

…eneration

…eration

… in excerpt generation

…erpt generation

…o-dismiss after 5 seconds

…generation panel

…ttings

…ation

…ermission checks in excerpt generation

…vent listeners for meta field changes

…I accordingly

…rray

@param

------ --------------------------------------------------------------------- Line includes/Classifai/Admin/Settings.php ------ --------------------------------------------------------------------- 246 Function acf_get_fields not found. 🪪 function.notFound 💡 Learn more at https://phpstan.org/user-guide/discovering-symbols ------ --------------------------------------------------------------------- ------ --------------------------------------------------------------------- Line includes/Classifai/Features/ExcerptGeneration.php ------ --------------------------------------------------------------------- 521 Function acf_get_fields not found. 🪪 function.notFound 💡 Learn more at https://phpstan.org/user-guide/discovering-symbols 774 Expected 4 @param tags, found 3. 🪪 paramTag.count 834 Function acf_get_fields not found. Elapsed time: 17 seconds 🪪 function.notFound 💡 Learn more at https://phpstan.org/user-guide/discovering-symbols ------ ---------------------------------------------------------------------

…warnings

github-actions · 2025-08-08T15:22:28Z

@faisal-alvi thanks for the PR! Could you please fill out the PR template with description, changelog, and credits information so that we can properly review and merge this?

iamdharmesh

Thanks for the working on this and raising the PR @faisal-alvi. Overall it looks good. However, I have added few comments.

Additionally, I noticed that we are marking the default excerpt field as read-only/disabled when a custom meta field or ACF field is selected as the target field. I think we should keep the excerpt field as it is. We might instead show a notice near the excerpt generation button, indicating that the generated content will be saved into the selected custom field/ACF field. Otherwise, I believe we should leave the excerpt field unchanged, as there is no direct connection between them. I just wanted to know if there is a specific reasoning behind this. (cc: @dkotter any thoughts on this?)

Thanks!

iamdharmesh · 2025-08-19T09:57:47Z

src/js/features/excerpt-generation/classic/index.js

+									'Change the target field in',
+									'classifai'
+								) +
+								'<a href="' +


Suggested change

'<a href="' +

' <a href="' +

Add space before settings link.

iamdharmesh · 2025-08-19T09:59:54Z

includes/Classifai/Features/ExcerptGeneration.php

+		add_settings_field(
+			'target_field',
+			esc_html__( 'Target field', 'classifai' ),
+			[ $this, 'render_target_field_settings' ],
+			$this->get_option_name(),
+			$this->get_option_name() . '_section',
+			[
+				'label_for'     => 'target_field',
+				'default_value' => $settings['target_field_type'] ?? 'post_excerpt',
+				'description'   => __( 'Choose where to save the generated excerpt. You can target the default excerpt field, custom meta fields, or ACF fields.', 'classifai' ),
+			]
+		);
+	}


We are not supporting legacy settings panel now. So, this is no longer needed now.

iamdharmesh · 2025-08-19T10:01:13Z

includes/Classifai/Features/ExcerptGeneration.php

+			'target_custom_field'     => '',
+			'target_acf_field'        => '',


Nitpick: As we are already storing target_field_type, can we merge this two into single as a target_field?

The reason for keeping these separate is to ensure that if the admin switches back to the previous type, they will still get the same field they were originally using.

iamdharmesh · 2025-08-19T10:05:05Z

includes/Classifai/Features/ExcerptGeneration.php

+	 *
+	 * @return array Array of ACF fields.
+	 */
+	public function get_available_acf_fields() {


Noticed similar get_acf_fields() function in Admin/Settings.php. Maybe better to move this to helper functions to prevent code duplication here?

dkotter · 2025-08-20T16:45:35Z

might instead show a notice near the excerpt generation button, indicating that the generated content will be saved into the selected custom field/ACF field. Otherwise, I believe we should leave the excerpt field unchanged, as there is no direct connection between them

Yeah, I agree feels a little weird to have that field disabled.

I also think we may need further discussion on how exactly this should work. For instance, feels like we may want to allow multiple selections here, so someone can store this in the excerpt field and a custom field (similar to our Descriptive Text Generator where you can choose one or multiple options for storage).

In addition, if I choose ACF or custom meta, I don't love the idea of having the Generate Excerpt button show in the Excerpt panel, as you're not storing the excerpt there anymore. There's probably a better location for that button in those scenarios, though that would require some more discussion.

And finally, if this Feature is on, we remove the core WordPress excerpt panel and replace it with our own, which allows us to add that generate button. Since that was introduced, WordPress has changed how the excerpt panel works and it's been on my list to bring those changes over to ClassifAI. Doesn't have to be done in this PR but might be a good opportunity to align our approach with core (or even investigate if there's a better option now to add that button).

faisal-alvi · 2025-08-29T10:53:51Z

@iamdharmesh Thanks for the feedback!

I noticed that we are marking the default excerpt field as read-only/disabled when a custom meta field or ACF field is selected as the target field.

Just to clarify, we’re not disabling the core excerpt field; we’re hiding it.
Instead, we show a read-only field that reflects the targeted Custom/ACF field value, along with a note for users explaining what to do if they want to edit it.

Reference:

classifai/src/js/features/excerpt-generation/classic/index.js

Lines 104 to 111 in 0397277

    
           // If custom field is enabled, hide the default excerpt field and show custom field info. 
        
           if ( 
        
           	targetFieldSettings && 
        
           	targetFieldSettings.field_type !== 'post_excerpt' 
        
           ) { 
        
           	hideDefaultExcerptField(); 
        
           	showCustomFieldInfo(); 
        
           }

@dkotter Thanks for adding details. A few follow-ups from my side:

Multiple Selections

feels like we may want to allow multiple selections here, so someone can store this in the excerpt field and a custom field

My assumption is that the AI-generated excerpt would be inserted into both the custom/ACF field and the Core field. If that’s the case, should we consider adding:

A new sub-setting when a custom/ACF target is chosen (checkbox: “Also insert into core excerpt”), or
New dropdown options in the existing “Target field” selector, like “Both: Custom & Default” and “Both: ACF & Default”.

Location of the Generate Excerpt Button

if I choose ACF or custom meta, I don’t love the idea of having the Generate Excerpt button show in the Excerpt panel

Personally, I feel the current location is still reasonable for now since we provide a clarifying note (screenshot above), but in the future, we could revisit placement. However, do you have a preferred spot in mind? Happy to make those changes. @iamdharmesh would also love your input here or on any other points.

Bringing Core Changes to ClassifAI

WordPress has changed how the excerpt panel works, and it’s been on my list to bring those changes over to ClassifAI

Could you elaborate on what specific changes have been made in core? That would help us plan how best to align.

faisal-alvi added 25 commits August 8, 2025 14:26

Add REST endpoint to retrieve excerpt target field

038235a

Save to target field upon successful generation

962a072

Include target field information in the inline script

8acc4f4

Include configuration options for saving generated excerpts

fd187a5

Add target field settings for excerpt generation

38cd528

Add rendering functionality for target field settings in excerpt gene…

619b582

…ration

Add target field configuration options for excerpt generation

da56c72

Sanitize target field settings in excerpt generation configuration

c277806

Add default target field type for existing installations in excerpt g…

255ce8f

…eneration

Add functionality to save generated excerpts to various target fields

26fc6c6

Add method to retrieve current value from target field in excerpt gen…

a88e457

…eration

Add method to retrieve available ACF fields for target field selector…

1907609

… in excerpt generation

Add method to retrieve target field information for JavaScript in exc…

e71a690

…erpt generation

Add method to check if ACF is available and active in excerpt generation

c601836

Add notification for target field when excerpt is generated, with aut…

f9a0895

…o-dismiss after 5 seconds

Implement target field value retrieval on component mount in excerpt …

0de0232

…generation panel

Add SelectControl for target field selection in excerpt generation se…

d07c265

…ttings

Add REST API callback to retrieve target field value in excerpt gener…

a83c6f9

…ation

Ensure proper handling of generated content in excerpt generation

f5a65d2

Improve state management and update UI labels

7835411

Add REST API endpoint to retrieve target field settings and enhance p…

316ca46

…ermission checks in excerpt generation

Enhance excerpt generation panel by adding custom field display and e…

bb9e711

…vent listeners for meta field changes

Classic Editor: Dynamically handle custom field settings and update U…

2fb4cb9

…I accordingly

Add ACF fields retrieval method to settings and include in settings a…

4883e45

…rray

Update messages to differentiate between ACF fields and custom fields

7156519

faisal-alvi self-assigned this Aug 8, 2025

github-actions bot added this to the 3.6.0 milestone Aug 8, 2025

faisal-alvi added 3 commits August 8, 2025 19:49

eslint fixes

8e0e3e1

few more eslint fixes

784c80b

phpcs fixes

f9d66a6

faisal-alvi added 3 commits August 8, 2025 20:13

Update plugin-check workflow to ignore specific discouraged function …

27fd51b

…warnings

Update version annotations to 3.6.0

0397277

faisal-alvi marked this pull request as ready for review August 8, 2025 15:22

faisal-alvi requested review from jeffpaul, dkotter and a team as code owners August 8, 2025 15:22

github-actions bot added the needs:feedback This requires reporter feedback to better understand the request. label Aug 8, 2025

faisal-alvi requested review from a team and iamdharmesh and removed request for jeffpaul, a team and dkotter August 8, 2025 15:22

github-actions bot added needs:code-review This requires code review. and removed needs:feedback This requires reporter feedback to better understand the request. labels Aug 8, 2025

iamdharmesh requested changes Aug 19, 2025

View reviewed changes

dkotter modified the milestones: 3.6.0, 3.7.0 Aug 19, 2025

dkotter modified the milestones: 3.7.0, 3.8.0 Sep 11, 2025

faisal-alvi added the needs:feedback This requires reporter feedback to better understand the request. label Sep 12, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Enhancement/921 Add Custom and ACF Field targeting for Excerpt Generation #969

Enhancement/921 Add Custom and ACF Field targeting for Excerpt Generation #969

Uh oh!

faisal-alvi commented Aug 8, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Aug 8, 2025

Uh oh!

iamdharmesh left a comment

Uh oh!

iamdharmesh Aug 19, 2025

Uh oh!

iamdharmesh Aug 19, 2025

Uh oh!

iamdharmesh Aug 19, 2025

Uh oh!

faisal-alvi Aug 29, 2025

Uh oh!

iamdharmesh Aug 19, 2025

Uh oh!

dkotter commented Aug 20, 2025

Uh oh!

faisal-alvi commented Aug 29, 2025 •

edited

Loading

Uh oh!

Uh oh!

Enhancement/921 Add Custom and ACF Field targeting for Excerpt Generation #969

Are you sure you want to change the base?

Enhancement/921 Add Custom and ACF Field targeting for Excerpt Generation #969

Uh oh!

Conversation

faisal-alvi commented Aug 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description of the Change

New Setting Field:

Block Editor (Custom Field):

Block Editor (ACF):

Classic Editor (ACF):

How to test the Change

Credits

Changelog Entry

Uh oh!

github-actions bot commented Aug 8, 2025

Uh oh!

iamdharmesh left a comment

Choose a reason for hiding this comment

Uh oh!

iamdharmesh Aug 19, 2025

Choose a reason for hiding this comment

Uh oh!

iamdharmesh Aug 19, 2025

Choose a reason for hiding this comment

Uh oh!

iamdharmesh Aug 19, 2025

Choose a reason for hiding this comment

Uh oh!

faisal-alvi Aug 29, 2025

Choose a reason for hiding this comment

Uh oh!

iamdharmesh Aug 19, 2025

Choose a reason for hiding this comment

Uh oh!

dkotter commented Aug 20, 2025

Uh oh!

faisal-alvi commented Aug 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

faisal-alvi commented Aug 8, 2025 •

edited

Loading

faisal-alvi commented Aug 29, 2025 •

edited

Loading