` element with a `data-tab-type` attribute for identification.
*
* @param string $w3tc_key The configuration key used to retrieve tab settings.
* @param string $tab_type The type of tab to retrieve (e.g., 'tutorials', 'premium-services').
*
* @return string|null The HTML content for the specified tab, or null if the tab or key is not found.
*
* Usage:
* ```
* echo wp_kses_post( Util_Ui::get_tab('example_key', 'tutorials'); // Retrieves the tutorials tab for 'example_key'
* ```
*/
public static function get_tab( string $w3tc_key, string $tab_type ): ?string {
// If for any reason the key or tab type is empty, return an empty string.
if ( empty( $w3tc_key ) || empty( $tab_type ) ) {
return '';
}
require_once 'ConfigSettingsTabs.php';
$configs = Config_Tab_Settings::get_config( $w3tc_key );
// Define a mapping of tab types to the corresponding config keys.
$tab_mapping = array(
'help' => 'help',
'premium-services' => 'premium_support',
);
// Check if the provided tab type exists in the mapping and in the configs.
if ( isset( $tab_mapping[ $tab_type ] ) && isset( $configs['tabs'][ $tab_mapping[ $tab_type ] ] ) ) {
return '
' . $configs['tabs'][ $tab_mapping[ $tab_type ] ] . '
';
}
return null;
}
/**
* Config save button.
*
* @param string $id ID.
* @param string $extra Extra.
*
* @return void
*/
public static function button_config_save( $id = '', $extra = '' ) {
$b1_id = 'w3tc_save_options_' . $id;
$b2_id = 'w3tc_default_save_and_flush_' . $id;
$nonce_field = self::nonce_field( Util_Nonce::admin_action( 'w3tc_save_options' ) );
$nonce_html = wp_kses( $nonce_field, self::get_allowed_html_for_wp_kses_from_content( $nonce_field ) );
$extra_html = wp_kses( $extra, self::get_allowed_html_for_wp_kses_from_content( $extra ) );
?>
Toggle Dropdown
Toggle Dropdown
is_sealed( $w3tc_key ) ) {
echo 'disabled="disabled" ';
}
}
/**
* Returns nonce field HTML
*
* @param string|int $action Action.
* @param string $w3tc_name Name.
* @param bool $referer Referrer.
*
* @return string
*/
public static function nonce_field( $action = -1, $w3tc_name = '_wpnonce', $referer = true ) {
$return = '
';
if ( $referer ) {
$return .= wp_referer_field( false );
}
return $return;
}
/**
* HTML attribute carrying a per-handler admin nonce for submit buttons.
*
* @since 2.10.0
*
* @param string $action Dispatcher handler request key.
*
* @return string
*/
public static function admin_submit_nonce_attr( $action ) {
return ' data-w3tc-nonce="' . esc_attr( Util_Nonce::create_admin( $action ) ) . '"';
}
/**
* Returns an notification box
*
* @param string $w3tc_message Message.
* @param string $id Adds an id to the notification box.
* @param bool $dismissible Whether the notification box should be dismissible.
*
* @return string
*/
public static function get_notification_box( $w3tc_message, $id = '', $dismissible = false ) {
$page_val = Util_Request::get_string( 'page' );
if ( empty( $page_val ) || ( ! empty( $page_val ) && 'w3tc_' !== substr( $page_val, 0, 5 ) ) ) {
$logo = sprintf(
'
',
esc_url( plugins_url( '/pub/img/W3TC_dashboard_logo_title.png', W3TC_FILE ) ) . ''
);
} else {
$logo = '';
}
return sprintf(
'
%3$s
',
$id ? 'id="' . esc_attr( $id ) . '"' : '',
$dismissible ? 'is-dismissible' : '',
$logo . wp_kses( $w3tc_message, self::get_allowed_html_for_wp_kses_from_content( $w3tc_message ) )
);
}
/**
* Echos an notification box
*
* @param string $w3tc_message Message.
* @param string $id adds an id to the notification box.
* @param bool $dismissible Whether the notification box should be dismissible.
*
* @return void
*/
public static function e_notification_box( $w3tc_message, $id = '', $dismissible = false ) {
$notification_box = self::get_notification_box( $w3tc_message, $id, $dismissible );
echo wp_kses(
$notification_box,
self::get_allowed_html_for_wp_kses_from_content( $notification_box )
);
}
/**
* Echos an error box.
*
* @param string $w3tc_message Message.
* @param string $id Id.
* @param bool $dismissible Whether the notification box should be dismissible.
*
* @return void
*/
public static function error_box( $w3tc_message, $id = '', $dismissible = false ) {
$page_val = Util_Request::get_string( 'page' );
if ( empty( $page_val ) || ( ! empty( $page_val ) && 'w3tc_' !== substr( $page_val, 0, 5 ) ) ) {
$logo = sprintf(
'
',
esc_url( plugins_url( '/pub/img/W3TC_dashboard_logo_title.png', W3TC_FILE ) . '' )
);
} else {
$logo = '';
}
$v = sprintf(
'
%3$s
',
$id ? 'id="' . esc_attr( $id ) . '"' : '',
$dismissible ? 'is-dismissible' : '',
$logo . wp_kses( $w3tc_message, self::get_allowed_html_for_wp_kses_from_content( $w3tc_message ) )
);
echo wp_kses(
$v,
self::get_allowed_html_for_wp_kses_from_content( $v )
);
}
/**
* Format bytes into B, KB, MB, GB and TB
*
* phpcs:disable Squiz.PHP.CommentedOutCode.Found
*
* @param int $bytes Bytes.
* @param int $precision Precision.
*
* @return string
*/
public static function format_bytes( $bytes, $precision = 2 ) {
$units = array( 'B', 'KB', 'MB', 'GB', 'TB' );
$bytes = max( $bytes, 0 );
$pow = floor( ( $bytes ? log( $bytes ) : 0 ) / log( 1024 ) );
$pow = min( $pow, count( $units ) - 1 );
// Uncomment one of the following alternatives.
$bytes /= pow( 1024, $pow );
// $bytes /= ( 1 << ( 10 * $pow ) );
return round( $bytes, $precision ) . ' ' . $units[ $pow ];
}
/**
* Format mbytes into B, KB, MB, GB and TB
*
* phpcs:disable Squiz.PHP.CommentedOutCode.Found
*
* @param int $bytes Bytes.
* @param int $precision Precision.
*
* @return string
*/
public static function format_mbytes( $bytes, $precision = 2 ) {
$units = array( 'B', 'KB', 'MB', 'GB', 'TB' );
$bytes = max( $bytes, 0 );
$pow = floor( ( $bytes ? log( $bytes ) : 0 ) / log( 1024 ) );
$pow = min( $pow, count( $units ) - 1 );
// Uncomment one of the following alternatives.
$bytes /= pow( 1024, $pow );
// $bytes /= ( 1 << ( 10 * $pow ) );
return round( $bytes, $precision ) . ' ' . $units[ $pow + 2 ];
}
/**
* Returns an hidden input text element
*
* @param string $id ID.
* @param string $w3tc_name Name.
* @param string $w3tc_value Value.
*
* @return string
*/
public static function r_hidden( $id, $w3tc_name, $w3tc_value ) {
return '
';
}
/**
* Echos a hidden input text element
*
* @param string $id ID.
* @param string $w3tc_name Name.
* @param string $w3tc_value Value.
*
* @return void
*/
public static function hidden( $id, $w3tc_name, $w3tc_value ) {
$hidden = self::r_hidden( $id, $w3tc_name, $w3tc_value );
echo wp_kses(
$hidden,
self::get_allowed_html_for_wp_kses_from_content( $hidden )
);
}
/**
* Echos an label element
*
* @param string $id ID.
* @param string $text Text.
*
* @return void
*/
public static function label( $id, $text ) {
$w3tc_label = '
' . $text . ' ';
echo wp_kses(
$w3tc_label,
self::get_allowed_html_for_wp_kses_from_content( $w3tc_label )
);
}
/**
* Echos an input text element
*
* @param string $id ID.
* @param string $w3tc_name Name.
* @param string $w3tc_value Value.
* @param bool $w3tc_disabled Disabled.
* @param int $size Size.
* @param string $type Type.
* @param string $w3tc_placeholder Placeholder.
*
* @return void
*/
public static function textbox( $id, $w3tc_name, $w3tc_value, $w3tc_disabled = false, $size = 40, $type = 'text', $w3tc_placeholder = '' ) {
$w3tc_placeholder = ! empty( $w3tc_placeholder ) ? ' placeholder="' . esc_attr( $w3tc_placeholder ) . '"' : '';
echo '
';
}
/**
* Echos an input password element
*
* @param string $id ID.
* @param string $w3tc_name Name.
* @param string $w3tc_value Value.
* @param bool $w3tc_disabled Diabled.
* @param int $size Size.
*
* @return void
*/
public static function passwordbox( $id, $w3tc_name, $w3tc_value, $w3tc_disabled = false, $size = 40 ) {
echo '
';
}
/**
* Returns true when the given config key carries the
* `flags.secret => true` marker in `ConfigKeys.php`.
*
* Used by {@see self::control2()} to auto-mask textbox-rendered
* secret keys (e.g. `cdn.s3.key` routed through
* `Util_Ui::config_item()`), so a future credential field added to
* the schema is masked by being flagged — no template edit needed.
*
* @since 2.10.0
*
* @param string|array $w3tc_key Config key (compound keys are never
* secrets in the static schema).
*
* @return bool
*/
public static function is_secret_config_key( $w3tc_key ) {
if ( \is_array( $w3tc_key ) || ! \is_string( $w3tc_key ) || '' === $w3tc_key ) {
return false;
}
$secrets = Config::secret_keys();
return isset( $secrets[ $w3tc_key ] );
}
/**
* Renders an input for a credential-typed config value.
*
* Never reflects the actual secret into the HTML `value=` attribute.
* Instead:
*
* - `value=""` is always emitted (so a settings-page render — view-
* source, browser cache, screenshot, intermediary proxy — never
* yields the credential).
* - A `••••••••` placeholder is rendered when a secret is
* configured, so the admin can see that *something* is set
* without seeing the value. An empty config value renders an
* empty placeholder (the admin sees a blank input — same UX as
* "credential not set").
* - `autocomplete="new-password"` discourages browsers from
* auto-filling stored passwords into the wrong field.
* - When a secret is configured, a companion `Remove` checkbox is
* rendered alongside the input. Submitting that checkbox is the
* only way to wipe a stored credential through the UI — see
* `Generic_AdminActions_Default::read_request()` for the
* server-side counterpart. Without it, clearing the visible
* input and saving is a no-op (the empty-POST-preserves-secret
* rule, see below).
*
* The companion server-side rules live in
* `Generic_AdminActions_Default::read_request()`:
*
* 1. Empty POST for a `secret`-flagged key means "no change",
* not "blank it". This lets the placeholder pattern round-trip
* cleanly: the admin saves Settings without re-entering
* existing credentials.
* 2. A submitted companion `{name}__w3tc_clear=1` field forces
* the value to '' (and the downstream save hooks then fire,
* e.g. `Licensing_Plugin_Admin::possible_state_change()`
* deactivates the license against EDD).
*
* @since 2.10.0
*
* @param array $args {
* Field arguments.
*
* @type string $id DOM id.
* @type string $w3tc_name Submit name (e.g. `cdn__s3__secret`).
* @type bool $has_value Whether a secret is currently
* configured. When true the input
* renders a dot placeholder AND a
* companion `Remove` checkbox.
* @type int $size HTML size attribute. Default 60.
* @type string $type `password` (default) or `text`.
* @type string $sealing_key Pass a key prefix (e.g. `cdn.`) to
* disable the input when sealed by
* the master config.
* @type bool $extra_class Whether to also include the
* `w3tc-ignore-change` class
* (default true).
* }
*
* @return void
*/
public static function secret_input( $args ) {
$id = isset( $args['id'] ) ? (string) $args['id'] : '';
$w3tc_name = isset( $args['name'] ) ? (string) $args['name'] : '';
$has_value = ! empty( $args['has_value'] );
$size = isset( $args['size'] ) ? (int) $args['size'] : 60;
$type = isset( $args['type'] ) && 'text' === $args['type'] ? 'text' : 'password';
$sealing_key = isset( $args['sealing_key'] ) ? (string) $args['sealing_key'] : '';
$extra_class = ! isset( $args['extra_class'] ) || (bool) $args['extra_class'];
$w3tc_disabled = ! empty( $args['disabled'] );
$w3tc_placeholder = $has_value ? '••••••••' : '';
if ( ! $w3tc_disabled && '' !== $sealing_key && Dispatcher::config()->is_sealed( $sealing_key ) ) {
$w3tc_disabled = true;
}
echo '
';
/**
* Render the explicit-clear affordance only when a secret is
* configured AND the field is editable. There is nothing to
* remove from an empty field, and a sealed/disabled field has
* to be unsealed before its value can be changed at all.
*
* The companion name pattern is `{name}__w3tc_clear` so it
* never collides with a real ConfigKeys.php key (no schema
* entry ends in `clear`) and is trivially filtered out of the
* `$_REQUEST` iteration in `read_request()`.
*/
if ( $has_value && ! $w3tc_disabled ) {
$clear_id = $id . '__w3tc_clear';
echo '
'
. ' ';
}
}
/**
* Echoes a select element.
*
* @param string $id The ID attribute for the select element.
* @param string $w3tc_name The name attribute for the select element.
* @param string $w3tc_value The selected value.
* @param array $values An array of options, where the key is the option value and the value is the label.
* @param bool $w3tc_disabled Whether the select element should be disabled. Default false.
* @param array $optgroups {
* Optional. An associative array of optgroup labels.
*
* @type int|string $w3tc_key The optgroup identifier.
* @type string $w3tc_label The label for the optgroup.
* }
*
* @return void
*/
public static function selectbox( $id, $w3tc_name, $w3tc_value, $values, $w3tc_disabled = false, $optgroups = null ) {
echo '
\n";
if ( ! is_array( $optgroups ) ) {
// simle control.
foreach ( $values as $w3tc_key => $w3tc_descriptor ) {
self::option( $w3tc_key, $w3tc_value, $w3tc_descriptor );
}
} else {
// with optgroups.
$current_optgroup = -1;
foreach ( $values as $w3tc_key => $w3tc_descriptor ) {
$optgroup = ( isset( $w3tc_descriptor['optgroup'] ) ? $w3tc_descriptor['optgroup'] : -1 );
if ( $optgroup !== $current_optgroup ) {
if ( -1 !== $current_optgroup ) {
echo '';
}
echo '' . "\n";
$current_optgroup = $optgroup;
}
self::option( $w3tc_key, $w3tc_value, $w3tc_descriptor );
}
if ( -1 !== $current_optgroup ) {
echo ' ';
}
}
echo ' ';
}
/**
* Echos a select option
*
* @param string $w3tc_key Key.
* @param string $selected_value Name.
* @param string $w3tc_descriptor Descriptor.
*
* @return void
*/
private static function option( $w3tc_key, $selected_value, $w3tc_descriptor ) {
if ( ! is_array( $w3tc_descriptor ) ) {
$w3tc_label = $w3tc_descriptor;
$w3tc_disabled = false;
} else {
$w3tc_label = $w3tc_descriptor['label'];
$w3tc_disabled = ! empty( $w3tc_descriptor['disabled'] );
}
echo '
' .
wp_kses( $w3tc_label, self::get_allowed_html_for_wp_kses_from_content( $w3tc_label ) ) . ' ' . "\n";
}
/**
* Echos a group of radio elements values: value => label pair or value => array(label, disabled, postfix).
*
* @param string $w3tc_name Name.
* @param string $w3tc_value Value.
* @param array $values {
* Values.
*
* @type string $w3tc_label Label for the radio button.
* @type bool $w3tc_disabled Whether the radio button is disabled.
* @type string $postfix Postfix to be appended to the label.
* @type bool $pro_feature Whether the radio button is a pro feature.
* @type string $pro_excerpt Excerpt for pro feature description.
* @type string $pro_description Full description for the pro feature.
* @type string $intro_label Intro label for pro feature.
* @type string $score Score associated with the pro feature.
* @type string $score_label Label for the score.
* @type string $score_description Description for the score.
* @type string $score_link Link related to the score.
* @type bool $show_learn_more Whether to show the "learn more" option for the pro feature.
* }
* @param bool $w3tc_disabled Disabled flag for all radio buttons.
* @param string $separator Separator to be used between radio buttons.
*
* @return void
*/
public static function radiogroup( $w3tc_name, $w3tc_value, $values, $w3tc_disabled = false, $separator = '' ) {
$w3tc_c = Dispatcher::config();
$w3tc_is_pro = Util_Environment::is_w3tc_pro( $w3tc_c );
$w3tc_first = true;
foreach ( $values as $w3tc_key => $label_or_array ) {
if ( $w3tc_first ) {
$w3tc_first = false;
} else {
echo wp_kses(
$separator,
self::get_allowed_html_for_wp_kses_from_content( $separator )
);
}
$w3tc_label = '';
$item_disabled = false;
$postfix = '';
$pro_feature = false;
if ( ! is_array( $label_or_array ) ) {
$w3tc_label = $label_or_array;
} else {
$w3tc_label = $label_or_array['label'];
$item_disabled = $label_or_array['disabled'];
$postfix = isset( $label_or_array['postfix'] ) ? $label_or_array['postfix'] : '';
$pro_feature = isset( $label_or_array['pro_feature'] ) ? $label_or_array['pro_feature'] : false;
}
if ( $pro_feature ) {
self::pro_wrap_maybe_start();
}
echo '
' .
wp_kses( $postfix, self::get_allowed_html_for_wp_kses_from_content( $postfix ) ) . "\n";
if ( $pro_feature ) {
self::pro_wrap_description(
$label_or_array['pro_excerpt'],
$label_or_array['pro_description'],
$w3tc_name . '__' . $w3tc_key
);
if ( ! $w3tc_is_pro && isset( $label_or_array['intro_label'] ) && isset( $label_or_array['score'] ) && isset( $label_or_array['score_label'] ) && isset( $label_or_array['score_description'] ) && isset( $label_or_array['score_link'] ) ) {
$score_block = self::get_score_block( $label_or_array['intro_label'], $label_or_array['score'], $label_or_array['score_label'], $label_or_array['score_description'], $label_or_array['score_link'] );
echo wp_kses( $score_block, self::get_allowed_html_for_wp_kses_from_content( $score_block ) );
}
$show_learn_more = isset( $label_or_array['show_learn_more'] ) && is_bool( $label_or_array['show_learn_more'] ) ? $label_or_array['show_learn_more'] : true;
self::pro_wrap_maybe_end( $w3tc_name . '__' . $w3tc_key, $show_learn_more );
}
}
}
/**
* Echos an input text element
*
* @param string $id ID.
* @param string $w3tc_name Name.
* @param string $w3tc_value Value.
* @param bool $w3tc_disabled Disabled.
*
* @return void
*/
public static function textarea( $id, $w3tc_name, $w3tc_value, $w3tc_disabled = false ) {
// The "textarea" element must not have padding around the value.
?>
';
}
echo '
' . "\n";
echo '
';
if ( ! is_null( $w3tc_label ) ) {
echo wp_kses( $w3tc_label, self::get_allowed_html_for_wp_kses_from_content( $w3tc_label ) ) . '';
}
}
/**
* Echos an element
*
* @param string $type Type.
* @param string $id ID.
* @param string $w3tc_name Name.
* @param mixed $w3tc_value Value.
* @param bool $w3tc_disabled Disabled.
*
* @return void
*/
public static function element( $type, $id, $w3tc_name, $w3tc_value, $w3tc_disabled = false ) {
switch ( $type ) {
case 'textbox':
self::textbox( $id, $w3tc_name, $w3tc_value, $w3tc_disabled );
break;
case 'password':
self::passwordbox( $id, $w3tc_name, $w3tc_value, $w3tc_disabled );
break;
case 'textarea':
self::textarea( $id, $w3tc_name, $w3tc_value, $w3tc_disabled );
break;
case 'checkbox':
default:
self::checkbox( $id, $w3tc_name, $w3tc_value, $w3tc_disabled );
break;
}
}
/**
* Checkbox
*
* @param array $e {
* Config.
*
* @type string $w3tc_name The name of the checkbox.
* @type mixed $w3tc_value The value of the checkbox.
* @type bool $w3tc_disabled Optional. Whether the checkbox is disabled. Defaults to false.
* @type string $w3tc_label Optional. The label for the checkbox. Defaults to null.
* }
*
* @return void
*/
public static function checkbox2( $e ) {
self::checkbox(
$e['name'],
$e['name'],
$e['value'],
( isset( $e['disabled'] ) ? $e['disabled'] : false ),
( isset( $e['label'] ) ? $e['label'] : null )
);
}
/**
* Radio
*
* @param array $e {
* Config.
*
* @type string $w3tc_name The name of the radio group.
* @type mixed $w3tc_value The selected value.
* @type array $values Array of radio button options.
* @type bool $w3tc_disabled Whether the radio group is disabled.
* @type string $separator The separator between radio buttons.
* }
*
* @return void
*/
public static function radiogroup2( $e ) {
self::radiogroup(
$e['name'],
$e['value'],
$e['values'],
$e['disabled'],
$e['separator']
);
}
/**
* Select
*
* @param array $e {
* Config.
*
* @type string $w3tc_name The name of the select element.
* @type mixed $w3tc_value The selected value.
* @type array $values The available options.
* @type bool $w3tc_disabled Optional. Whether the select should be disabled. Default false.
* @type array|null $optgroups Optional. The optgroups for grouping options. Default null.
* }
*
* @return void
*/
public static function selectbox2( $e ) {
self::selectbox(
$e['name'],
$e['name'],
$e['value'],
$e['values'],
( isset( $e['disabled'] ) ? $e['disabled'] : false ),
( isset( $e['optgroups'] ) ? $e['optgroups'] : null )
);
}
/**
* Textbox
*
* @param array $e {
* Config.
*
* @type string $w3tc_name Name of the textbox.
* @type string $w3tc_value Value of the textbox.
* @type bool $w3tc_disabled Whether the textbox is disabled. Default is false.
* @type int $size Size of the textbox. Default is 20.
* @type string $type Type of the textbox. Default is 'text'.
* @type string $w3tc_placeholder Placeholder text for the textbox. Default is an empty string.
* }
*
* @return void
*/
public static function textbox2( $e ) {
self::textbox(
$e['name'],
$e['name'],
$e['value'],
( isset( $e['disabled'] ) ? $e['disabled'] : false ),
( ! empty( $e['size'] ) ? $e['size'] : 20 ),
( ! empty( $e['type'] ) ? $e['type'] : 'text' ),
( ! empty( $e['placeholder'] ) ? $e['placeholder'] : '' )
);
}
/**
* Textarea
*
* @param array $e {
* Config.
*
* @type string $w3tc_name Name of the textarea.
* @type string $w3tc_value Value of the textarea.
* @type bool $w3tc_disabled Whether the textarea is disabled. Default is false.
* }
*
* @return void
*/
public static function textarea2( $e ) {
self::textarea(
$e['name'],
$e['name'],
$e['value'],
( isset( $e['disabled'] ) ? $e['disabled'] : false )
);
}
/**
* Control various types of input elements based on configuration.
*
* Handles rendering of different input controls (checkbox, radiogroup, selectbox, textbox, textarea, none, and button)
* based on the configuration provided in the input array.
*
* @param array $w3tc_a {
* Configuration for the control.
*
* @type string $control The type of control to render. Possible values are 'checkbox', 'radiogroup', 'selectbox', 'textbox', 'textarea', 'none', 'button'.
* @type string $control_name The name of the control.
* @type mixed $w3tc_value The value of the control.
* @type bool $w3tc_disabled Whether the control is disabled.
* @type string $checkbox_label The label for the checkbox (if applicable).
* @type array $radiogroup_values The values for the radiogroup (if applicable).
* @type string $radiogroup_separator The separator for the radiogroup (if applicable).
* @type array $selectbox_values The values for the selectbox (if applicable).
* @type mixed $selectbox_optgroups The optgroups for the selectbox (if applicable).
* @type string $textbox_type The type of the textbox (if applicable).
* @type int $textbox_size The size of the textbox (if applicable).
* @type string $textbox_placeholder The placeholder text for the textbox (if applicable).
* @type string $none_label The label for 'none' or 'button' controls.
* }
*
* @return void
*/
public static function control2( $w3tc_a ) {
if ( 'checkbox' === $w3tc_a['control'] ) {
self::checkbox2(
array(
'name' => $w3tc_a['control_name'],
'value' => $w3tc_a['value'],
'disabled' => $w3tc_a['disabled'],
'label' => $w3tc_a['checkbox_label'],
)
);
} elseif ( 'radiogroup' === $w3tc_a['control'] ) {
self::radiogroup2(
array(
'name' => $w3tc_a['control_name'],
'value' => $w3tc_a['value'],
'disabled' => $w3tc_a['disabled'],
'values' => $w3tc_a['radiogroup_values'],
'separator' => isset( $w3tc_a['radiogroup_separator'] ) ? $w3tc_a['radiogroup_separator'] : '',
)
);
} elseif ( 'selectbox' === $w3tc_a['control'] ) {
self::selectbox2(
array(
'name' => $w3tc_a['control_name'],
'value' => $w3tc_a['value'],
'disabled' => $w3tc_a['disabled'],
'values' => $w3tc_a['selectbox_values'],
'optgroups' => isset( $w3tc_a['selectbox_optgroups'] ) ? $w3tc_a['selectbox_optgroups'] : null,
)
);
} elseif ( 'textbox' === $w3tc_a['control'] ) {
// Secret-flagged keys (CDN API secrets, FTP passwords, license
// key, etc.) must NEVER reflect their value into the HTML
// `value=` attribute. Route through the placeholder renderer
// so the form pattern stays consistent with the inputs that
// already migrated to `Util_Ui::secret_input()` directly.
if ( self::is_secret_config_key( $w3tc_a['key'] ?? '' ) ) {
// Carry through the caller-supplied id so the surrounding
// `
` (which uses `control_name` as the
// for-target) keeps its click/focus association. Honor
// `textbox_type` when the caller passed one — some
// "credentials" render as text by design (e.g. an Access
// Key ID, where the operator wants to see what they
// typed) — but default to `password` so unspecified
// secret fields don't reflect on-screen.
$secret_type = ( isset( $w3tc_a['textbox_type'] ) && 'text' === $w3tc_a['textbox_type'] )
? 'text'
: 'password';
self::secret_input(
array(
'id' => $w3tc_a['control_name'],
'name' => $w3tc_a['control_name'],
'has_value' => '' !== (string) ( $w3tc_a['value'] ?? '' ),
'disabled' => $w3tc_a['disabled'],
'type' => $secret_type,
'size' => isset( $w3tc_a['textbox_size'] ) ? (int) $w3tc_a['textbox_size'] : 60,
)
);
} else {
self::textbox2(
array(
'name' => $w3tc_a['control_name'],
'value' => $w3tc_a['value'],
'disabled' => $w3tc_a['disabled'],
'type' => isset( $w3tc_a['textbox_type'] ) ? $w3tc_a['textbox_type'] : null,
'size' => isset( $w3tc_a['textbox_size'] ) ? $w3tc_a['textbox_size'] : null,
'placeholder' => isset( $w3tc_a['textbox_placeholder'] ) ? $w3tc_a['textbox_placeholder'] : null,
)
);
}
} elseif ( 'textarea' === $w3tc_a['control'] ) {
self::textarea2(
array(
'name' => $w3tc_a['control_name'],
'value' => $w3tc_a['value'],
'disabled' => $w3tc_a['disabled'],
)
);
} elseif ( 'none' === $w3tc_a['control'] ) {
echo wp_kses( $w3tc_a['none_label'], self::get_allowed_html_for_wp_kses_from_content( $w3tc_a['none_label'] ) );
} elseif ( 'button' === $w3tc_a['control'] ) {
echo '' . wp_kses( $w3tc_a['none_label'], self::get_allowed_html_for_wp_kses_from_content( $w3tc_a['none_label'] ) ) . ' ';
}
}
/**
* Get table classes for tables including pro features.
*
* When on the free version, tables with pro features have additional classes added to help highlight
* the premium feature. If the user is on pro, this class is omitted.
*
* @since 0.14.3
*
* @return string
*/
public static function table_class() {
$table_class[] = 'form-table';
if ( ! Util_Environment::is_w3tc_pro( Dispatcher::config() ) ) {
$table_class[] = 'w3tc-pro-feature';
}
return implode( ' ', $table_class );
}
/**
* Renders element with controls.
*
* Renders a table row with various controls, such as checkboxes, select boxes, textboxes, etc.
* The control type is determined by the keys in the `$w3tc_a` array.
*
* @param array $w3tc_a {
* Configuration options for rendering the controls.
*
* @type string $id The ID for the control.
* @type string $w3tc_label The label for the control.
* @type string $label_class The class to apply to the label.
* @type string $style The style of the table row. Default is 'label', alternative is 'one-column'.
* @type array $checkbox The configuration for a checkbox control.
* @type string $description The description to display below the control.
* @type array $hidden The configuration for hidden inputs.
* @type string $html Raw HTML to insert.
* @type array $radiogroup The configuration for a radio group.
* @type array $selectbox The configuration for a select box.
* @type array $textbox The configuration for a textbox.
* @type array $textarea The configuration for a textarea.
* }
*
* @return void
*/
public static function table_tr( $w3tc_a ) {
$id = isset( $w3tc_a['id'] ) ? $w3tc_a['id'] : '';
$w3tc_a = apply_filters( 'w3tc_ui_settings_item', $w3tc_a );
echo ' ';
if ( isset( $w3tc_a['label'] ) ) {
self::label( $id, $w3tc_a['label'] );
}
echo "\n\n";
foreach ( $w3tc_a as $w3tc_key => $e ) {
if ( 'checkbox' === $w3tc_key ) {
self::checkbox(
$id,
isset( $e['name'] ) ? $e['name'] : null,
$e['value'],
( isset( $e['disabled'] ) ? $e['disabled'] : false ),
( isset( $e['label'] ) ? $e['label'] : null )
);
} elseif ( 'description' === $w3tc_key ) {
echo '' . wp_kses( $e, self::get_allowed_html_for_wp_kses_from_content( $e ) ) . '
';
} elseif ( 'hidden' === $w3tc_key ) {
self::hidden( '', $e['name'], $e['value'] );
} elseif ( 'html' === $w3tc_key ) {
echo wp_kses( $e, self::get_allowed_html_for_wp_kses_from_content( $e ) );
} elseif ( 'radiogroup' === $w3tc_key ) {
self::radiogroup(
$e['name'],
$e['value'],
$e['values'],
$e['disabled'],
$e['separator']
);
} elseif ( 'selectbox' === $w3tc_key ) {
self::selectbox(
$id,
$e['name'],
$e['value'],
$e['values'],
( isset( $e['disabled'] ) ? $e['disabled'] : false ),
( isset( $e['optgroups'] ) ? $e['optgroups'] : null )
);
} elseif ( 'textbox' === $w3tc_key ) {
self::textbox(
$id,
$e['name'],
$e['value'],
( isset( $e['disabled'] ) ? $e['disabled'] : false ),
( ! empty( $e['size'] ) ? $e['size'] : 20 ),
( ! empty( $e['type'] ) ? $e['type'] : 'text' ),
( ! empty( $e['placeholder'] ) ? $e['placeholder'] : '' )
);
} elseif ( 'textarea' === $w3tc_key ) {
self::textarea(
$id,
$e['name'],
$e['value'],
( isset( $e['disabled'] ) ? $e['disabled'] : false )
);
}
}
echo " ';
} else {
echo ' ';
if ( ! empty( $w3tc_a['label'] ) ) {
self::label( $w3tc_a['control_name'], $w3tc_a['label'] );
}
echo " \n\n";
}
self::control2( $w3tc_a );
if ( isset( $w3tc_a['control_after'] ) ) {
echo wp_kses(
$w3tc_a['control_after'],
self::get_allowed_html_for_wp_kses_from_content( $w3tc_a['control_after'] )
);
}
if ( isset( $w3tc_a['description'] ) ) {
echo wp_kses(
sprintf(
'%1$s%2$s%3$s',
'',
$w3tc_a['description'],
'
'
),
array(
'a' => array(
'href' => array(),
'title' => array(),
'target' => array(),
'rel' => array(),
),
'span' => array(
'class' => array(),
),
'p' => array(
'class' => array(),
),
'acronym' => array(
'title' => array(),
),
)
);
}
if ( $is_w3tc_free && isset( $w3tc_a['intro_label'] ) && isset( $w3tc_a['score'] ) && isset( $w3tc_a['score_label'] ) && isset( $w3tc_a['score_description'] ) && isset( $w3tc_a['score_link'] ) ) {
$score_block = self::get_score_block( $w3tc_a['score'], $w3tc_a['score_label'], $w3tc_a['score_description'], $w3tc_a['score_link'] );
echo wp_kses( $score_block, self::get_allowed_html_for_wp_kses_from_content( $score_block ) );
}
echo ( isset( $w3tc_a['style'] ) ? '' : ' ' );
echo "';
} else {
echo ' ';
if ( ! empty( $w3tc_a['label'] ) ) {
self::label( $w3tc_a['control_name'], $w3tc_a['label'] );
}
echo " \n\n";
}
if ( isset( $w3tc_a['pro'] ) ) {
self::pro_wrap_maybe_start();
}
self::checkbox2(
array(
'name' => 'extension__' . self::config_key_to_http_name( $w3tc_a['extension_id'] ),
'value' => $w3tc_c->is_extension_active_frontend( $w3tc_a['extension_id'] ),
'label' => $w3tc_a['checkbox_label'],
'disabled' => isset( $w3tc_a['disabled'] ) ? $w3tc_a['disabled'] : false,
)
);
if ( isset( $w3tc_a['description'] ) ) {
echo '' . wp_kses( $w3tc_a['description'], self::get_allowed_html_for_wp_kses_from_content( $w3tc_a['description'] ) ) . '
';
}
if ( ! $w3tc_is_pro && isset( $w3tc_a['intro_label'] ) && isset( $w3tc_a['score'] ) && isset( $w3tc_a['score_label'] ) && isset( $w3tc_a['score_description'] ) && isset( $w3tc_a['score_link'] ) ) {
$score_block = self::get_score_block( $w3tc_a['intro_label'], $w3tc_a['score'], $w3tc_a['score_label'], $w3tc_a['score_description'], $w3tc_a['score_link'] );
echo wp_kses( $score_block, self::get_allowed_html_for_wp_kses_from_content( $score_block ) );
}
if ( isset( $w3tc_a['pro'] ) ) {
$show_learn_more = isset( $w3tc_a['show_learn_more'] ) && is_bool( $w3tc_a['show_learn_more'] ) ? $w3tc_a['show_learn_more'] : true;
self::pro_wrap_maybe_end( 'extension__' . self::config_key_to_http_name( $w3tc_a['extension_id'] ), $show_learn_more );
}
echo ( isset( $w3tc_a['style'] ) ? '' : ' ' );
echo "';
} elseif ( 'w3tc_no_trtd' !== $w3tc_a['label_class'] ) {
echo ' ';
if ( ! empty( $w3tc_a['label'] ) ) {
self::label( $w3tc_a['control_name'], $w3tc_a['label'] );
}
echo " \n\n";
}
// If wrap_separate is not set we wrap everything.
if ( ! isset( $w3tc_a['wrap_separate'] ) && ! isset( $w3tc_a['no_wrap'] ) ) {
self::pro_wrap_maybe_start();
}
self::control2( $w3tc_a );
if ( isset( $w3tc_a['control_after'] ) ) {
echo wp_kses( $w3tc_a['control_after'], self::get_allowed_html_for_wp_kses_from_content( $w3tc_a['control_after'] ) );
}
// If wrap_separate is set we wrap only the description.
if ( isset( $w3tc_a['wrap_separate'] ) && ! isset( $w3tc_a['no_wrap'] ) ) {
// If not pro we add a spacer for better separation of control element and wrapper.
if ( ! $w3tc_is_pro ) {
echo ' ' );
echo "
★ PRO
' . wp_kses( $excerpt_clean, self::get_allowed_html_for_wp_kses_from_content( $excerpt_clean ) ) . '';
if ( ! empty( $description ) ) {
$d = array_map(
function ( $e ) {
return '
' . wp_kses( $e, self::get_allowed_html_for_wp_kses_from_content( $e ) ) . '
';
},
$description
);
$descriptions = implode( "\n", $d );
echo '
' . wp_kses( $descriptions, self::get_allowed_html_for_wp_kses_from_content( $descriptions ) ) . '
';
echo '
' . esc_html( __( 'Show More', 'w3-total-cache' ) ) . ' ';
}
}
/**
* Pro wrap end
*
* @param string $button_data_src Butta href.
* @param bool $show_learn_more Show more flag.
*
* @return void
*/
public static function pro_wrap_maybe_end( $button_data_src, $show_learn_more = true ) {
if ( Util_Environment::is_w3tc_pro( Dispatcher::config() ) ) {
return;
}
?>
Learn more about Pro
is_master() ) {
return;
}
if ( $w3tc_c->get_boolean( $w3tc_a['key'] ) ) {
$w3tc_name = 'w3tc_config_overloaded_disable~' . self::config_key_to_http_name( $w3tc_a['key'] );
$w3tc_value = __( 'Use common settings', 'w3-total-cache' );
} else {
$w3tc_name = 'w3tc_config_overloaded_enable~' . self::config_key_to_http_name( $w3tc_a['key'] );
$w3tc_value = __( 'Use specific settings', 'w3-total-cache' );
}
echo '';
echo '
';
}
/**
* Get the admin URL based on the path and the interface (network or site).
*
* @param string $path Admin path/URI.
*
* @return string
*/
public static function admin_url( $path ) {
return is_network_admin() ? network_admin_url( $path ) : admin_url( $path );
}
/**
* Returns a preview link with current state
*
* @return string
*/
public static function preview_link() {
return self::button_link(
__( 'Preview', 'w3-total-cache' ),
self::url( array( 'w3tc_default_previewing' => 'y' ) ),
true
);
}
/**
* Takes seconds and converts to array('Nh ','Nm ', 'Ns ', 'Nms ') or "Nh Nm Ns Nms"
*
* @param unknown $input Input.
* @param bool $string_value String.
*
* @return array|string
*/
public static function secs_to_time( $input, $string_value = true ) {
$input = (float) $input;
$time = array();
$msecs = floor( $input * 1000 % 1000 );
$seconds = $input % 60;
$minutes = floor( $input / 60 ) % 60;
$hours = floor( $input / 60 / 60 ) % 60;
if ( $hours ) {
$time[] = $hours;
}
if ( $minutes ) {
$time[] = sprintf( '%dm', $minutes );
}
if ( $seconds ) {
$time[] = sprintf( '%ds', $seconds );
}
if ( $msecs ) {
$time[] = sprintf( '%dms', $msecs );
}
if ( empty( $time ) ) {
$time[] = sprintf( '%dms', 0 );
}
if ( $string_value ) {
return implode( ' ', $time );
}
return $time;
}
/**
* Returns option name accepted by W3TC as http paramter from its id (full name from config file).
*
* @param mixed $id ID key string/array.
*
* @return string
*/
public static function config_key_to_http_name( $id ) {
$id = isset( $id ) ? $id : '';
if ( is_array( $id ) ) {
$id = $id[0] . '___' . $id[1];
}
return str_replace( '.', '__', $id );
}
/**
* Converts configuration key returned in http _GET/_POST to configuration key
*
* @param string $http_key HTTP key.
*
* @return string
*/
public static function config_key_from_http_name( $http_key ) {
$w3tc_a = explode( '___', $http_key );
if ( count( $w3tc_a ) === 2 ) {
$w3tc_a[0] = self::config_key_from_http_name( $w3tc_a[0] );
$w3tc_a[1] = self::config_key_from_http_name( $w3tc_a[1] );
return $w3tc_a;
}
return str_replace( '__', '.', $http_key );
}
/**
* Get allowed HTML fro wpkses
*
* phpcs:disable WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
*
* @param string $content Content.
*
* @return array
*/
public static function get_allowed_html_for_wp_kses_from_content( $content ) {
$allowed_html = array();
if ( empty( $content ) ) {
return $allowed_html;
}
$dom = new DOMDocument();
@$dom->loadHTML( $content );
foreach ( $dom->getElementsByTagName( '*' ) as $tag ) {
$tagname = $tag->tagName;
foreach ( $tag->attributes as $attribute_name => $attribute_val ) {
$allowed_html[ $tagname ][ $attribute_name ] = array();
}
$allowed_html[ $tagname ] = empty( $allowed_html[ $tagname ] ) ? array() : $allowed_html[ $tagname ];
}
return $allowed_html;
}
/**
* Prints breadcrumb
*
* @return void
*/
public static function print_breadcrumb() {
$page = ! empty( Util_Admin::get_current_extension() ) ? Util_Admin::get_current_extension() : Util_Admin::get_current_page();
$page_mapping = Util_PageUrls::get_page_mapping( $page );
$parent = isset( $page_mapping['parent_name'] ) ?
'' . esc_html( $page_mapping['parent_name'] ) . ' ' : '';
$current = isset( $page_mapping['page_name'] ) ?
'' . esc_html( $page_mapping['page_name'] ) . ' ' : '';
?>
W3 Total Cache
get_string( 'cdn.engine' ) || 'bunnycdn' === $w3tc_config->get_string( 'cdnfsd.engine' );
$licensing_visible = (
( ! Util_Environment::is_wpmu() || is_network_admin() ) &&
! ini_get( 'w3tc.license_key' ) &&
'host_valid' !== $state->get_string( 'license.status' )
);
switch ( $page ) {
case 'w3tc_general':
if ( ! empty( $_REQUEST['view'] ) ) {
break;
}
$message_bus_link = array();
if ( Util_Environment::is_w3tc_pro( $w3tc_config ) ) {
$message_bus_link = array(
array(
'id' => 'amazon_sns',
'text' => esc_html__( 'Message Bus', 'w3-total-cache' ),
),
);
}
$licensing_link = array();
if ( $licensing_visible ) {
$licensing_link = array(
array(
'id' => 'licensing',
'text' => esc_html__( 'Licensing', 'w3-total-cache' ),
),
);
}
$w3tc_links = array_merge(
array(
array(
'id' => 'general',
'text' => esc_html__( 'General', 'w3-total-cache' ),
),
array(
'id' => 'page_cache',
'text' => esc_html__( 'Page Cache', 'w3-total-cache' ),
),
array(
'id' => 'minify',
'text' => esc_html__( 'Minify', 'w3-total-cache' ),
),
array(
'id' => 'system_opcache',
'text' => esc_html__( 'Opcode Cache', 'w3-total-cache' ),
),
array(
'id' => 'database_cache',
'text' => esc_html__( 'Database Cache', 'w3-total-cache' ),
),
array(
'id' => 'object_cache',
'text' => esc_html__( 'Object Cache', 'w3-total-cache' ),
),
array(
'id' => 'browser_cache',
'text' => esc_html__( 'Browser Cache', 'w3-total-cache' ),
),
array(
'id' => 'allcache_wp_cron',
'text' => esc_html__( 'Purge via WP Cron', 'w3-total-cache' ),
),
array(
'id' => 'cdn',
'text' => wp_kses(
sprintf(
// translators: 1 opening HTML abbr tag, 2 closing HTML abbr tag.
__(
'%1$sCDN%2$s',
'w3-total-cache'
),
'',
' '
),
array(
'abbr' => array(
'title' => array(),
),
)
),
),
array(
'id' => 'reverse_proxy',
'text' => esc_html__( 'Reverse Proxy', 'w3-total-cache' ),
),
),
$message_bus_link,
$custom_areas,
$licensing_link,
array(
array(
'id' => 'miscellaneous',
'text' => esc_html__( 'Miscellaneous', 'w3-total-cache' ),
),
array(
'id' => 'debug',
'text' => esc_html__( 'Debug', 'w3-total-cache' ),
),
array(
'id' => 'image_service',
'text' => esc_html__( 'Image Converter', 'w3-total-cache' ),
),
array(
'id' => 'google_pagespeed',
'text' => __( 'Google PageSpeed', 'w3-total-cache' ),
),
array(
'id' => 'settings',
'text' => esc_html__( 'Import / Export Settings', 'w3-total-cache' ),
),
)
);
$links_buff = array();
foreach ( $w3tc_links as $link ) {
$links_buff[] = "{$link['text']} ";
}
?>
' . $score . ' ' . esc_html( $intro_label ) . '