__return_false()WP 3.0.0

Просто возвращает false. Вспомогательная функция WordPress.

Используется в фильтрах, когда нужно указать функцию, которая всегда возвращает false.

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

1 раз — 0.000001 сек (скорость света) | 50000 раз — 0.00 сек (скорость света) | PHP 7.1.11, WP 4.9.7

Хуков нет.

Возвращает

false.

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

__return_false();

Примеры

0

#1 Вернем false в фильтре

Допустим у нас есть фильтр 'show_admin_bar' и нам нужно вернуть в значении этого фильтра false. Для этого мы может написать отдельную функцию или воспользоваться вспомогательной функций __return_false():

add_filter( 'show_admin_bar', '__return_false' );

Другая запись без __return_false

// или так для php 5.3+
add_filter( 'show_admin_bar', function(){ return false; } );

// или так, с регистрацией функции
add_filter( 'show_admin_bar', 'my_return_function' );
function my_return_function(){
	return false;
}

Заметки

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

С версии 3.0.0 Введена.

Код __return_false() WP 6.5.2

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