wp_dashboard_cached_rss_widget() — описание функции WordPress на русском

Сигнатура

wp_dashboard_cached_rss_widget( string $widget_id, callable $callback, array $check_urls = array(), mixed $args ): bool

Описание

Если $check_urls пуст, ищется URL RSS-ленты из настроек виджета панели управления $widget_id. Если он закэширован, вызывается $callback — функция, которая выводит содержимое этого виджета. Если кэша нет, выводится заглушка «Loading…», которая позже заменяется Ajax-запросом (см. начало /wp-admin/index.php)

Оригинал (английский)

If $check_urls is empty, look for the rss feed url found in the dashboard widget options of $widget_id. If cached, call $callback, a function that echoes out output for this widget. If not cache, echo a “Loading…” stub which is later replaced by Ajax call (see top of /wp-admin/index.php)

Параметры

$widget_id string обязательный

ID виджета.

$callback callable обязательный

Функция обратного вызова, используемая для отображения каждой ленты.

$check_urls array необязательный = array()

RSS-ленты.

$args mixed необязательный

Необязательные дополнительные параметры для передачи в функцию обратного вызова.

Возвращаемое значение

bool

Исходный код

wp-admin/includes/dashboard.php:1177

function wp_dashboard_cached_rss_widget( $widget_id, $callback, $check_urls = array(), ...$args ) {
	$doing_ajax = wp_doing_ajax();
	$loading    = '<p class="widget-loading hide-if-no-js">' . __( 'Loading…' ) . '</p>';
	$loading   .= wp_get_admin_notice(
		__( 'This widget requires JavaScript.' ),
		array(
			'type'               => 'error',
			'additional_classes' => array( 'inline', 'hide-if-js' ),
		)
	);

	if ( empty( $check_urls ) ) {
		$widgets = get_option( 'dashboard_widget_options' );

		if ( empty( $widgets[ $widget_id ]['url'] ) && ! $doing_ajax ) {
			echo $loading;
			return false;
		}

		$check_urls = array( $widgets[ $widget_id ]['url'] );
	}

	$locale    = get_user_locale();
	$cache_key = 'dash_v2_' . md5( $widget_id . '_' . $locale );
	$output    = get_transient( $cache_key );

	if ( false !== $output ) {
		echo $output;
		return true;
	}

	if ( ! $doing_ajax ) {
		echo $loading;
		return false;
	}

	if ( $callback && is_callable( $callback ) ) {
		array_unshift( $args, $widget_id, $check_urls );
		ob_start();
		call_user_func_array( $callback, $args );
		// Default lifetime in cache of 12 hours (same as the feeds).
		set_transient( $cache_key, ob_get_flush(), 12 * HOUR_IN_SECONDS );
	}

	return true;
}

История изменений

Версия	Описание
5.3.0	Formalized the existing and already documented ...$args parameter by adding it to the function signature.
2.5.0	Introduced.