Title: PromptBuilder::includeOutputModalities
Published: May 20, 2026

---

# PromptBuilder::includeOutputModalities( WordPressAiClientMessagesEnumsModalityEnum $modalities ): void

## In this article

 * [Description](https://developer.wordpress.org/reference/classes/wordpress-aiclient-builders-promptbuilder/includeoutputmodalities/?output_format=md#description)
 * [Parameters](https://developer.wordpress.org/reference/classes/wordpress-aiclient-builders-promptbuilder/includeoutputmodalities/?output_format=md#parameters)
 * [Return](https://developer.wordpress.org/reference/classes/wordpress-aiclient-builders-promptbuilder/includeoutputmodalities/?output_format=md#return)
 * [Source](https://developer.wordpress.org/reference/classes/wordpress-aiclient-builders-promptbuilder/includeoutputmodalities/?output_format=md#source)
 * [Related](https://developer.wordpress.org/reference/classes/wordpress-aiclient-builders-promptbuilder/includeoutputmodalities/?output_format=md#related)
 * [Changelog](https://developer.wordpress.org/reference/classes/wordpress-aiclient-builders-promptbuilder/includeoutputmodalities/?output_format=md#changelog)

[ Back to top](https://developer.wordpress.org/reference/classes/wordpress-aiclient-builders-promptbuilder/includeoutputmodalities/?output_format=md#wp--skip-link--target)

This function’s access is marked private. This means it is not intended for use 
by plugin or theme developers, only by core. It is listed here for completeness.

Includes output modalities if not already present.

## 󠀁[Description](https://developer.wordpress.org/reference/classes/wordpress-aiclient-builders-promptbuilder/includeoutputmodalities/?output_format=md#description)󠁿

Adds the given modalities to the output modalities list if they’re not already included.
If output modalities is null, initializes it with the given modalities.

## 󠀁[Parameters](https://developer.wordpress.org/reference/classes/wordpress-aiclient-builders-promptbuilder/includeoutputmodalities/?output_format=md#parameters)󠁿

 `$modalities`WordPressAiClientMessagesEnumsModalityEnumrequired

The modalities to include.

## 󠀁[Return](https://developer.wordpress.org/reference/classes/wordpress-aiclient-builders-promptbuilder/includeoutputmodalities/?output_format=md#return)󠁿

 void

## 󠀁[Source](https://developer.wordpress.org/reference/classes/wordpress-aiclient-builders-promptbuilder/includeoutputmodalities/?output_format=md#source)󠁿

    ```php
    private function includeOutputModalities(ModalityEnum ...$modalities): void
    {
        $existing = $this->modelConfig->getOutputModalities();
        // Initialize if null
        if ($existing === null) {
            $this->modelConfig->setOutputModalities($modalities);
            return;
        }
        // Build a set of existing modality values for O(1) lookup
        $existingValues = [];
        foreach ($existing as $existingModality) {
            $existingValues[$existingModality->value] = \true;
        }
        // Add new modalities that don't exist
        $toAdd = [];
        foreach ($modalities as $modality) {
            if (!isset($existingValues[$modality->value])) {
                $toAdd[] = $modality;
            }
        }
        // Update if we have new modalities to add
        if (!empty($toAdd)) {
            $this->modelConfig->setOutputModalities(array_merge($existing, $toAdd));
        }
    }
    ```

[View all references](https://developer.wordpress.org/reference/files/wp-includes/php-ai-client/src/builders/promptbuilder.php/)
[View on Trac](https://core.trac.wordpress.org/browser/tags/7.0/src/wp-includes/php-ai-client/src/Builders/PromptBuilder.php#L1427)
[View on GitHub](https://github.com/WordPress/wordpress-develop/blob/7.0/src/wp-includes/php-ai-client/src/Builders/PromptBuilder.php#L1427-L1451)

## 󠀁[Related](https://developer.wordpress.org/reference/classes/wordpress-aiclient-builders-promptbuilder/includeoutputmodalities/?output_format=md#related)󠁿

| Used by | Description | 
| [PromptBuilder::generateVideoResult()](https://developer.wordpress.org/reference/classes/wordpress-aiclient-builders-promptbuilder/generatevideoresult/)`wp-includes/php-ai-client/src/Builders/PromptBuilder.php` |

Generates a video result from the prompt.

  | 
| [PromptBuilder::generateTextResult()](https://developer.wordpress.org/reference/classes/wordpress-aiclient-builders-promptbuilder/generatetextresult/)`wp-includes/php-ai-client/src/Builders/PromptBuilder.php` |

Generates a text result from the prompt.

  | 
| [PromptBuilder::generateImageResult()](https://developer.wordpress.org/reference/classes/wordpress-aiclient-builders-promptbuilder/generateimageresult/)`wp-includes/php-ai-client/src/Builders/PromptBuilder.php` |

Generates an image result from the prompt.

  | 
| [PromptBuilder::generateSpeechResult()](https://developer.wordpress.org/reference/classes/wordpress-aiclient-builders-promptbuilder/generatespeechresult/)`wp-includes/php-ai-client/src/Builders/PromptBuilder.php` |

Generates a speech result from the prompt.

  | 
| [PromptBuilder::convertTextToSpeechResult()](https://developer.wordpress.org/reference/classes/wordpress-aiclient-builders-promptbuilder/converttexttospeechresult/)`wp-includes/php-ai-client/src/Builders/PromptBuilder.php` |

Converts text to speech and returns the result.

  |

## 󠀁[Changelog](https://developer.wordpress.org/reference/classes/wordpress-aiclient-builders-promptbuilder/includeoutputmodalities/?output_format=md#changelog)󠁿

| Version | Description | 
| [0.1.0](https://developer.wordpress.org/reference/since/0.1.0/) | Introduced. |

## User Contributed Notes

You must [log in](https://login.wordpress.org/?redirect_to=https%3A%2F%2Fdeveloper.wordpress.org%2Freference%2Fclasses%2Fwordpress-aiclient-builders-promptbuilder%2Fincludeoutputmodalities%2F)
before being able to contribute a note or feedback.