Функция __RETURN_EMPTY_STRING() │ WP 3.7.0

Функция __return_empty_string() возвращает пустую строку. Это вспомогательная функция, которая используется в WordPress.

Для чего это нужно?

Эта функция полезна, когда вам нужно вернуть пустую строку в фильтрах. Например, если у вас есть фильтр, который требует конкретного значения, и вы хотите, чтобы он возвращал пустую строку, вы можете использовать эту функцию.

Похожие функции

Вот некоторые другие вспомогательные функции в WordPress:

• __return_false() — возвращает значение false.
• __return_true() — возвращает значение true.
• __return_empty_array() — возвращает пустой массив (array()).
• __return_zero() — возвращает число 0.
• __return_null() — возвращает NULL.
• __return_empty_string() — возвращает пустую строку: ''.

Важно!

Эта функция предназначена для внутреннего использования в ядре WordPress. Мы не рекомендуем использовать ее в своем коде.

Время выполнения функции

• 1 раз — 0.000001 сек (скорость света)
• 50000 раз — 0.01 сек (скорость света)

Используется в PHP версии 7.1.11 и WordPress версии 4.9.7.

Нет хуков.

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

Функция возвращает строку. В данном случае, это пустая строка.

Применение функции

Для добавления фильтра используйте следующий код:

add_filter( 'filter_name', '__return_empty_string' );

Примеры использования

Допустим, нам нужно всегда возвращать пустую строку в фильтре 'my_filter'. Мы можем использовать следующий код:

add_filter( 'my_filter', '__return_empty_string' );

Другие варианты для достижения того же результата:

1. Пример анонимной функции:

add_filter( 'my_filter', create_function('','return "";') );

2. Для PHP 5.3+:

add_filter( 'my_filter', function(){ return ''; } );

3. Регистрация реальной функции:

add_filter( 'my_filter', 'my_return_function' );
function my_return_function(){
    return '';
}

Примечания

• Для получения дополнительной информации смотрите: __return_null()

Изменения

Функция была введена в версии 3.7.0.

Код функции __RETURN_EMPTY_STRING()

function __return_empty_string() { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionDoubleUnderscore,PHPCompatibility.FunctionNameRestrictions.ReservedFunctionNames.FunctionDoubleUnderscore
    return '';
}

Связанные функции

Некоторые вспомогательные функции:

• __return_empty_array()
• __return_false()
• __return_null()
• __return_true()
• __return_zero()

Эти функции могут быть интересны для использования в вашем проекте.