=> false ], 'nosnippet' => [ 'type' => 'boolean', 'default' => false ], 'noodp' => [ 'type' => 'boolean', 'default' => false ], 'maxSnippet' => [ 'type' => 'number', 'default' => -1 ], 'maxVideoPreview' => [ 'type' => 'number', 'default' => -1 ], 'maxImagePreview' => [ 'type' => 'string', 'default' => 'large' ] ], 'showDateInGooglePreview' => [ 'type' => 'boolean', 'default' => true ], 'showPostThumbnailInSearch' => [ 'type' => 'boolean', 'default' => true ], 'showMetaBox' => [ 'type' => 'boolean', 'default' => true ], 'keywords' => [ 'type' => 'string', 'localized' => true ] ] ] ] ], 'searchStatistics' => [ 'postTypes' => [ 'all' => [ 'type' => 'boolean', 'default' => true ], 'included' => [ 'type' => 'array', 'default' => [ 'post', 'page' ] ], ] ], 'tools' => [ 'robots' => [ 'enable' => [ 'type' => 'boolean', 'default' => false ], 'rules' => [ 'type' => 'array', 'default' => [] ], 'robotsDetected' => [ 'type' => 'boolean', 'default' => true ], ], 'importExport' => [ 'backup' => [ 'lastTime' => [ 'type' => 'string' ], 'data' => [ 'type' => 'string' ], ] ] ], 'deprecated' => [ 'breadcrumbs' => [ 'enable' => [ 'type' => 'boolean', 'default' => true ] ], 'searchAppearance' => [ 'global' => [ 'descriptionFormat' => [ 'type' => 'string' ], 'schema' => [ 'enableSchemaMarkup' => [ 'type' => 'boolean', 'default' => true ] ] ], 'advanced' => [ 'autogenerateDescriptions' => [ 'type' => 'boolean', 'default' => true ], 'runShortcodesInDescription' => [ 'type' => 'boolean', 'default' => true ], // TODO: Remove this in a future update. 'useContentForAutogeneratedDescriptions' => [ 'type' => 'boolean', 'default' => false ], 'excludePosts' => [ 'type' => 'array', 'default' => [] ], 'excludeTerms' => [ 'type' => 'array', 'default' => [] ], 'noPaginationForCanonical' => [ 'type' => 'boolean', 'default' => true ] ] ], 'sitemap' => [ 'general' => [ 'advancedSettings' => [ 'dynamic' => [ 'type' => 'boolean', 'default' => true ] ] ] ], 'tools' => [ 'blocker' => [ 'blockBots' => [ 'type' => 'boolean' ], 'blockReferer' => [ 'type' => 'boolean' ], 'track' => [ 'type' => 'boolean' ], 'custom' => [ 'enable' => [ 'type' => 'boolean' ], 'bots' => [ 'type' => 'html', 'default' => '' ], 'referer' => [ 'type' => 'html', 'default' => '' ] ] ] ] ], 'writingAssistant' => [ 'postTypes' => [ 'all' => [ 'type' => 'boolean', 'default' => true ], 'included' => [ 'type' => 'array', 'default' => [ 'post', 'page' ] ], ] ] // phpcs:enable WordPress.Arrays.ArrayDeclarationSpacing.AssociativeArrayFound ]; /** * The Construct method. * * @since 4.0.0 * * @param string $optionsName An array of options. */ public function __construct( $optionsName = 'aioseo_options' ) { $this->optionsName = $optionsName; $this->init(); add_action( 'shutdown', [ $this, 'save' ] ); } /** * Initializes the options. * * @since 4.0.0 * * @return void */ public function init() { $this->setInitialDefaults(); $this->translateDefaults(); $this->setDbOptions(); add_action( 'wp_loaded', [ $this, 'maybeFlushRewriteRules' ] ); } /** * Sets the DB options to the class after merging in new defaults and dropping unknown values. * * @since 4.0.14 * * @return void */ public function setDbOptions() { // Refactor options. $this->defaultsMerged = array_replace_recursive( $this->defaults, $this->defaultsMerged ); $dbOptions = $this->getDbOptions( $this->optionsName ); $options = array_replace_recursive( $this->defaultsMerged, $this->addValueToValuesArray( $this->defaultsMerged, $dbOptions ) ); aioseo()->core->optionsCache->setOptions( $this->optionsName, apply_filters( 'aioseo_get_options', $options ) ); // Get the localized options. $dbOptionsLocalized = get_option( $this->optionsName . '_localized' ); if ( empty( $dbOptionsLocalized ) ) { $dbOptionsLocalized = []; } $this->localized = $dbOptionsLocalized; } /** * Sets the initial defaults that can't be defined in the property because of PHP 5.4. * * @since 4.1.4 * * @return void */ protected function setInitialDefaults() { static $hasInitialized = false; if ( $hasInitialized ) { return; } $hasInitialized = true; $this->defaults['deprecated']['tools']['blocker']['custom']['bots']['default'] = implode( "\n", aioseo()->badBotBlocker->getBotList() ); $this->defaults['deprecated']['tools']['blocker']['custom']['referer']['default'] = implode( "\n", aioseo()->badBotBlocker->getRefererList() ); $this->defaults['searchAppearance']['global']['schema']['organizationLogo']['default'] = aioseo()->helpers->getSiteLogoUrl() ? aioseo()->helpers->getSiteLogoUrl() : ''; $this->defaults['advanced']['emailSummary']['recipients']['default'] = [ [ 'email' => get_bloginfo( 'admin_email' ), 'frequency' => 'monthly', ] ]; } /** * For our defaults array, some options need to be translated, so we do that here. * * @since 4.0.0 * * @return void */ public function translateDefaults() { static $hasInitialized = false; if ( $hasInitialized ) { return; } $hasInitialized = true; $default = sprintf( '{"label":"%1$s","value":"default"}', __( 'default', 'all-in-one-seo-pack' ) ); $this->defaults['sitemap']['general']['advancedSettings']['priority']['homePage']['priority']['default'] = $default; $this->defaults['sitemap']['general']['advancedSettings']['priority']['homePage']['frequency']['default'] = $default; $this->defaults['sitemap']['general']['advancedSettings']['priority']['postTypes']['priority']['default'] = $default; $this->defaults['sitemap']['general']['advancedSettings']['priority']['postTypes']['frequency']['default'] = $default; $this->defaults['sitemap']['general']['advancedSettings']['priority']['taxonomies']['priority']['default'] = $default; $this->defaults['sitemap']['general']['advancedSettings']['priority']['taxonomies']['frequency']['default'] = $default; $this->defaults['breadcrumbs']['homepageLabel']['default'] = __( 'Home', 'all-in-one-seo-pack' ); $this->defaults['breadcrumbs']['archiveFormat']['default'] = sprintf( '%1$s #breadcrumb_archive_post_type_name', __( 'Archives for', 'all-in-one-seo-pack' ) ); $this->defaults['breadcrumbs']['searchResultFormat']['default'] = sprintf( '%1$s \'#breadcrumb_search_string\'', __( 'Search Results for', 'all-in-one-seo-pack' ) ); $this->defaults['breadcrumbs']['errorFormat404']['default'] = __( '404 - Page Not Found', 'all-in-one-seo-pack' ); } /** * Sanitizes, then saves the options to the database. * * @since 4.0.0 * * @param array $options An array of options to sanitize, then save. * @return void */ public function sanitizeAndSave( $options ) { $sitemapOptions = ! empty( $options['sitemap'] ) ? $options['sitemap'] : null; $oldSitemapOptions = aioseo()->options->sitemap->all(); $generalSitemapOptions = ! empty( $options['sitemap']['general'] ) ? $options['sitemap']['general'] : null; $oldGeneralSitemapOptions = aioseo()->options->sitemap->general->all(); $deprecatedGeneralSitemapOptions = ! empty( $options['deprecated']['sitemap']['general'] ) ? $options['deprecated']['sitemap']['general'] : null; $oldDeprecatedGeneralSitemapOptions = aioseo()->options->deprecated->sitemap->general->all(); $oldPhoneOption = aioseo()->options->searchAppearance->global->schema->phone; $phoneNumberOptions = isset( $options['searchAppearance']['global']['schema']['phone'] ) ? $options['searchAppearance']['global']['schema']['phone'] : null; $oldHtmlSitemapUrl = aioseo()->options->sitemap->html->pageUrl; $logsRetention = isset( $options['searchAppearance']['advanced']['blockArgs']['logsRetention'] ) ? $options['searchAppearance']['advanced']['blockArgs']['logsRetention'] : null; $oldLogsRetention = aioseo()->options->searchAppearance->advanced->blockArgs->logsRetention; // Remove category base. $removeCategoryBase = isset( $options['searchAppearance']['advanced']['removeCategoryBase'] ) ? $options['searchAppearance']['advanced']['removeCategoryBase'] : null; $removeCategoryBaseOld = aioseo()->options->searchAppearance->advanced->removeCategoryBase; $options = $this->maybeRemoveUnfilteredHtmlFields( $options ); $this->init(); if ( ! is_array( $options ) ) { return; } $this->sanitizeEmailSummary( $options ); // First, recursively replace the new options into the cached state. // It's important we use the helper method since we want to replace populated arrays with empty ones if needed (when a setting was cleared out). $cachedOptions = aioseo()->core->optionsCache->getOptions( $this->optionsName ); $dbOptions = aioseo()->helpers->arrayReplaceRecursive( $cachedOptions, $this->addValueToValuesArray( $cachedOptions, $options, [], true ) ); // Now, we must also intersect both arrays to delete any individual keys that were unset. // We must do this because, while arrayReplaceRecursive will update the values for keys or empty them out, // it will keys that aren't present in the replacement array unaffected in the target array. $dbOptions = aioseo()->helpers->arrayIntersectRecursive( $dbOptions, $this->addValueToValuesArray( $cachedOptions, $options, [], true ), 'value' ); if ( isset( $options['social']['profiles']['additionalUrls'] ) ) { $dbOptions['social']['profiles']['additionalUrls'] = preg_replace( '/\h/', "\n", $options['social']['profiles']['additionalUrls'] ); } $newOptions = ! empty( $options['sitemap']['html'] ) ? $options['sitemap']['html'] : null; if ( ! empty( $newOptions ) && aioseo()->options->sitemap->html->enable ) { $newOptions = ! empty( $options['sitemap']['html'] ) ? $options['sitemap']['html'] : null; $pageUrl = wp_parse_url( $newOptions['pageUrl'] ); $path = ! empty( $pageUrl['path'] ) ? untrailingslashit( $pageUrl['path'] ) : ''; if ( $path ) { $existingPage = get_page_by_path( $path, OBJECT ); if ( is_object( $existingPage ) ) { // If the page exists, don't override the previous URL. $options['sitemap']['html']['pageUrl'] = $oldHtmlSitemapUrl; } } } // Update the cache state. aioseo()->core->optionsCache->setOptions( $this->optionsName, $dbOptions ); // Update localized options. update_option( $this->optionsName . '_localized', $this->localized ); // Finally, save the new values to the DB. $this->save( true ); // If phone settings have changed, let's see if we need to dump the phone number notice. if ( $phoneNumberOptions && $phoneNumberOptions !== $oldPhoneOption ) { $notification = Models\Notification::getNotificationByName( 'v3-migration-schema-number' ); if ( $notification->exists() ) { Models\Notification::deleteNotificationByName( 'v3-migration-schema-number' ); } } // If sitemap settings were changed, static files need to be regenerated. if ( ! empty( $deprecatedGeneralSitemapOptions ) && ! empty( $generalSitemapOptions ) ) { if ( ( aioseo()->helpers->arraysDifferent( $oldGeneralSitemapOptions, $generalSitemapOptions ) || aioseo()->helpers->arraysDifferent( $oldDeprecatedGeneralSitemapOptions, $deprecatedGeneralSitemapOptions ) ) && $generalSitemapOptions['advancedSettings']['enable'] && ! $deprecatedGeneralSitemapOptions['advancedSettings']['dynamic'] ) { aioseo()->sitemap->scheduleRegeneration(); } } // Add or remove schedule for clearing crawl cleanup logs. if ( ! empty( $logsRetention ) && $oldLogsRetention !== $logsRetention ) { aioseo()->crawlCleanup->scheduleClearingLogs(); } if ( ! empty( $sitemapOptions ) ) { aioseo()->searchStatistics->sitemap->maybeSync( $oldSitemapOptions, $sitemapOptions ); } if ( null !== $removeCategoryBase && $removeCategoryBase !== $removeCategoryBaseOld ) { aioseo()->options->flushRewriteRules(); } // This is required in order for the Pro options to be refreshed before they save data again. $this->refresh(); } /** * Sanitizes the `emailSummary` option. * * @since 4.7.2 * * @param array $options All options, passed by reference. * @return void */ private function sanitizeEmailSummary( &$options ) { foreach ( ( $options['advanced']['emailSummary']['recipients'] ?? [] ) as $k => &$recipient ) { $recipient['email'] = is_email( $recipient['email'] ); // Remove empty emails. if ( empty( $recipient['email'] ) ) { unset( $options['advanced']['emailSummary']['recipients'][ $k ] ); continue; } // Remove duplicate emails with the same frequency. foreach ( $options['advanced']['emailSummary']['recipients'] as $k2 => $recipient2 ) { if ( $k !== $k2 && $recipient['email'] === $recipient2['email'] && $recipient['frequency'] === $recipient2['frequency'] ) { unset( $options['advanced']['emailSummary']['recipients'][ $k ] ); break; } } } } /** * If the user does not have access to unfiltered HTML, we need to remove them from saving. * * @since 4.0.0 * * @param array $options An array of options. * @return array An array of options. */ private function maybeRemoveUnfilteredHtmlFields( $options ) { if ( current_user_can( 'unfiltered_html' ) ) { return $options; } if ( ! empty( $options['webmasterTools'] ) && isset( $options['webmasterTools']['miscellaneousVerification'] ) ) { unset( $options['webmasterTools']['miscellaneousVerification'] ); } if ( ! empty( $options['rssContent'] ) && isset( $options['rssContent']['before'] ) ) { unset( $options['rssContent']['before'] ); } if ( ! empty( $options['rssContent'] ) && isset( $options['rssContent']['after'] ) ) { unset( $options['rssContent']['after'] ); } return $options; } /** * Indicate we need to flush rewrite rules on next load. * * @since 4.0.17 * * @return void */ public function flushRewriteRules() { update_option( 'aioseo_flush_rewrite_rules_flag', true ); } /** * Flush rewrite rules if needed. * * @since 4.0.17 * * @return void */ public function maybeFlushRewriteRules() { if ( get_option( 'aioseo_flush_rewrite_rules_flag' ) ) { flush_rewrite_rules(); delete_option( 'aioseo_flush_rewrite_rules_flag' ); } } }