Функция REMOVE_IMAGE_SIZE() в WordPress 3.9.0

## Функция REMOVE_IMAGE_SIZE() │ WP 3.9.0

Функция remove_image_size() позволяет удалить ранее зарегистрированный размер изображения по его имени. Настройка нового размера изображения производится при помощи функции add_image_size().

Это может быть полезно, например, когда тема добавляет новый размер изображения, и вы хотите изменить его.

### Пояснение термина

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

### Примечания

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

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

- **true | false**: Возвращает true, если размер изображения успешно удален, и false в случае ошибки.

### Синтаксис использования

```php
remove_image_size( $name );
  • $name (string) (обязательный) — имя размера изображения, который вы хотите удалить. Имя должно совпадать с тем, что использовалось в функции add_image_size().

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

Пример 1: Удаление размера изображения

Предположим, что мы используем плагин, который добавляет новый размер изображения, и мы хотим его удалить:

add_action( 'after_setup_theme', 'remove_plugin_image_sizes' );
function remove_plugin_image_sizes() {
    remove_image_size('image-name');
}

Пример 2: Изменение размеров миниатюры

В этом примере мы переопределяем размер изображения с тем же именем, но с другими размерами миниатюры:

add_action( 'after_setup_theme', 'remove_then_add_image_sizes' );
function remove_then_add_image_sizes(){
    add_image_size( 'image-name', 200, 200, true );
}

Заметки

  • Глобальная переменная: $_wp_additional_image_sizes — это массив, содержащий зарегистрированные размеры изображений.

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

  • С версии 3.9.0: Функция была введена.

Код функции

Функция, находящаяся в файле wp-includes/media.php:

function remove_image_size( $name ) {
    global $_wp_additional_image_sizes;

    if ( isset( $_wp_additional_image_sizes[ $name ] ) ) {
        unset( $_wp_additional_image_sizes[ $name ] );
        return true;
    }

    return false;
}

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

  • add_image_size(): Регистрация нового размера изображения.
  • delete_post_thumbnail(): Удаление миниатюры поста.
  • get_intermediate_image_sizes(): Получение зарегистрированных размеров изображений.
  • get_post_thumbnail_id(): Получение ID миниатюры поста.
  • get_the_post_thumbnail(): Получение миниатюры поста для отображения.
  • has_image_size(): Проверка, существует ли заданный размер изображения.

Leave a Reply

Ваш адрес email не будет опубликован. Обязательные поля помечены *