wp_sprintf() │ WP 2.5.0

Вариант PHP функции sprintf() от WordPress. Поддерживает %l (list - список) в передаваемом формате.

Получает отформатированную строку, созданную на базе указанного формата: смотрите описание PHP функции sprintf().

1 раз — 0.000104 сек (быстро) | 50000 раз — 0.30 сек (очень быстро) | PHP 7.1.11, WP 4.9.7
Хуки из функции

Возвращает

Строку. Текст созданный на основе указанного формата (паттерна).

Использование

wp_sprintf( $pattern, $args... );
$pattern(строка) (обязательный)

Строка формата, в которой будут использованы параметры $args.

%l (list - список) - новый заменитель, которого нет в sprintf(). На место этого заменителя нужно передавать массив со значениями, которые будут записаны через запятую (последняя запятая будет заменена на «и»).

%l заменитель пропускается через фильтр wp_sprintf, на который в WP прицеплена функция wp_sprintf_l().

$args(смешанный) (обязательный)
,... Параметры, которые будут использованы в строке формата $pattern.

Примеры

0

#1 Пример использования заменителя %l 

echo wp_sprintf( '%s: %l', 'Префикс', array( 'один', 'два', 'три', 'четыре' ) );
//> Префикс: один, два, три и четыре
0

#2 Еще примеры преобразований формата 

$pattern = '%d обезьян сидят на %s';
echo wp_sprintf( $pattern, 5, 'дереве' ); //> 5 обезьян сидят на дереве

$pattern = 'На %2$s сидят %1$d обезьян';
echo wp_sprintf( $pattern, 5, 'дереве' ); //> На дереве сидят 5 обезьян

$pattern = 'На %2$s сидят %1$d обезьян. %1$d обезьян сидят на %2$s.';
echo wp_sprintf( $pattern, 5, 'дереве' ); //> На дереве сидят 5 обезьян. 5 обезьян сидят на дереве.

Список изменений

С версии 2.5.0 Введена.
С версии 5.3.0 Formalized the existing and already documented ...$args parameter by adding it to the function signature.

Код wp_sprintf() WP 6.7.1

wp-includes/formatting.php 
function wp_sprintf( $pattern, ...$args ) {
	$len       = strlen( $pattern );
	$start     = 0;
	$result    = '';
	$arg_index = 0;

	while ( $len > $start ) {
		// Last character: append and break.
		if ( strlen( $pattern ) - 1 === $start ) {
			$result .= substr( $pattern, -1 );
			break;
		}

		// Literal %: append and continue.
		if ( '%%' === substr( $pattern, $start, 2 ) ) {
			$start  += 2;
			$result .= '%';
			continue;
		}

		// Get fragment before next %.
		$end = strpos( $pattern, '%', $start + 1 );
		if ( false === $end ) {
			$end = $len;
		}
		$fragment = substr( $pattern, $start, $end - $start );

		// Fragment has a specifier.
		if ( '%' === $pattern[ $start ] ) {
			// Find numbered arguments or take the next one in order.
			if ( preg_match( '/^%(\d+)\$/', $fragment, $matches ) ) {
				$index    = $matches[1] - 1; // 0-based array vs 1-based sprintf() arguments.
				$arg      = isset( $args[ $index ] ) ? $args[ $index ] : '';
				$fragment = str_replace( "%{$matches[1]}$", '%', $fragment );
			} else {
				$arg = isset( $args[ $arg_index ] ) ? $args[ $arg_index ] : '';
				++$arg_index;
			}

			/**
			 * Filters a fragment from the pattern passed to wp_sprintf().
			 *
			 * If the fragment is unchanged, then sprintf() will be run on the fragment.
			 *
			 * @since 2.5.0
			 *
			 * @param string $fragment A fragment from the pattern.
			 * @param string $arg      The argument.
			 */
			$_fragment = apply_filters( 'wp_sprintf', $fragment, $arg );

			if ( $_fragment !== $fragment ) {
				$fragment = $_fragment;
			} else {
				$fragment = sprintf( $fragment, (string) $arg );
			}
		}

		// Append to result and move to next fragment.
		$result .= $fragment;
		$start   = $end;
	}

	return $result;
}

Полифилы PHP (Polyfills замена PHP функций)

Вспомогательные