Admin
2 weeks ago
Ajax
2 weeks ago
Asset
2 weeks ago
Context
2 weeks ago
Customizer
2 weeks ago
Debug_Bar
2 weeks ago
Dialog
2 weeks ago
Documentation
2 weeks ago
Duplicate
2 weeks ago
Editor
2 weeks ago
Image
2 weeks ago
JSON_LD
2 weeks ago
Languages
2 weeks ago
Log
2 weeks ago
Meta
2 weeks ago
Models
2 weeks ago
PUE
2 weeks ago
Process
2 weeks ago
Promoter
2 weeks ago
REST
2 weeks ago
Repository
2 weeks ago
Service_Providers
2 weeks ago
Shortcode
2 weeks ago
Support
2 weeks ago
Tabbed_View
2 weeks ago
Tooltip
2 weeks ago
Traits
2 weeks ago
Utils
2 weeks ago
Validator
2 weeks ago
Widget
2 weeks ago
Abstract_Deactivation.php
2 weeks ago
Abstract_Plugin_Register.php
2 weeks ago
App_Shop.php
2 weeks ago
Assets.php
2 weeks ago
Assets_Pipeline.php
2 weeks ago
Autoloader.php
2 weeks ago
Cache.php
2 weeks ago
Cache_Listener.php
2 weeks ago
Changelog_Reader.php
2 weeks ago
Container.php
2 weeks ago
Context.php
2 weeks ago
Cost_Utils.php
2 weeks ago
Credits.php
2 weeks ago
Customizer.php
2 weeks ago
DB_Lock.php
2 weeks ago
Data.php
2 weeks ago
Date_Utils.php
2 weeks ago
Db.php
2 weeks ago
Debug.php
2 weeks ago
Dependency.php
2 weeks ago
Deprecation.php
2 weeks ago
Editor.php
2 weeks ago
Error.php
2 weeks ago
Exception.php
2 weeks ago
Extension.php
2 weeks ago
Extension_Loader.php
2 weeks ago
Feature_Detection.php
2 weeks ago
Field.php
2 weeks ago
Field_Conditional.php
2 weeks ago
Freemius.php
2 weeks ago
Log.php
2 weeks ago
Main.php
2 weeks ago
Notices.php
2 weeks ago
Plugin_Meta_Links.php
2 weeks ago
Plugins.php
2 weeks ago
Plugins_API.php
2 weeks ago
Post_History.php
2 weeks ago
Post_Transient.php
2 weeks ago
Promise.php
2 weeks ago
Repository.php
2 weeks ago
Rewrite.php
2 weeks ago
Settings.php
2 weeks ago
Settings_Manager.php
2 weeks ago
Settings_Tab.php
2 weeks ago
Simple_Table.php
2 weeks ago
Support.php
2 weeks ago
Tabbed_View.php
2 weeks ago
Template.php
2 weeks ago
Template_Factory.php
2 weeks ago
Template_Part_Cache.php
2 weeks ago
Templates.php
2 weeks ago
Terms.php
2 weeks ago
Timezones.php
2 weeks ago
Tracker.php
2 weeks ago
Updater.php
2 weeks ago
Validate.php
2 weeks ago
View_Helpers.php
2 weeks ago
Settings_Tab.php
228 lines
| 1 | <?php |
| 2 | |
| 3 | // Don't load directly |
| 4 | if ( ! defined( 'ABSPATH' ) ) { |
| 5 | die( '-1' ); |
| 6 | } |
| 7 | |
| 8 | if ( ! class_exists( 'Tribe__Settings_Tab' ) ) { |
| 9 | /** |
| 10 | * helper class that creates a settings tab |
| 11 | * this is a public API, use it to create tabs |
| 12 | * simply by instantiating this class |
| 13 | * |
| 14 | */ |
| 15 | class Tribe__Settings_Tab { |
| 16 | |
| 17 | /** |
| 18 | * Tab ID, used in query string and elsewhere |
| 19 | * @var string |
| 20 | */ |
| 21 | public $id; |
| 22 | |
| 23 | /** |
| 24 | * Tab's name |
| 25 | * @var string |
| 26 | */ |
| 27 | public $name; |
| 28 | |
| 29 | /** |
| 30 | * Tab's arguments |
| 31 | * @var array |
| 32 | */ |
| 33 | public $args; |
| 34 | |
| 35 | /** |
| 36 | * Defaults for tabs |
| 37 | * @var array |
| 38 | */ |
| 39 | public $defaults; |
| 40 | |
| 41 | /** |
| 42 | * class constructor |
| 43 | * |
| 44 | * @param string $id the tab's id (no spaces or special characters) |
| 45 | * @param string $name the tab's visible name |
| 46 | * @param array $args additional arguments for the tab |
| 47 | */ |
| 48 | public function __construct( $id, $name, $args = [] ) { |
| 49 | |
| 50 | // setup the defaults |
| 51 | $this->defaults = [ |
| 52 | 'fields' => [], |
| 53 | 'priority' => 50, |
| 54 | 'show_save' => true, |
| 55 | 'display_callback' => false, |
| 56 | 'network_admin' => false, |
| 57 | ]; |
| 58 | |
| 59 | // parse args with defaults |
| 60 | $this->args = wp_parse_args( $args, $this->defaults ); |
| 61 | |
| 62 | // set each instance variable and filter |
| 63 | $this->id = apply_filters( 'tribe_settings_tab_id', $id ); |
| 64 | $this->name = apply_filters( 'tribe_settings_tab_name', $name ); |
| 65 | foreach ( $this->defaults as $key => $value ) { |
| 66 | $this->{$key} = apply_filters( 'tribe_settings_tab_' . $key, $this->args[ $key ], $id ); |
| 67 | } |
| 68 | |
| 69 | // run actions & filters |
| 70 | if ( ! $this->network_admin ) { |
| 71 | add_filter( 'tribe_settings_all_tabs', [ $this, 'addAllTabs' ] ); |
| 72 | } |
| 73 | add_filter( 'tribe_settings_tabs', [ $this, 'addTab' ], $this->priority ); |
| 74 | } |
| 75 | |
| 76 | /** |
| 77 | * filters the tabs array from Tribe__Settings |
| 78 | * and adds the current tab to it |
| 79 | * does not add a tab if it's empty |
| 80 | * |
| 81 | * @param array $tabs the $tabs from Tribe__Settings |
| 82 | * |
| 83 | * @return array $tabs the filtered tabs |
| 84 | */ |
| 85 | public function addTab( $tabs ) { |
| 86 | $hideSettingsTabs = Tribe__Settings_Manager::get_network_option( 'hideSettingsTabs', [] ); |
| 87 | if ( ( isset( $this->fields ) || has_action( 'tribe_settings_content_tab_' . $this->id ) ) && ( empty( $hideSettingsTabs ) || ! in_array( $this->id, $hideSettingsTabs ) ) ) { |
| 88 | if ( ( is_network_admin() && $this->args['network_admin'] ) || ( ! is_network_admin() && ! $this->args['network_admin'] ) ) { |
| 89 | $tabs[ $this->id ] = $this->name; |
| 90 | add_filter( 'tribe_settings_fields', [ $this, 'addFields' ] ); |
| 91 | add_filter( 'tribe_settings_no_save_tabs', [ $this, 'showSaveTab' ] ); |
| 92 | add_filter( 'tribe_settings_content_tab_' . $this->id, [ $this, 'doContent' ] ); |
| 93 | } |
| 94 | } |
| 95 | |
| 96 | return $tabs; |
| 97 | } |
| 98 | |
| 99 | /** |
| 100 | * Adds this tab to the list of total tabs, even if it is not displayed. |
| 101 | * |
| 102 | * @param array $allTabs All the tabs from Tribe__Settings. |
| 103 | * |
| 104 | * @return array $allTabs All the tabs. |
| 105 | */ |
| 106 | public function addAllTabs( $allTabs ) { |
| 107 | $allTabs[ $this->id ] = $this->name; |
| 108 | |
| 109 | return $allTabs; |
| 110 | } |
| 111 | |
| 112 | |
| 113 | /** |
| 114 | * filters the fields array from Tribe__Settings |
| 115 | * and adds the current tab's fields to it |
| 116 | * |
| 117 | * @param array $field the $fields from Tribe__Settings |
| 118 | * |
| 119 | * @return array $fields the filtered fields |
| 120 | */ |
| 121 | public function addFields( $fields ) { |
| 122 | if ( ! empty ( $this->fields ) ) { |
| 123 | $fields[ $this->id ] = $this->fields; |
| 124 | } elseif ( has_action( 'tribe_settings_content_tab_' . $this->id ) ) { |
| 125 | $fields[ $this->id ] = $this->fields = [ 0 => null ]; // just to trick it |
| 126 | } |
| 127 | |
| 128 | return $fields; |
| 129 | } |
| 130 | |
| 131 | /** |
| 132 | * sets whether the current tab should show the save |
| 133 | * button or not |
| 134 | * |
| 135 | * @param array $noSaveTabs the $noSaveTabs from Tribe__Settings |
| 136 | * |
| 137 | * @return array $noSaveTabs the filtered non saving tabs |
| 138 | */ |
| 139 | public function showSaveTab( $noSaveTabs ) { |
| 140 | if ( ! $this->show_save || empty( $this->fields ) ) { |
| 141 | $noSaveTabs[ $this->id ] = $this->id; |
| 142 | } |
| 143 | |
| 144 | return $noSaveTabs; |
| 145 | } |
| 146 | |
| 147 | /** |
| 148 | * displays the content for the tab |
| 149 | * |
| 150 | * @return void |
| 151 | */ |
| 152 | public function doContent() { |
| 153 | if ( $this->display_callback && is_callable( $this->display_callback ) ) { |
| 154 | call_user_func( $this->display_callback ); |
| 155 | |
| 156 | return; |
| 157 | } |
| 158 | |
| 159 | $sent_data = get_option( 'tribe_settings_sent_data', [] ); |
| 160 | |
| 161 | if ( is_array( $this->fields ) && ! empty( $this->fields ) ) { |
| 162 | foreach ( $this->fields as $key => $field ) { |
| 163 | if ( isset( $sent_data[ $key ] ) ) { |
| 164 | // If we just saved [or attempted to], get the value that was input. |
| 165 | $value = $sent_data[ $key ]; |
| 166 | } else { |
| 167 | // Some options should always be stored at network level |
| 168 | $network_option = isset( $field['network_option'] ) ? (bool) $field['network_option'] : false; |
| 169 | |
| 170 | if ( is_network_admin() ) { |
| 171 | $parent_option = ( isset( $field['parent_option'] ) ) ? $field['parent_option'] : Tribe__Main::OPTIONNAMENETWORK; |
| 172 | } |
| 173 | if ( ! is_network_admin() ) { |
| 174 | $parent_option = ( isset( $field['parent_option'] ) ) ? $field['parent_option'] : Tribe__Main::OPTIONNAME; |
| 175 | } |
| 176 | // get the field's parent_option in order to later get the field's value |
| 177 | $parent_option = apply_filters( 'tribe_settings_do_content_parent_option', $parent_option, $key ); |
| 178 | $default = ( isset( $field['default'] ) ) ? $field['default'] : null; |
| 179 | $default = apply_filters( 'tribe_settings_field_default', $default, $field ); |
| 180 | |
| 181 | if ( ! $parent_option ) { |
| 182 | // no parent option, get the straight up value |
| 183 | if ( $network_option || is_network_admin() ) { |
| 184 | $value = get_site_option( $key, $default ); |
| 185 | } else { |
| 186 | $value = get_option( $key, $default ); |
| 187 | } |
| 188 | } else { |
| 189 | // there's a parent option |
| 190 | if ( $parent_option == Tribe__Main::OPTIONNAME ) { |
| 191 | // get the options from Tribe__Settings_Manager if we're getting the main array |
| 192 | $value = Tribe__Settings_Manager::get_option( $key, $default ); |
| 193 | } elseif ( $parent_option == Tribe__Main::OPTIONNAMENETWORK ) { |
| 194 | $value = Tribe__Settings_Manager::get_network_option( $key, $default ); |
| 195 | } else { |
| 196 | // else, get the parent option normally |
| 197 | if ( is_network_admin() ) { |
| 198 | $options = (array) get_site_option( $parent_option ); |
| 199 | } else { |
| 200 | $options = (array) get_option( $parent_option ); |
| 201 | } |
| 202 | $value = ( isset( $options[ $key ] ) ) ? $options[ $key ] : $default; |
| 203 | } |
| 204 | } |
| 205 | } |
| 206 | |
| 207 | // escape the value for display |
| 208 | if ( ! empty( $field['esc_display'] ) && function_exists( $field['esc_display'] ) ) { |
| 209 | $value = $field['esc_display']( $value ); |
| 210 | } elseif ( is_string( $value ) ) { |
| 211 | $value = esc_attr( stripslashes( $value ) ); |
| 212 | } |
| 213 | |
| 214 | // filter the value |
| 215 | $value = apply_filters( 'tribe_settings_get_option_value_pre_display', $value, $key, $field ); |
| 216 | |
| 217 | // create the field |
| 218 | new Tribe__Field( $key, $field, $value ); |
| 219 | } |
| 220 | } else { |
| 221 | // no fields setup for this tab yet |
| 222 | echo '<p>' . esc_html__( 'There are no fields setup for this tab yet.', 'tribe-common' ) . '</p>'; |
| 223 | } |
| 224 | } |
| 225 | |
| 226 | } // end class |
| 227 | } // endif class_exists |
| 228 |