Функция __return_true() в WordPress: возвращение true значания

# __RETURN_TRUE() │ WP 3.0.0

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

## Зачем она нужна?

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

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

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

**Важно:** Эта функция предназначена для использования самой системой WordPress, и не рекомендуется использовать её в вашем коде.

### Производительность

- 1 вызов — 0.000001 сек (скорость света)
- 50000 вызовов — 0.00 сек (скорость света)
- PHP версия: 7.1.11, WordPress версия: 4.9.7

## Результат работы функции

Функция возвращает:

true

## Применение

Чтобы использовать функцию, вызовите её так:

```php
__return_true();

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

Пример 1: Возвращаем true в фильтре

Предположим, у нас есть фильтр custom_menu_order, который отвечает за возможность произвольной сортировки административного меню. По умолчанию он отключен. Чтобы включить его, добавим следующий код в файл functions.php вашей темы или в файл плагина:

add_filter('custom_menu_order', '__return_true');

Теперь возможность сортировки включена, и мы можем сортировать административное меню:

add_filter('menu_order', 'my_menu_order');
function my_menu_order($menu_order) {
    return array('index.php', 'edit.php', 'edit.php?post_type=page', 'edit-comments.php');
}

Пример 2: Другие способы написания __return_true

// пример анонимной функции (PHP 5.3+)
add_filter('show_admin_bar', function() { return true; });

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

Примечания

• Смотрите также: __return_false()

Изменения

• С версии 3.0.0 — введена в WordPress.

Код функции

function __return_true() { 
    return true; 
}

Этот код находится в файле wp-includes/functions.php в строках 6942-6944.

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

Если вас интересуют другие вспомогательные функции, посмотрите на следующие:

• __return_empty_array()
• __return_empty_string()
• __return_false()
• __return_null()
• __return_zero()

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

• array_key_first()
• array_key_last()
• wp_random()
• и многие другие.

Эти функции могут помочь вам в разработке и улучшении вашего WordPress-сайта.