270 lines
7.9 KiB
PHP
270 lines
7.9 KiB
PHP
<?php
|
|
/**
|
|
* File: Util_Widget.php
|
|
*
|
|
* @package W3TC
|
|
*
|
|
* phpcs:disable Generic.Files.OneObjectStructurePerFile
|
|
*/
|
|
|
|
namespace W3TC;
|
|
|
|
/**
|
|
* Class: Util_Widget
|
|
*/
|
|
class Util_Widget {
|
|
/**
|
|
* Dashboard widgets.
|
|
*
|
|
* @var array
|
|
* @static
|
|
*/
|
|
public static $w3tc_dashboard_widgets = array();
|
|
|
|
/**
|
|
* Registers dashboard widgets.
|
|
*
|
|
* Handles POST data, sets up filters.
|
|
*
|
|
* @since 0.9.2.6
|
|
* @static
|
|
*/
|
|
public static function setup() {
|
|
global $w3tc_registered_widgets, $w3tc_registered_widget_controls, $w3tc_dashboard_control_callbacks;
|
|
|
|
$w3tc_dashboard_control_callbacks = array();
|
|
$screen = get_current_screen();
|
|
$update = false;
|
|
$widget_options = get_option( 'w3tc_dashboard_widget_options' );
|
|
|
|
if ( ! $widget_options || ! is_array( $widget_options ) ) {
|
|
$widget_options = array();
|
|
}
|
|
|
|
// Hook to register new widgets. Filter widget order.
|
|
if ( is_network_admin() ) {
|
|
do_action( 'w3tc_network_dashboard_setup' );
|
|
$dashboard_widgets = apply_filters( 'w3tc_network_dashboard_widgets', array() );
|
|
} else {
|
|
do_action( 'w3tc_widget_setup' );
|
|
$dashboard_widgets = apply_filters( 'w3tc_dashboard_widgets', array() );
|
|
}
|
|
|
|
foreach ( $dashboard_widgets as $widget_id ) {
|
|
$name = empty( $w3tc_registered_widgets[ $widget_id ]['all_link'] ) ? $w3tc_registered_widgets[ $widget_id ]['name'] : $w3tc_registered_widgets[ $widget_id ]['name'] . " <a href='{$w3tc_registered_widgets[$widget_id]['all_link']}' class='edit-box open-box'>" . __( 'View all', 'w3-total-cache' ) . '</a>';
|
|
self::add( $widget_id, $name, $w3tc_registered_widgets[ $widget_id ]['callback'], $w3tc_registered_widget_controls[ $widget_id ]['callback'] );
|
|
}
|
|
|
|
if ( 'POST' === isset( $_SERVER['REQUEST_METHOD'] ) ? sanitize_text_field( wp_unslash( $_SERVER['REQUEST_METHOD'] ) ) : '' && ! empty( Util_Request::get_string( 'widget_id' ) ) ) {
|
|
check_admin_referer( 'edit-dashboard-widget_' . Util_Request::get_string( 'widget_id' ), 'dashboard-widget-nonce' );
|
|
ob_start(); // The same hack "wp-admin/widgets.php" uses.
|
|
self::trigger_widget_control( Util_Request::get_string( 'widget_id' ) );
|
|
ob_end_clean();
|
|
}
|
|
|
|
if ( $update ) {
|
|
update_option( 'w3tc_dashboard_widget_options', $widget_options );
|
|
}
|
|
|
|
do_action( 'do_meta_boxes', $screen->id, 'normal', '' );
|
|
do_action( 'do_meta_boxes', $screen->id, 'side', '' );
|
|
}
|
|
|
|
/**
|
|
* Add 2.
|
|
*
|
|
* @static
|
|
*
|
|
* @param string $widget_id Widget id.
|
|
* @param int $priority Prioroty.
|
|
* @param string $widget_name Widget name.
|
|
* @param callable $callback Callback.
|
|
* @param callable $control_callback Control callback.
|
|
* @param string $location Location.
|
|
* @param string $header_text Header text.
|
|
* @param string $header_class Header class.
|
|
*/
|
|
public static function add2( $widget_id, $priority, $widget_name, $callback,
|
|
$control_callback = null, $location = 'normal', $header_text = null,
|
|
$header_class = '' ) {
|
|
$o = new _Util_Widget_Postponed(
|
|
array(
|
|
'widget_id' => $widget_id,
|
|
'widget_name' => $widget_name,
|
|
'callback' => $callback,
|
|
'control_callback' => $control_callback,
|
|
'location' => $location,
|
|
'header_text' => $header_text,
|
|
'header_class' => $header_class,
|
|
)
|
|
);
|
|
|
|
add_action(
|
|
'w3tc_widget_setup',
|
|
array( $o, 'wp_dashboard_setup' ),
|
|
$priority
|
|
);
|
|
|
|
add_action(
|
|
'w3tc_network_dashboard_setup',
|
|
array( $o, 'wp_dashboard_setup' ),
|
|
$priority
|
|
);
|
|
|
|
self::$w3tc_dashboard_widgets[ $widget_id ] = '*';
|
|
}
|
|
|
|
/**
|
|
* Registers widget.
|
|
*
|
|
* @static
|
|
*
|
|
* @param string $widget_id Widget id.
|
|
* @param string $widget_name Widget name.
|
|
* @param callable $callback Callback.
|
|
* @param callable $control_callback Control callback.
|
|
* @param string $location Location.
|
|
* @param string $header_text Header text.
|
|
* @param string $header_class Header class.
|
|
*/
|
|
public static function add( $widget_id, $widget_name, $callback,
|
|
$control_callback = null, $location = 'normal', $header_text = null,
|
|
$header_class = '' ) {
|
|
$screen = get_current_screen();
|
|
|
|
global $w3tc_dashboard_control_callbacks;
|
|
|
|
if ( substr( $widget_name, 0, 1 ) !== '<' ) {
|
|
$widget_name = '<div class="w3tc-widget-text">' . $widget_name . '</div>';
|
|
}
|
|
|
|
// Link.
|
|
if ( $control_callback && current_user_can( 'edit_dashboard' ) && is_string( $control_callback ) ) {
|
|
if ( ! $header_text ) {
|
|
$header_text = __( 'Configure' );
|
|
}
|
|
|
|
$widget_name .= ' <span class="w3tc-widget-configure postbox-title-action">' .
|
|
'<a href="' . esc_url( $control_callback ) . '" class="edit-box open-box ' .
|
|
esc_attr( $header_class ) . '">' . $header_text . '</a></span>';
|
|
}
|
|
|
|
// Ajax callback.
|
|
if ( $control_callback && current_user_can( 'edit_dashboard' ) && is_callable( $control_callback ) ) {
|
|
$w3tc_dashboard_control_callbacks[ $widget_id ] = $control_callback;
|
|
$edit_val = Util_Request::get_string( 'edit' );
|
|
|
|
if ( ! empty( $edit_val ) && $widget_id === $edit_val ) {
|
|
list( $url ) = explode( '#', add_query_arg( 'edit', false ), 2 );
|
|
$widget_name .= ' <span class="postbox-title-action"><a href="' . esc_url( $url ) .
|
|
'">' . __( 'Cancel', 'w3-total-cache' ) . '</a></span>';
|
|
|
|
$callback = array(
|
|
'\W3TC\Util_Widget',
|
|
'_dashboard_control_callback',
|
|
);
|
|
} else {
|
|
list( $url ) = explode( '#', add_query_arg( 'edit', $widget_id ), 2 );
|
|
$widget_name .= ' <span class="postbox-title-action"><a href="' . esc_url( "$url#$widget_id" ) .
|
|
'" class="edit-box open-box">' . __( 'Configure' ) . '</a></span>';
|
|
}
|
|
}
|
|
|
|
$side_widgets = array();
|
|
|
|
$priority = 'core';
|
|
|
|
add_meta_box( $widget_id, $widget_name, $callback, $screen, $location, $priority );
|
|
}
|
|
|
|
/**
|
|
* Dashboard Widgets Controls.
|
|
*
|
|
* @static
|
|
*
|
|
* @param string $dashboard Dashboard id.
|
|
* @param array $meta_box Meta box info.
|
|
*/
|
|
public static function _dashboard_control_callback( $dashboard, $meta_box ) { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore
|
|
echo '<form action="" method="post" class="dashboard-widget-control-form">';
|
|
self::trigger_widget_control( $meta_box['id'] );
|
|
wp_nonce_field( 'edit-dashboard-widget_' . $meta_box['id'], 'dashboard-widget-nonce' );
|
|
echo '<input type="hidden" name="widget_id" value="' . esc_attr( $meta_box['id'] ) . '" />';
|
|
submit_button( __( 'Submit' ) );
|
|
echo '</form>';
|
|
}
|
|
|
|
/**
|
|
* List widgets.
|
|
*
|
|
* @static
|
|
*
|
|
* @return string
|
|
*/
|
|
public static function list_widgets() {
|
|
return implode( ',', array_keys( self::$w3tc_dashboard_widgets ) );
|
|
}
|
|
|
|
/**
|
|
* Calls widget control callback.
|
|
*
|
|
* @since 0.9.2.6
|
|
* @static
|
|
*
|
|
* @param int|bool $widget_control_id Registered widget id.
|
|
*/
|
|
public static function trigger_widget_control( $widget_control_id = false ) {
|
|
global $w3tc_dashboard_control_callbacks;
|
|
|
|
if ( is_scalar( $widget_control_id ) && $widget_control_id &&
|
|
isset( $w3tc_dashboard_control_callbacks[ $widget_control_id ] ) &&
|
|
is_callable( $w3tc_dashboard_control_callbacks[ $widget_control_id ] ) ) {
|
|
call_user_func(
|
|
$w3tc_dashboard_control_callbacks[ $widget_control_id ],
|
|
'',
|
|
array(
|
|
'id' => $widget_control_id,
|
|
'callback' => $w3tc_dashboard_control_callbacks[ $widget_control_id ],
|
|
)
|
|
);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Class: Util_Widget_Postponed
|
|
*/
|
|
class _Util_Widget_Postponed { // phpcs:ignore
|
|
/**
|
|
* Data.
|
|
*
|
|
* @var array
|
|
* @access private
|
|
*/
|
|
private $data = array();
|
|
|
|
/**
|
|
* Constructor.
|
|
*
|
|
* @param array $data Data.
|
|
*/
|
|
public function __construct( $data ) {
|
|
$this->data = $data;
|
|
}
|
|
|
|
/**
|
|
* Dashboard setup.
|
|
*/
|
|
public function wp_dashboard_setup() {
|
|
Util_Widget::add(
|
|
$this->data['widget_id'],
|
|
$this->data['widget_name'],
|
|
$this->data['callback'],
|
|
$this->data['control_callback'],
|
|
$this->data['location'],
|
|
$this->data['header_text'],
|
|
$this->data['header_class']
|
|
);
|
|
}
|
|
}
|