Page Generator Pro

https://www.wpzinc.com/documentation/page-generator-pro/
Admin
Page Generator Pro is a WordPress plugin that automates the generation of unique pages, posts, and...
Tokens:180,350
Snippets:1,732
Trust Score:9.7
Update:9 months ago
Show doc for...
Tokens:
Raw
### Freeform Prompt Example with Parameters

Source: https://www.wpzinc.com/documentation/page-generator-pro/generate-dynamic-elements-claude-ai

Demonstrates how to construct a custom prompt for AI content generation when using the 'freeform' content type. This example shows specifying word count, content style, and language directly within the prompt. This method provides full control over the AI's output.

```text
Write a 250 word paragraph about how to find the best {service}. The style should be an informative, professional tone, written in French.
```

--------------------------------

### PAGE GENERATOR PRO GROUPS AI SETUP CONTENT GROUP CONTENT PAGE BUILDER

Source: https://www.wpzinc.com/documentation/page-generator-pro/developers

Setup Content Group’s content when using Add New Using AI.

```APIDOC
## PAGE GENERATOR PRO GROUPS AI SETUP CONTENT GROUP CONTENT PAGE BUILDER

### Description
Setup Content Group’s content when using Add New Using AI.

### Method
ADD_FILTER

### Endpoint
`page_generator_pro_groups_ai_setup_content_group_content_ page_builder`

### Parameters
#### Filter Parameters
- **$content_group** (array) - The content group data.
- **$content** (string) - The content to be set up.

### Usage
```php
add_filter( 'page_generator_pro_groups_ai_setup_content_group_content_  page_builder', function( $content_group, $content ) {
	// ... your code here
	// Return value
	return $content_group;
}, 10, 2 );
```
```

--------------------------------

### Page Generator Pro Media Library Image Shortcode Example

Source: https://www.wpzinc.com/documentation/page-generator-pro/generate-dynamic-elements-media-library-image

This is an example of the Media Library Image shortcode, demonstrating how to manually construct it for use in page builders or text editors. It shows a basic structure that can be expanded with various parameters.

```php
[page-generator-pro-media-library parameter="value" ...]
```

--------------------------------

### Scheduling WP-CLI Tasks

Source: https://www.wpzinc.com/documentation/page-generator-pro/generate-wp-cli

Instructions and examples on how to schedule Page Generator Pro WP-CLI commands using cron jobs or hosting control panels.

```APIDOC
## Scheduling Tasks

### Description
This section details how to schedule WP-CLI commands for Page Generator Pro using server CRON jobs or hosting control panels like cPanel.

### Via Crontab

#### Example Configuration
```bash
0 0 * * * /usr/local/bin/wp page-generator-pro-generate-content 1234 --path="/path/to/wordpress/root/" >> /path/to/wordpress/root/wp-content/page-generator-pro-cli.log 2>&1
```

#### Explanation of Components:
- **0 0 * * ***: The schedule time for the command (e.g., midnight daily). Use [crontab.guru](https://crontab.guru/) to understand formats.
- **/usr/local/bin/wp**: The absolute path to your WP-CLI executable.
- **page-generator-pro-generate-content 1234**: The specific WP-CLI command and its arguments.
- **/path/to/wordpress/root/**: The absolute path to your WordPress installation's root directory.
- **>> /path/to/wordpress/root/wp-content/page-generator-pro-cli.log 2>&1**: Redirects all output (standard output and standard error) to a log file.

### Via cPanel / Hosting Control Panel

Consult your web host to ensure:
- WP-CLI is installed on your server.
- A cron job is correctly configured to execute the desired WP-CLI command (e.g., `/usr/local/bin/wp page-generator-pro-generate-content 1234 --path="/path/to/wordpress/root/"`).
```

--------------------------------

### Google Places Dynamic Element Documentation

Source: https://www.wpzinc.com/documentation/page-generator-pro/generate-dynamic-elements-google-places

This section details the setup, configuration, and usage of the Google Places Dynamic Element within Page Generator Pro.

```APIDOC
## Google Places Dynamic Element

### Description

The Google Places Dynamic Element inserts a list or grid of places (such as businesses) listed on Google matching the given term and location. This feature is available in Page Generator Pro version 5.2.8 and higher.

### Setup

Before using Google Places, ensure you have created and stored your Google Places API Key at https://www.wpzinc.com/documentation/page-generator-pro/settings-integrations/#google-places-api-key. Failure to do so will result in incorrect functionality.

### Adding Google Places

**Classic Editor / TinyMCE (Visual Editor):**
1. Ensure you are in the Visual Editor by clicking the 'Visual' tab.
2. Click the Google Places icon in the Visual Editor toolbar.

**Classic Editor / TinyMCE (Text Editor):**
1. Click the Google Places button in the toolbar.

**Gutenberg Editor:**
1. Click the plus icon to add a new block.
2. Search for 'Google Places' and select the option under the 'Page Generator Pro' section.
3. Configure the fields in the right-hand sidebar.

**Page Builders:**
- If your Page Builder supports a Text Editor widget/module using the Classic Editor, follow the Classic Editor instructions.
- For Page Builders without Classic Editor support, you can manually construct the shortcode: `[page-generator-pro-google-places parameter="value" ...]`

### Configuration: Search Parameters

Parameter | Accepted Value | Description
---|---|---
`term` | string or keyword | Search term(s) to find matching results (e.g., Restaurants).
`location` | string or keyword | The city to display Google Places listings for, or use a keyword (e.g., Birmingham or {city}). Include the country (e.g., {city}, UK).
`latitude` | string | When a `radius` is specified, the center point's latitude must be provided.
`longitude` | string | When a `radius` is specified, the center point's longitude must be provided.
`radius` | 0 to 500 | The maximum radius area to search.
`minimum_rating` | 0 to 4.5 | The minimum rating a place must have to be displayed.
`language` | string | The language for the output. Must match a code from https://developers.google.com/maps/faq#languagesupport.
`limit` | 1 to 20 | The maximum number of places to return.
`output_type` | list, table | The output format for the Place listings (`list` or `table`).
`columns` | 1 to 4 | When `output_type` is `list`, specifies the number of columns (1-4).
`link` | 0 or 1 | If enabled (1), clicking the Place Name or Rating opens the place's website in a new tab.
`display_order` | string | Comma-separated list defining the order of place attributes to display. Accepted values include: `formattedAddress`, `adrFormatAddress`, `googleMapsUri`, `internationalPhoneNumber`, `nationalPhoneNumber`, `priceLevel`, `displayName`, `priceRange`, `primaryTypeDisplayName`, `rating`, `regularOpeningHours`, `reviewSummary`, `websiteUri`. If blank, `displayName` and `rating` are displayed by default.
`display_alignment` | string | When `output_type` is `list`, specifies the alignment of each individual place's attributes.
```

--------------------------------

### PAGE GENERATOR PRO INSTALL COPY MU PLUGIN

Source: https://www.wpzinc.com/documentation/page-generator-pro/developers

Enable automatic copying of the Must-Use Plugin each time Page Generator Pro is updated to a newer version.

```APIDOC
## PAGE GENERATOR PRO INSTALL COPY MU PLUGIN

### Description
Enable automatic copying of the Must-Use Plugin each time Page Generator Pro is updated to a newer version.

### Method
ADD_FILTER

### Endpoint
`page_generator_pro_install_copy_mu_plugin`

### Parameters
#### Filter Parameters
- **(none specified)**

### Usage
```php
add_filter( 'page_generator_pro_install_copy_mu_plugin', function( ) {
	// ... your code here
	// Return value
	return false; // Set to true to enable copying
}, 10, 1 );
```
```

--------------------------------

### Schedule WP-CLI Task via Crontab

Source: https://www.wpzinc.com/documentation/page-generator-pro/generate-wp-cli/%29

This example demonstrates how to schedule a WP-CLI command to run automatically using a crontab entry. It specifies the execution time, the WP-CLI command with arguments, the WordPress path, and log file redirection.

```bash
0 0 * * * /usr/local/bin/wp page-generator-pro-generate-content 1234 --path="/path/to/wordpress/root/" >> /path/to/wordpress/root/wp-content/page-generator-pro-cli.log 2>&1
```

--------------------------------

### Pre-Generation Actions for Content

Source: https://www.wpzinc.com/documentation/page-generator-pro/developers

Execute custom logic before the main content generation process starts. This hook provides an opportunity to prepare the environment or validate settings. It passes an ID, a boolean, and the generation context.

```php
do_action( 'page_generator_pro_generate_content_before', function( $id, false, 'browser' ) {
	// ... your code here
}, 10, 3 );

```

--------------------------------

### Actions Before Generate Content - WPZinc Page Generator Pro

Source: https://www.wpzinc.com/documentation/page-generator-pro/developers

Runs any actions before the 'Generate Content' process begins. This hook can be used for setup or validation before content generation.

```php
do_action( 'page_generator_pro_generate_content_before', function( $group['group_id'], false, 'browser' ) {
	// ... your code here
}, 10, 3 );
```

```php
do_action( 'page_generator_pro_generate_content_before', function( $group_id, $test_mode, $system ) {
	// ... your code here
}, 10, 3 );
```

--------------------------------

### Page Generator Pro Shortcode Examples for AI Providers

Source: https://www.wpzinc.com/documentation/page-generator-pro/generate-dynamic-elements-mistral-ai

Demonstrates the basic shortcode syntax for integrating AI content from various providers into your pages. These shortcodes are used within the Text Editor widget of supported page builders or manually constructed if the page builder lacks a Classic Editor compatible widget. Ensure you replace 'parameter' and 'value' with actual settings.

```shortcode
[page-generator-pro-alibaba parameter="value"]
[page-generator-pro-claude-ai parameter="value"]
[page-generator-pro-deepseek parameter="value"]
[page-generator-pro-gemini-ai parameter="value"]
[page-generator-pro-grok-ai parameter="value"]
[page-generator-pro-mistral-ai parameter="value"]
[page-generator-pro-openai parameter="value"]
[page-generator-pro-openrouter parameter="value"]
[page-generator-pro-perplexity parameter="value"]
```

--------------------------------

### Actions Before Generate Terms - WPZinc Page Generator Pro

Source: https://www.wpzinc.com/documentation/page-generator-pro/developers

Runs any actions before the 'Generate Terms' process begins. This hook allows for pre-generation setup or checks.

```php
do_action( 'page_generator_pro_generate_terms_before', function( $group['group_id'], false, 'browser' ) {
	// ... your code here
}, 10, 3 );
```

--------------------------------

### Setup AI Content Group Content

Source: https://www.wpzinc.com/documentation/page-generator-pro/developers

This filter is used to set up the content for a Content Group when using the 'Add New Using AI' feature. It allows modification of the content group and its associated content before generation.

```php
add_filter( 'page_generator_pro_groups_ai_setup_content_group_content_  page_builder', function( $content_group, $content ) {
	// ... your code here
	// Return value
	return $content_group;
}, 10, 2 );
```

--------------------------------

### Hook Started Generate Content - WPZinc Page Generator Pro

Source: https://www.wpzinc.com/documentation/page-generator-pro/developers

This hook is triggered at the beginning of generating an individual Page, Post, or Custom Post Type. It's ideal for setting up context or parameters for the generation process. The callback receives the group ID, settings, index, and test mode status.

```php
do_action( 'page_generator_pro_generate_content_started', function( $group_id, $settings, $index, $test_mode ) {
	// ... your code here
}, 10, 4 );
```

--------------------------------

### Block Spinning Example with Paragraphs and Sentences

Source: https://www.wpzinc.com/documentation/page-generator-pro/generate-using-spintax

Demonstrates how to use block spinning to create variations of sentences within a paragraph. The `#p#` and `#/p#` tags define a paragraph, while `#s#` and `#/s#` tags within it allow for random selection of sentences. Indentation is optional but recommended for readability.

```plaintext
#p#
	#s#
		Writing content is a lot of fun.
		Creating articles is a rewarding experience.
	#/s#
#/p#
```

--------------------------------

### Google Map Shortcode Configuration (Location Map Mode)

Source: https://www.wpzinc.com/documentation/page-generator-pro/generate-dynamic-elements-google-map

This example demonstrates the shortcode syntax for configuring a Google Map in 'Location' mode. It includes parameters for map type, location, height, zoom level, and center point coordinates.

```php
[page-generator-pro-google-map map_mode="place" maptype="roadmap" location="{city}, UK" height="250" zoom="14" center_latitude="" center_longitude=""]
```

--------------------------------

### Pixabay Image Shortcode Parameters (Page Generator Pro)

Source: https://www.wpzinc.com/documentation/page-generator-pro/generate-dynamic-elements-pixabay

This documentation lists the available parameters for the Page Generator Pro Pixabay shortcode. These parameters control image fetching, appearance, and media library handling. Ensure Page Generator Pro is installed.

```markdown
Parameter| Accepted Value| Description  
---|---|---  
term| string or keyword| Fetch an image at random from Pixabay matching the given Term.  
orientation| all, horizontal, vertical| The image orientation to search for  
language| cs, da, de, en, es, fr, id, it, hu, nl, no, pl, pt, ro, sk, fi, sv, tr, vi, th, bg, ru, el, ja, ko, zh| The language the search term is in  
image_type| all, photo, illustration, vector| The type of image to search for (illustration, vector or photo)  
category| fashion, nature, backgrounds, science, education, people, feelings, religion, health, places, animals, industry, food, computer, sports, transportation, travel, buildings, business, music| For more precise matching, optionally choose an image category to search within  
color| grayscale, transparent, red, orange, yellow, green, turquoise, blue, lilac, pink, white, gray, black, brown| Optionally limit results by the given primary image color  
copy| 0,1| Whether to save the image to the Media Library.  
size| thumbnail, medium, large| The image size to output. Other values may be available depending on the image sizes registered by your WordPress Theme and third party Plugins.  
title| string or keyword| The title to assign to the image.  
caption| string or keyword| The caption to assign to the image.  
caption_display| integer (0,1)| If enabled, displays the caption below the image. Available in Page Generator Pro 4.5.2 and higher.  
alt_tag| string or keyword| The alt tag to assign to the image.  
description| string or keyword| The description to assign to the image.  
filename| string or keyword| Define the filename to save the image as in the Media Library, excluding the extension.  
attribution| 0,1| If enabled, displays an image attribution below the image, linking to the author and license type the image is licensed under.  
link_href| string or keyword| Define the link for the image. Leave blank for no link.  
link_title| string or keyword| Define the link title for the image.  
link_rel| string| Define the link rel attribute for the image.  
link_target| string| Define the link target for the image.  
`_blank` New Window / Tab  
`_self` Same Window / Tab  
`_parent` Parent Frame  
`_top` Full Body of Window  
exif_latitude| decimal or keyword| The image’s location’s latitude.  
exif_longitude| decimal or keyword| The image’s locations’ longitude.  
exif_comments| string or keyword| Comments about the image.  
exif_description| string or keyword| A description of the image.
```

--------------------------------

### Hook Started Generate Term - WPZinc Page Generator Pro

Source: https://www.wpzinc.com/documentation/page-generator-pro/developers

This action hook is triggered before an individual taxonomy term is generated. It allows for pre-generation setup or validation. The hook provides the group ID, settings, index, and test mode to the callback function.

```php
do_action( 'page_generator_pro_generate_term_started', function( $group_id, $settings, $index, $test_mode ) {
	// ... your code here
}, 10, 4 );
```

--------------------------------

### Supported AI Providers and Shortcode Syntax

Source: https://www.wpzinc.com/documentation/page-generator-pro/generate-dynamic-elements-claude-ai

This section details the available AI providers and their corresponding shortcode syntax for generating content. It also outlines the general parameters that can be used with these shortcodes.

```APIDOC
## Supported AI Providers and Shortcode Syntax

This section details the available AI providers and their corresponding shortcode syntax for generating content. It also outlines the general parameters that can be used with these shortcodes.

### Provider Shortcodes

| Provider      | Shortcode Syntax                                         |
|---------------|----------------------------------------------------------|
| Alibaba Qwen  | `[page-generator-pro-alibaba parameter="value" ...]`     |
| Claude AI     | `[page-generator-pro-claude-ai parameter="value" ...]`   |
| Deepseek      | `[page-generator-pro-deepseek parameter="value" ...]`    |
| Gemini AI     | `[page-generator-pro-gemini-ai parameter="value" ...]`   |
| Grok AI       | `[page-generator-pro-grok-ai parameter="value" ...]`     |
| Mistral AI    | `[page-generator-pro-mistral-ai parameter="value" ...]`  |
| Open AI       | `[page-generator-pro-openai parameter="value" ...]`      |
| OpenRouter    | `[page-generator-pro-openrouter parameter="value" ...]`  |
| Perplexity    | `[page-generator-pro-perplexity parameter="value" ...]`  |

### Supported Shortcode Parameters

| Parameter        | Accepted Value                                         | Description
```

--------------------------------

### General Configuration: Topic

Source: https://www.wpzinc.com/documentation/page-generator-pro/generate-dynamic-elements-openrouter

Details on configuring the 'Topic' parameter for AI content generation, including the use of keywords and how it functions with different content types.

```APIDOC
## Configuration: General - Topic

The `Topic` parameter defines the subject matter for the AI-generated content. Providing a detailed topic leads to higher quality output.

### Topic Field Usage:

- **General Topics:** Use clear and specific phrases (e.g., "how to fix a leak").
- **Keyword Support:** You can utilize keywords enclosed in curly braces `{}` to dynamically insert terms from your defined keywords. This is particularly useful for location-based services or product variations (e.g., "how to find the best {service} in {location}"). The system will replace these placeholders with appropriate terms during content generation.
- **Content Type Specifics:**
    - When `content_type` is set to `article` or `paragraph`, the `Topic` serves as the primary subject.
    - When `content_type` is set to `freeform`, the entire value of the `Topic` field becomes the prompt sent to the AI provider. In this mode, you are responsible for specifying all necessary details, including the desired length, tone, and language, as the `limit` and `language` parameters are ignored.

### Example for Freeform Topic:

```
Write a 250 word paragraph about how to find the best {service}. The style should be an informative, professional tone, written in French.
```
```

--------------------------------

### Filter: page_generator_pro_research_get_status_provider

Source: https://www.wpzinc.com/documentation/page-generator-pro/developers

Get status of a research request for the research provider for the given article ID.

```APIDOC
## Filter: page_generator_pro_research_get_status_provider

### Description
Get status of a research request for the research provider for the given article ID.

### Method
`add_filter`

### Endpoint
`page_generator_pro_research_get_status_provider`

### Parameters
#### Filter Parameters
- **$id** (int) - Required - The ID of the research request.

### Request Example
```php
add_filter( 'page_generator_pro_research_get_status_provider', function( $id ) {
    // ... your code here
    // Return value
    return $id;
}, 10, 1 );
```

### Response
#### Success Response (int)
- **$id** (int) - The ID of the research request.
```

--------------------------------

### WP-CLI: Generate Content

Source: https://www.wpzinc.com/documentation/page-generator-pro/generate-wp-cli/%29

Runs the _Generate_ command, simulating a click on the _Generate_ button for specified group IDs, with optional parameters for the number of posts and resume index.

```APIDOC
## Generate Content

### Description
Runs the _Generate_ command, behaving as if you click the _Generate_ button for the given group_id.

### Method
WP-CLI Command

### Endpoint
`wp page-generator-pro-generate-content group_id --number_of_posts= --resume_index=`

### Parameters
#### Path Parameters
- **group_id** (string) - Required - The ID(s) of the group(s) to generate content from. Can be a single ID or a comma-separated list (e.g., `123` or `123,456`).

#### Query Parameters
- **--number_of_posts** (integer) - Optional - The number of posts to generate. Overrides the group's setting.
- **--resume_index** (integer) - Optional - The resume index to use (zero-based). Overrides the group's setting.
```

--------------------------------

### PAGE GENERATOR PRO SHORTCODE GET MODAL DIMENSIONS

Source: https://www.wpzinc.com/documentation/page-generator-pro/developers

Sets the dimensions of TinyMCE and Quicktag modals for the given shortcode.

```APIDOC
## PAGE GENERATOR PRO SHORTCODE GET MODAL DIMENSIONS

### Description
Sets the dimensions of TinyMCE and Quicktag modals for the given shortcode.

### Method
ADD_FILTER

### Endpoint
`page_generator_pro_shortcode_get_modal_dimensions`

### Parameters
#### Filter Parameters
- **$dimensions** (array) - The dimensions of the modal.
- **$get_name()** (string) - The name of the shortcode.

### Usage
```php
add_filter( 'page_generator_pro_shortcode_get_modal_dimensions', function( $dimensions, $get_name( ) {
	// ... your code here
	// Return value
	return $dimensions;
}, 10, 2 );
```
```

--------------------------------

### Supported Shortcode Parameters

Source: https://www.wpzinc.com/documentation/page-generator-pro/generate-dynamic-elements-gemini-ai

This section details the available parameters you can use within the AI content shortcodes to customize the generated output. Understanding these parameters allows for fine-grained control over the AI's response.

```APIDOC
## Configuration: General

### Topic
The _Topic_ is the topic that the content should be based on. For example, if the Content Group relates to plumbing services, you might use “how to fix a leak” or “how to find the best plumber”.
Keywords are supported in the Topic field. For example, if your Content Group is for generating Pages for services in locations, and you have Keywords defined for both services and locations, you might use “how to find the best {service} in {location(city_name)}”. For each generated Page, the Keywords will be replaced with a Term, and the query sent to the AI provider to return content (for example, “how to find the best bathroom plumber in Birmingham”).
The more detailed the topic, the better quality content that will be returned. For example, “bathroom plumbing” will generate more generic content vs. “how to find the best bathroom plumber”.
When **Content Type** is _Freeform_ , the Topic becomes the entire AI prompt. Limit and Language options are ignored, therefore you’re responsible for defining these. For example, you might specify:
```
Write a 250 word paragraph about how to find the best {service}. The style should be an informative, professional tone, written in French.
```

Supported shortcode syntax parameters: 

Parameter| Accepted Value| Description  
---|---|---
`topic`| string or keyword| The topic that the content should be written about.  
`instructions`| string| System instructions relating to the topic, such as tone, context, business information.  
`content_type`| string|
  * `article`: A detailed article, including subheadings and a conclusion based on the topic (e.g. “web design”)  
  * `faq`: Questions and answers based on the topic (e.g. “how to find the best kitchen fitter”)  
  * `freeform`: You want to send a freeform prompt to the AI provider, with full control. In this setting, the Limit and Language options are ignored. You’re responsible for prompting the AI provider to return the applicable language and limit, if required.  
  * `paragraph`: A single paragraph of content based on the topic (e.g. “what is the most important quality in a web design company”)  
  
`limit`| int|
  * When content_type = `article` or `paragraph`: the maximum number of words  
  * When content_type = `faq`: the maximum number of questions  
  * When content_type = `freeform`: the limit is ignored. Any limit imposed is a token limit from the AI provider, based on the model chosen.  
  
`language`| string| Two character language code.  
`temperature`| float| Number between 0 and 2, in 0.1 steps. A higher value will make the output more random. A lower value will make it the output more focused and deterministic.  
`top_p`| float| Number between 0 and 1, in 0.1 steps. Determines the pool of available tokens to choose from, between 0 and 1. An alternative to using Temperature. A higher value will include more, less accurate tokens. A lower value will include fewer, more accurate tokens.  
presence_penalty| float| Number between -2.0 and 2.0, in 0.1 steps. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model’s likelihood to talk about new topics.  
frequency_penalty| float| Number between -2.0 and 2.0, in 0.1 steps. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model’s likelihood to repeat the same line verbatim.
```

--------------------------------

### Get Spintax Providers Filter (PHP)

Source: https://www.wpzinc.com/documentation/page-generator-pro/developers

This filter defines the available spintax providers that the plugin supports. Developers can add or remove providers through this hook.

```php
add_filter( 'page_generator_pro_spintax_get_providers', function( $providers ) {
	// ... your code here
	// Return value
	return $providers;
}, 10, 1 );
```

--------------------------------

### Scheduling WP-CLI Tasks

Source: https://www.wpzinc.com/documentation/page-generator-pro/generate-wp-cli/%29

Instructions on how to schedule WP-CLI commands using server cron jobs or hosting control panels.

```APIDOC
## Scheduling WP-CLI Tasks

### Description
Details on how to schedule Page Generator Pro WP-CLI commands using system cron jobs or hosting control panel interfaces.

### Via Crontab

Example crontab entry:
```bash
0 0 * * * /usr/local/bin/wp page-generator-pro-generate-content 1234 --path="/path/to/wordpress/root/" >> /path/to/wordpress/root/wp-content/page-generator-pro-cli.log 2>&1
```

**Explanation:**
*   `0 0 * * *`: Specifies the schedule (e.g., midnight daily). Use [crontab.guru](https://crontab.guru/) to help configure.
*   `/usr/local/bin/wp`: The absolute path to your WP-CLI executable.
*   `page-generator-pro-generate-content 1234`: The WP-CLI command and its arguments.
*   `--path="/path/to/wordpress/root/"`: The path to your WordPress installation root.
*   `>> /path/to/wordpress/root/wp-content/page-generator-pro-cli.log 2>&1`: Redirects standard output and error to a log file.

### Via cPanel / Hosting Control Panel

Consult your hosting provider to set up a cron job that executes the desired WP-CLI command, similar to the crontab example.
```

--------------------------------

### PAGE GENERATOR PRO KEYWORDS REFRESH TERMS KEYWORDSOURCE

Source: https://www.wpzinc.com/documentation/page-generator-pro/developers

Refresh the given Keyword’s Columns and Terms by fetching them from the database immediately before starting generation.

```APIDOC
## PAGE GENERATOR PRO KEYWORDS REFRESH TERMS KEYWORDSOURCE

### Description
Refresh the given Keyword’s Columns and Terms by fetching them from the database immediately before starting generation.

### Method
ADD_FILTER

### Endpoint
`page_generator_pro_keywords_refresh_terms_ keywordsource`

### Parameters
#### Filter Parameters
- **array()** - An array containing the refreshed columns and terms.

### Usage
```php
add_filter( 'page_generator_pro_keywords_refresh_terms_  keywordsource', function( array( ) {
	// ... your code here
	// Return value
	return array(;
}, 10, 1 );
```
```

--------------------------------

### Get Spintax Provider Settings Fields Filter (PHP)

Source: https://www.wpzinc.com/documentation/page-generator-pro/developers

This filter defines the settings fields for each spintax provider, which are displayed on the 'Settings > Spintax' page. It allows for custom configuration options for each provider.

```php
add_filter( 'page_generator_pro_spintax_get_providers_settings_fields', function( $settings_fields ) {
	// ... your code here
	// Return value
	return $settings_fields;
}, 10, 1 );
```

--------------------------------

### Get Research Provider Status

Source: https://www.wpzinc.com/documentation/page-generator-pro/developers

Filters the status of a research request for a specific article ID and research provider. This hook is useful for retrieving or modifying the current status of ongoing research tasks.

```php
add_filter( 'page_generator_pro_research_get_status_  provider', function( $id ) {
	// ... your code here
	// Return value
	return $id;
}, 10, 1 );

```

--------------------------------

### Get Keywords and Terms Before Processing - PHP

Source: https://www.wpzinc.com/documentation/page-generator-pro/developers

Returns an array of keyword and term key/value pairs before any search or replacement arrays are constructed. This filter is useful for inspecting or modifying the initial keyword and term data.

```PHP
add_filter( 'page_generator_pro_generate_get_keywords_terms', function( $keywords_terms, $method, $index ) {
	// ... your code here
	// Return value
	return $keywords_terms;
}, 10, 3 );
```

--------------------------------

### Supported AI Providers and Shortcode Syntax

Source: https://www.wpzinc.com/documentation/page-generator-pro/generate-dynamic-elements-perplexity

This section outlines the different AI providers supported by Page Generator Pro and the corresponding shortcode syntax to use for generating AI content.

```APIDOC
## Adding: Page Builders

To add AI content within other supported Page Builders, you’ll need to use that Page Builder’s Text Editor widget/module, which typically uses the Classic Editor (sometimes known as TinyMCE).

Refer to the Dynamic Elements Documentation for how to add a Dynamic Element specific to your Page Builder.

If your Page Builder **does not** provide a Text Editor widget/block that uses the Classic Editor, **you can still use Dynamic Elements**. However, you’ll need to manually build the shortcode, inserting it into your Page Builder’s content.

### Provider Shortcodes

| Provider      | Shortcode Syntax                                   |
|---------------|----------------------------------------------------|
| Alibaba Qwen  | `[page-generator-pro-alibaba parameter="value" ...]` |
| Claude AI     | `[page-generator-pro-claude-ai parameter="value" ...]` |
| Deepseek      | `[page-generator-pro-deepseek parameter="value" ...]` |
| Gemini AI     | `[page-generator-pro-gemini-ai parameter="value" ...]` |
| Grok AI       | `[page-generator-pro-grok-ai parameter="value" ...]` |
| Mistral AI    | `[page-generator-pro-mistral-ai parameter="value" ...]` |
| Open AI       | `[page-generator-pro-openai parameter="value" ...]` |
| OpenRouter    | `[page-generator-pro-openrouter parameter="value" ...]` |
| Perplexity    | `[page-generator-pro-perplexity parameter="value" ...]` |
```

--------------------------------

### AI Content Shortcode Usage

Source: https://www.wpzinc.com/documentation/page-generator-pro/generate-dynamic-elements-openrouter

This section details how to use shortcodes to generate AI content with different AI providers. Each provider has a specific shortcode syntax that accepts various parameters to control the content generation.

```APIDOC
## AI Content Shortcodes

Page Generator Pro allows you to generate AI content directly within your pages using shortcodes. The syntax varies slightly depending on the AI provider you choose.

### Supported AI Providers and Shortcode Syntax:

| Provider       | Shortcode Syntax                                        |
|----------------|---------------------------------------------------------|
| Alibaba Qwen   | `[page-generator-pro-alibaba parameter="value" ...]`    |
| Claude AI      | `[page-generator-pro-claude-ai parameter="value" ...]`  |
| Deepseek       | `[page-generator-pro-deepseek parameter="value" ...]`  |
| Gemini AI      | `[page-generator-pro-gemini-ai parameter="value" ...]`  |
| Grok AI        | `[page-generator-pro-grok-ai parameter="value" ...]`    |
| Mistral AI     | `[page-generator-pro-mistral-ai parameter="value" ...]`  |
| Open AI        | `[page-generator-pro-openai parameter="value" ...]`     |
| OpenRouter     | `[page-generator-pro-openrouter parameter="value" ...]`  |
| Perplexity     | `[page-generator-pro-perplexity parameter="value" ...]`  |

### Supported Shortcode Parameters:

| Parameter        | Accepted Value         | Description                                                                                                                               |
|------------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------|
| `topic`          | string or keyword      | The topic that the content should be written about.                                                                                       |
| `instructions`   | string                 | System instructions relating to the topic, such as tone, context, business information.                                                   |
| `content_type`   | string                 |<ul><li>`article`: A detailed article, including subheadings and a conclusion based on the topic.</li><li>`faq`: Questions and answers based on the topic.</li><li>`freeform`: For full control over the prompt sent to the AI provider. Limit and Language options are ignored.</li><li>`paragraph`: A single paragraph of content based on the topic.</li></ul> |
| `limit`          | int                    | Maximum number of words (for `article`, `paragraph`), questions (for `faq`). Ignored for `freeform`.                                     |
| `language`       | string                 | Two character language code (e.g., 'en' for English).                                                                                     |
| `temperature`    | float                  | Number between 0 and 2, in 0.1 steps. Controls randomness. Higher values increase randomness.                                               |
| `top_p`          | float                  | Number between 0 and 1, in 0.1 steps. Alternative to Temperature, controls token pool diversity.                                             |
| `presence_penalty`| float                  | Number between -2.0 and 2.0, in 0.1 steps. Penalizes new tokens based on their presence in the text so far, encouraging new topics.         |
| `frequency_penalty`| float                  | Number between -2.0 and 2.0, in 0.1 steps. Penalizes new tokens based on their frequency in the text so far, reducing verbatim repetition. |

### Example Usage:

To generate an article about "Web Design" in English with a word limit of 500 words using OpenAI:

```html
[page-generator-pro-openai topic="Web Design" content_type="article" limit="500" language="en"]
```

For freeform prompts, you can include detailed instructions:

```html
[page-generator-pro-openai topic="Write a 250 word paragraph about how to find the best {service}. The style should be an informative, professional tone, written in French." content_type="freeform" language="fr"]
```
```

--------------------------------

### WP-CLI: List Content Groups

Source: https://www.wpzinc.com/documentation/page-generator-pro/generate-wp-cli/%29

Runs the _List Content Groups_ command, displaying information about content groups similar to the plugin's interface.

```APIDOC
## List Content Groups

### Description
Runs the _List Content Groups_ command, displaying information similar to that available at Page Generator Pro > Generate Content.

### Method
WP-CLI Command

### Endpoint
`wp page-generator-pro-list-content-groups`

### Parameters
This command does not take any parameters.
```

--------------------------------

### AI Provider Shortcodes for Page Generators Pro

Source: https://www.wpzinc.com/documentation/page-generator-pro/generate-dynamic-elements-claude-ai

This section details the shortcode syntax for integrating content from various AI providers using the Page Generators Pro plugin. Each provider has a specific shortcode that accepts parameters to control content generation. Ensure correct syntax for each provider to successfully generate AI content.

```php
[page-generator-pro-alibaba parameter="value" ...]
```

```php
[page-generator-pro-claude-ai parameter="value" ...]
```

```php
[page-generator-pro-deepseek parameter="value" ...]
```

```php
[page-generator-pro-gemini-ai parameter="value" ...]
```

```php
[page-generator-pro-grok-ai parameter="value" ...]
```

```php
[page-generator-pro-mistral-ai parameter="value" ...]
```

```php
[page-generator-pro-openai parameter="value" ...]
```

```php
[page-generator-pro-openrouter parameter="value" ...]
```

```php
[page-generator-pro-perplexity parameter="value" ...]
```

--------------------------------

### WP-CLI: Test Generate Content

Source: https://www.wpzinc.com/documentation/page-generator-pro/generate-wp-cli/%29

Runs the _Test_ command for content generation, simulating a click on the _Test_ button for a given group ID.

```APIDOC
## Test Generate Content

### Description
Runs the _Test_ command, behaving as if you click the _Test_ button for the given group_id.

### Method
WP-CLI Command

### Endpoint
`wp page-generator-pro-test-content group_id`

### Parameters
#### Path Parameters
- **group_id** (string) - Required - The ID of the content group to test generation for.
```

--------------------------------

### Filter Page Generator Pro Groups Terms Get All (PHP)

Source: https://www.wpzinc.com/documentation/page-generator-pro/developers

This filter allows modification of the array of groups before they are returned. It accepts the groups array and the original groups object. Use this to filter or modify the list of groups being retrieved.

```php
add_filter( 'page_generator_pro_groups_terms_get_all', function( $groups_arr, $groups ) {
	// ... your code here
	// Return value
	return $groups_arr;
}, 10, 2 );
```

--------------------------------

### Get TinyMCE Plugins (Non-Shortcode/Block)

Source: https://www.wpzinc.com/documentation/page-generator-pro/developers

This filter retrieves an array of TinyMCE plugins that are not related to shortcodes or blocks, such as Autocomplete or Generate Spintax. It takes an array of plugins as input and should return the filtered array. This is useful for managing specific editor functionalities.

```php
add_filter( 'page_generator_pro_editor_get_tinymce_plugins', function( $plugins ) {
	// ... your code here
	// Return value
	return $plugins;
}, 10, 1 );
```

--------------------------------

### AI Content Shortcode Syntax

Source: https://www.wpzinc.com/documentation/page-generator-pro/generate-dynamic-elements-gemini-ai

This section outlines the basic shortcode syntax for integrating AI content from various providers into your website. You can use these shortcodes within your page builder's text editor or directly in your content.

```APIDOC
## Adding: Page Builders

To add AI content within other supported Page Builders, you’ll need to use that Page Builder’s Text Editor widget/module, which typically uses the Classic Editor (sometimes known as TinyMCE).
Refer to the Dynamic Elements Documentation for how to add a Dynamic Element specific to your Page Builder.
If your Page Builder **does not** provide a Text Editor widget/block that uses the Classic Editor, **you can still use Dynamic Elements**. However, you’ll need to manually build the shortcode, inserting it into your Page Builder’s content.

Provider| Shortcode Syntax  
---|---
Alibaba Qwen| `[page-generator-pro-alibaba parameter="value" ...]`  
Claude AI| `[page-generator-pro-claude-ai parameter="value" ...]`  
Deepseek| `[page-generator-pro-deepseek parameter="value" ...]`  
Gemini AI| `[page-generator-pro-gemini-ai parameter="value" ...]`  
Grok AI| `[page-generator-pro-grok-ai parameter="value" ...]`  
Mistral AI| `[page-generator-pro-mistral-ai parameter="value" ...]`  
Open AI| `[page-generator-pro-openai parameter="value" ...]`  
OpenRouter| `[page-generator-pro-openrouter parameter="value" ...]`  
Perplexity| `[page-generator-pro-perplexity parameter="value" ...]`
```

--------------------------------

### Filter to Get Modal Dimensions in Page Generator Pro Shortcode

Source: https://www.wpzinc.com/documentation/page-generator-pro/developers

This filter is used to retrieve or modify the dimensions (width and height) of a modal window used within Page Generator Pro shortcodes. It allows for customization of modal sizes.

```php
add_filter( 'page_generator_pro_shortcode_get_modal_dimensions', function( $dimensions ) {
	// ... your code here
	// Return value
	return $dimensions;
}, 10, 1 );
```
Tokens:
Raw