Support Log in

35. Options Reference

Developer Guide
Prefer video? Watch the Rank Forge tutorials 9 short guides covering every feature Watch

All Rank Forge options use the rankforge_ prefix and are stored in wp_options.

Core Settings

Option KeyTypeDescriptionDefault
rankforge_settingsarrayMain plugin settings. The Settings screen replaces the whole array each time it is saved, so after a save it holds only auto_analyze and schema_enabled. The one other key that Rank Forge reads is image_filename_cleanup: when it is set and false, the file names of uploaded images are not cleaned. No screen sets it, and a save of the Settings screen removes it. The keys auto_meta and internal_links_enabled, which earlier versions wrote, are no longer written and nothing reads them[]
rankforge_settings['auto_analyze']boolNot a switch: the Settings screen writes true here each time it is saved, and Rank Forge never reads it, so it does not switch analysis on post save on or off. To stop the analysis, remove the save_post callback RANKFORGE_Analyzer::auto_analyze, which also stops the Rank Forge box values from being saved (see Disabling Specific Features)true
rankforge_settings['schema_enabled']boolNot a switch: the Settings screen writes true here each time it is saved, and Rank Forge never reads it, so it does not switch JSON-LD output on or offtrue

Meta Templates

Option KeyTypeDescription
rankforge_title_separatorstringSeparator character (| default)
rankforge_title_templatesarrayGlobal templates by post type
rankforge_tax_templatesarrayTaxonomy templates by {tax}_{term_id}, each with a title and a description, used for a post that has that term. No Rank Forge screen writes this option, and the entries that the Yoast SEO and Rank Math imports store under {tax}_archive are not matched by this lookup

Feature Options

Option KeyTypeDescription
rankforge_sitemap_settingsarraySitemap config: max_urls is the maximum number of URLs per sitemap (default 1000; the Settings screen accepts 100 to 50000). The Settings screen also stores an empty enabled_types array, which the sitemap ignores
rankforge_robots_txtstringCustom robots.txt
rankforge_archive_robotsarrayPer-archive noindex
rankforge_default_og_imagestringDefault OG image URL
rankforge_auto_links_enabledboolAuto internal linking, read by the Pro add-on (default false); the Settings screen saves false when the Pro add-on is not loaded
rankforge_auto_links_maxintMax auto-links (1-10); reset to 3 when auto-links are unavailable
rankforge_local_seoarrayLocal business settings

GSC Options

Option KeyDescription
rankforge_gsc_client_id, rankforge_gsc_client_secret, rankforge_gsc_access_token, rankforge_gsc_refresh_token, rankforge_gsc_token_expiresRetired and no longer written: the Google connection is held on the managed backend, which keeps the tokens, so WordPress stores no client ID, client secret or token. A site that used the older in-plugin connection may still hold these rows; disconnecting Google deletes them
rankforge_gsc_propertyGSC property URL
rankforge_gsc_rankings_cacheCached rankings
rankforge_gsc_decay_cacheCached decay data
rankforge_gsc_last_syncLast sync timestamp

Reading and Writing Options

php
// Read and change the maximum number of URLs per sitemap
$settings = get_option( 'rankforge_sitemap_settings', [] );
$settings['max_urls'] = 2000;
update_option( 'rankforge_sitemap_settings', $settings );

// Export all Rank Forge options
global $wpdb;
$options = $wpdb->get_results(
    "SELECT option_name, option_value FROM {$wpdb->options}
     WHERE option_name LIKE 'rankforge_%' ORDER BY option_name"
);
$export = [];
foreach ( $options as $opt ) {
    $export[ $opt->option_name ] = maybe_unserialize( $opt->option_value );
}
file_put_contents( WP_CONTENT_DIR . '/rankforge-options-backup.json', wp_json_encode( $export, JSON_PRETTY_PRINT ) );

—

Forge AI Assistant Online

Hi! I'm the Rank Forge AI assistant. Ask me anything about the plugin — setup, features, troubleshooting, or development.

Just now
Powered by Forge AI · Browse docs