# speechkit/6.3.0/src/Component/Settings/SettingsUtils.php

BeyondWords – AI audio for publishers, version 6.3.0. 285 lines.

- Page: https://pluginprobe.com/plugins/speechkit/6.3.0/code/src/Component/Settings/SettingsUtils.php
- Raw: https://pluginprobe.com/plugins/speechkit/6.3.0/raw/src/Component/Settings/SettingsUtils.php
- Modified: 2026-04-12T21:25:20+00:00

Line numbers below start at 1. Link to a line or a range by appending a fragment to the
page URL, for example `https://pluginprobe.com/plugins/speechkit/6.3.0/code/src/Component/Settings/SettingsUtils.php#L10-L20`.

```php
<?php
// phpcs:disable Generic.Files.LineLength.TooLong

declare(strict_types=1);

namespace Beyondwords\Wordpress\Component\Settings;

use Beyondwords\Wordpress\Core\ApiClient;
use Beyondwords\Wordpress\Core\Environment;
use Beyondwords\Wordpress\Core\Request;

/**
 * BeyondWords Settings Utilities.
 *
 * @package    Beyondwords
 * @subpackage Beyondwords/includes
 * @author     Stuart McAlpine <stu@beyondwords.io>
 * @since      3.5.0
 */
defined('ABSPATH') || exit;

class SettingsUtils
{
    /**
     * Get the post types BeyondWords will consider for compatibility.
     *
     * We don't consider many of the core built-in post types for compatibity
     * because they don't support the features we need such as titles, body,
     * custom fields, etc.
     *
     * @since 3.7.0
     * @since 4.5.0 Renamed from getAllowedPostTypes to getConsideredPostTypes.
     * @since 4.6.2 Exclude wp_font_face and wp_font_family from considered post types.
     *
     * @static
     *
     * @return string[] Array of post type names.
     **/
    public static function getConsideredPostTypes(): array
    {
        $postTypes = get_post_types();

        $skip = [
            'attachment',
            'custom_css',
            'customize_changeset',
            'nav_menu_item',
            'oembed_cache',
            'revision',
            'user_request',
            'wp_block',
            'wp_font_face',
            'wp_font_family',
            'wp_template',
            'wp_template_part',
            'wp_global_styles',
            'wp_navigation',
        ];

        // Remove the skipped post types
        $postTypes = array_diff($postTypes, $skip);

        return array_values($postTypes);
    }

    /**
     * Get the post types that are compatible with BeyondWords.
     *
     * - Start with the considered post types
     * - Allow publishers to filter the list
     * - Filter again, removing any that are incompatible
     *
     * @since 3.0.0
     * @since 3.2.0 Removed $output parameter to always output names, never objects.
     * @since 3.2.0 Added `beyondwords_post_types` filter.
     * @since 3.5.0 Moved from Core\Utils to Component\Settings\SettingsUtils.
     * @since 3.7.0 Refactored forbidden/allowed/supported post type methods to improve site health debugging info.
     * @since 4.5.0 Renamed from getSupportedPostTypes to getCompatiblePostTypes.
     * @since 5.0.0 Remove beyondwords_post_types filter.
     *
     * @static
     *
     * @return string[] Array of post type names.
     **/
    public static function getCompatiblePostTypes(): array
    {
        $postTypes = SettingsUtils::getConsideredPostTypes();

        /**
         * Filters the post types supported by BeyondWords.
         *
         * This defaults to all registered post types with 'custom-fields' in their 'supports' array.
         *
         * If any of the supplied post types do not support custom fields then they will be removed
         * from the array.
         *
         * @since 3.3.3 Introduced as beyondwords_post_types
         * @since 4.3.0 Renamed from beyondwords_post_types to beyondwords_settings_post_types.
         *
         * @param string[] The post types supported by BeyondWords.
         */
        $postTypes = apply_filters('beyondwords_settings_post_types', $postTypes);

        // Remove incompatible post types
        $postTypes = array_diff($postTypes, SettingsUtils::getIncompatiblePostTypes());

        return array_values($postTypes);
    }

    /**
     * Get the post types that are incompatible with BeyondWords.
     *
     * The requirements are:
     * - Must support Custom Fields.
     *
     * @since 4.5.0
     *
     * @static
     *
     * @return string[] Array of post type names.
     **/
    public static function getIncompatiblePostTypes(): array
    {
        $postTypes = SettingsUtils::getConsideredPostTypes();

        // Filter the array, removing unsupported post types
        $postTypes = array_filter($postTypes, function ($postType) {
            if (post_type_supports($postType, 'custom-fields')) {
                return false;
            }

            return true;
        });

        return array_values($postTypes);
    }

    /**
     * Do we have both an API Key and Project ID?
     *
     * @since  5.2.0
     * @static
     */
    public static function hasApiCreds(): bool
    {
        $projectId = trim(strval(get_option('beyondwords_project_id')));
        $apiKey    = trim(strval(get_option('beyondwords_api_key')));

        return strlen($projectId) && strlen($apiKey);
    }

    /**
     * Do we have a valid REST API connection for the BeyondWords REST API?
     *
     * Note that this only whether a valid REST API connection was made when
     * the API Key was supplied. The API connection may be invalidated at a later
     * date e.g. if the API Key is revoked.
     *
     * @since  5.2.0
     * @static
     */
    public static function hasValidApiConnection(): bool
    {
        return boolval(get_option('beyondwords_valid_api_connection'));
    }

    /**
     * Validate the BeyondWords REST API connection.
     *
     * @since 5.0.0
     * @since 5.2.0 Moved from Sync class into SettingsUtils class.
     * @static
     **/
    public static function validateApiConnection(): bool
    {
        // This may have been left over from previous versions
        delete_transient('beyondwords_validate_api_connection');

        // Assume invalid connection
        delete_option('beyondwords_valid_api_connection');

        $projectId = get_option('beyondwords_project_id');
        $apiKey    = get_option('beyondwords_api_key');

        if (! $projectId || ! $apiKey) {
            return false;
        }

        $url = sprintf('%s/projects/%d', Environment::getApiUrl(), $projectId);

        $response = ApiClient::callApi(
            new Request('GET', $url)
        );

        $statusCode = wp_remote_retrieve_response_code($response);

        if ($statusCode === 200) {
            update_option('beyondwords_valid_api_connection', gmdate(\DateTime::ATOM), false);
            wp_cache_set('beyondwords_sync_to_wordpress', ['all'], 'beyondwords', 60);
            return true;
        }

        // Cancel any syncs
        wp_cache_delete('beyondwords_sync_to_wordpress', 'beyondwords');

        $debug = sprintf(
            '<code>%s</code>: <code>%s</code>',
            wp_remote_retrieve_response_code($response),
            wp_remote_retrieve_body($response)
        );

        self::addSettingsErrorMessage(
            sprintf(
                /* translators: %s is replaced with the BeyondWords REST API response debug data */
                __(
                    'We were unable to validate your BeyondWords REST API connection.<br />Please check your project ID and API key, save changes, and contact us for support if this message remains.<br /><br />BeyondWords REST API Response:<br />%s', // phpcs:ignore Generic.Files.LineLength.TooLong
                    'speechkit'
                ),
                $debug,
            ),
            'Settings/ValidApiConnection'
        );

        return false;
    }

    /**
     * A color input.
     *
     * @since  5.0.0
     * @static
     *
     * @param string $label Content for the `<label>`
     * @param string $name  `name` attribute for the `<input />`
     * @param string $value `value` attribute for the `<input />`
     */
    public static function colorInput(string $label, string $name, string $value): void
    {
        ?>
        <div class="color-input">
            <label>
                    <?php echo esc_attr($label); ?>
            </label>
            <output
                for="<?php echo esc_attr($name); ?>"
                style="background: <?php echo esc_attr($value); ?>; margin-right: 0.25rem;"
            ></output>
            <input
                name="<?php echo esc_attr($name); ?>"
                type="text"
                value="<?php echo esc_attr($value); ?>"
                class="small-text"
                oninput="this.previousElementSibling.style.background = 'transparent'; this.previousElementSibling.style.background = `${this.value}`"
            />
        </div>
        <?php
    }

    /**
     * Add settings error message.
     *
     * @since 5.2.0
     * @static
     *
     * @param string $message The error message.
     * @param string $errorId The error ID.
     **/
    public static function addSettingsErrorMessage(string $message, string $errorId = ''): void
    {
        $errors = wp_cache_get('beyondwords_settings_errors', 'beyondwords');

        if (empty($errors)) {
            $errors = [];
        }

        if (empty($errorId)) {
            $errorId = bin2hex(random_bytes(8));
        }

        $errors[$errorId] = $message;

        wp_cache_set('beyondwords_settings_errors', $errors, 'beyondwords');
    }
}

```