| Property | Type | Description | |
|---|---|---|---|
| $seo_settings_page_slug | Hold the SEO Settings Page ID for this plugin. |
| Property | Type | Description | |
|---|---|---|---|
| $o_plugin_updated | Holds the update option. | ||
| $settings_field | Site Settings field. |
| Method | Description | |
|---|---|---|
| fb_locales ( ) : array | Returns Facebook locales array values. | |
| get_all_options ( string $setting = null ) : array | Return current option array. | |
| get_default_option ( string $key, boolean $use_cache = true ) : mixed | Return Default SEO options from the SEO options array. | |
| get_default_settings ( string $key, string $setting = '', boolean $use_cache = true ) : integer | boolean | string | Get the default of any of the The SEO Framework settings. | |
| get_default_site_options ( ) : array | Holds default site options. | |
| get_option ( string $key, boolean $use_cache = true ) : mixed | Return SEO options from the SEO options database. | |
| get_site_option ( string $key, boolean $use_cache = true ) : mixed | Return SEO options from the SEO options database. | |
| get_user_id ( ) : integer | Sets up user ID and returns it if user is found. | |
| get_user_meta ( integer $user_id, string $key = THE_SEO_FRAMEWORK_USER_OPTIONS, boolean $use_cache = true ) : array | Fetches The SEO Framework usermeta. | |
| get_user_option ( integer $user_id, string $option, mixed $default = null ) : mixed | Fetches user SEO user meta data by name. | |
| get_warned_settings ( string $key, string $setting = '', boolean $use_cache = true ) : integer | Get the warned setting of any of the The SEO Framework settings. | |
| get_warned_site_options ( ) : array | Holds warned site options array. | |
| language_keys ( ) : array | Returns Facebook locales array keys. | |
| register_settings ( ) : void | Register the database settings for storage. | |
| site_updated_plugin_notice ( ) | Echos plugin updated notification. | |
| site_updated_plugin_option ( ) : void | Updates option from default options at plugin update. | |
| the_seo_framework_get_option ( string $key, string $setting = null, boolean $use_cache = true ) : mixed | Return option from the options table and cache result. | |
| update_settings ( string | array $new = '', string $settings_field = '' ) | Allows updating of settings. | |
| update_user_option ( integer $user_id, string $option, mixed $value ) : boolean | Updates user SEO option. |
| Method | Description | |
|---|---|---|
| __construct ( ) | Constructor, load parent constructor and set up cachable variables. | |
| default_site_options ( array $args = [] ) : array | Return the parsed default options array. | |
| pre_output_site_updated_plugin_notice ( ) | Determine whether to output update notice directly or on refresh. | |
| update_hidden_options_to_default ( ) | Updates special hidden values to default on settings save. | |
| warned_site_options ( array $args = [] ) : array | Return the Warned site options. Options which should be 'avoided' return true. |
| protected __construct ( ) |
| protected default_site_options ( array $args = [] ) : array | ||
| $args | array | Additional default options to filter. |
| return | array | The SEO Framework Options |
| public fb_locales ( ) : array | ||
| return | array | Valid Facebook locales |
| public get_all_options ( string $setting = null ) : array | ||
| $setting | string | The setting key. |
| return | array | Options. |
| public get_default_settings ( string $key, string $setting = '', boolean $use_cache = true ) : integer | boolean | string | ||
| $key | string | required The option name |
| $setting | string | optional The settings field |
| $use_cache | boolean | optional Use the options cache or not. For debugging purposes. |
| return | integer | boolean | string | default option int '-1' if option doesn't exist. |
| public get_default_site_options ( ) : array | ||
| return | array | Default site options. |
| public get_user_id ( ) : integer | ||
| return | integer | $user_id : 0 if user is not found. |
| public get_user_meta ( integer $user_id, string $key = THE_SEO_FRAMEWORK_USER_OPTIONS, boolean $use_cache = true ) : array | ||
| $user_id | integer | The user ID. |
| $key | string | The user metadata key. Leave empty to fetch all data. |
| $use_cache | boolean | Whether to store and use options from cache. |
| return | array | The user SEO meta data. |
| public get_user_option ( integer $user_id, string $option, mixed $default = null ) : mixed | ||
| $user_id | integer | The user ID. When empty, it will try to fetch the current user. |
| $option | string | The option name. |
| $default | mixed | The default value to return when the data doesn't exist. |
| return | mixed | The metadata value. |
| public get_warned_settings ( string $key, string $setting = '', boolean $use_cache = true ) : integer | ||
| $key | string | required The option name |
| $setting | string | optional The settings field |
| $use_cache | boolean | optional Use the options cache or not. For debugging purposes. |
| return | integer | 0|1 Whether the option is flagged as dangerous for SEO. int '-1' if option doesn't exist. |
| public get_warned_site_options ( ) : array | ||
| return | array | $options. |
| public language_keys ( ) : array | ||
| return | array | Valid Facebook locale keys |
| protected pre_output_site_updated_plugin_notice ( ) |
| public register_settings ( ) : void | ||
| return | void | |
| public site_updated_plugin_notice ( ) |
| public site_updated_plugin_option ( ) : void | ||
| return | void | early if already has been updated. |
| public the_seo_framework_get_option ( string $key, string $setting = null, boolean $use_cache = true ) : mixed | ||
| $key | string | Option name. |
| $setting | string | Optional. Settings field name. Eventually defaults to null if not passed as an argument. |
| $use_cache | boolean | Optional. Whether to use the cache value or not. Default is true. |
| return | mixed | The value of this $key in the database. |
| protected warned_site_options ( array $args = [] ) : array | ||
| $args | array | Additional warned options to filter. |
| return | array | The SEO Framework Warned Options |
| public $seo_settings_page_slug |