WordPress как на ладони
Недорогой хостинг для сайтов на WordPress: wordpress.jino.ru Хостинг, VPS/VDS и отдельные сервера только на SSD дисках. 7 дней бесплатного тестирования.

Kama Thumbnail: создание миниатюр налету

В прошлом, когда я был совсем еще зеленым в мире программирования, в тот зимний вечер, я трудился над своим первым шаблон для WordPress. Мне нужно было настроить вывод миниатюр к записям. К тому моменту я уже познакомился с рядом шаблонов для WordPress, в которых встречалась реализация этой задачи. А реализовывалась она посредством, наверняка, известного вам скрипта timthumb.php - создает уменьшенную копию изображения по передаваемой ссылке на это самое изображение. Скрипт этот я конечно в итоге прикрутил к шаблону и был доволен результатом, но это продолжалось недолго...

Все работало: вставляешь в запись изображение, брешь ссылку на него и добавляешь её в, специально созданное произвольное поле. В шаблоне ссылка с этого поля считывается и по ней создается миниатюра. Но спустя какое-то время, постоянное копирование и добавление ссылки в метаполе, стало утомительным занятием. Более того, бывало, что я вообще забывал вставить эту пресловутую ссылку и после публикации приходилось возвращаться к редактированию записи... Знакомо?

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

О плагине создания миниатюр для WordPress

После активации, плагин ничего не делает, чтобы он начал работать нужно будет редактировать шаблон (вызывать функции в том месте, где необходимы миниатюры изображений). Если просто установить и активировать плагин, он ничего делать не будет!

В целом, скрипт очень похож на timthumb.php, однако отличается и в чем-то лучше:

  1. Не нужно вручную создавать произвольное поле со ссылкой на картинку. Поле создается автоматически.

  2. Работает немного быстрее timthumb.php - я сделал все чтобы скрипт работал максимально быстро, никаких проверок без острой необходимости, во всем этом помогает кэш;

  3. Ссылка на картинку будет выглядеть валидно /images/название файла.jpg, а не /functions.php?src=/images/название файла.jpg&w=100&h=100&q=80;

  4. Кэш чиститься вручную. В timthumb.php кэш постоянно проверяется, старые файлы удаляются. На проверку уходят ресурсы (мелочь, но все же). На этом можно экономить;

  5. Ресайзинг можно использовать прямо в посте, указав картинке class mini и нужные размеры;

  6. Гораздо удобнее использовать при интеграции в тему WordPress: не нужно получать значение произвольного поля, проверять существует ли поле, чтобы вывести картинку заглушку. Все это будет делаться автоматом.

  7. На timthumb.php много хакерских атак.
меню

Принцип работы Kama Thumbnail

Создает папку кэша: wp-content/cache/thumb. В нее будут создаваться все миниатюры.

Миниатюры создаются всякий раз, когда вызывается одна из функций плагина для создания миниатюры - их всего 3: kama_thumb_src(), kama_thumb_img(), kama_thumb_a_img(). В функцию можно передать размеры миниатюры и URL картинки из которой нужно сделать миниатюру. URL картинки можно не передавать, тогда функция будет искать картинку для текущей записи.

Как плагин ищет картинку для текущей записи? При публикации или обновлении поста, плагин ищет ссылку на оригинал картинки и записывает её в произвольное поле поста, затем в теме по этой ссылке создается миниатюра. Ссылка определяется в следующем порядке:

  1. Если у поста установлена миниатюра WordPress, её ссылка будет взята;

  2. Если в тексте поста есть картинка, её ссылка будет взята. Если эта картинка является анкором ссылки на увеличенный вариант этой картинки, то будет взят УРЛ ссылки, а не картинки;

  3. Если у поста нет ни миниатюры WP ни картинки в тексте, то плагин проверит нет ли у поста загруженной для него картинки (вложения). Если вложение есть, то ссылка будет взята от туда;

  4. Если ничего не найдено, то в произвольное поле будет добавлена запись-заглушка: "no_photo". Нужно это, чтобы не производить каждый раз эти операции по поиску ссылки.

При удалении плагин удаляет за собой все: произвольные поля, опции в базе данных, кэш картинок, папку кэша.

Настройки kama thumbnail. Настройки > Медиафайлы

Настройки kama thumbnail. Настройки > Медиафайлы
меню

Скачать

Kama Thumbnail (последняя версия)
Скачать последнюю версию плагина (zip архив)
Скачано: 193, размер: 19.0 KB
Смотреть плагин в каталоге WordPress меню

Использование (параметры)

После установки плагина в шаблоне можно использовать функции:

// возвращает УРЛ созданной миниатюры
echo kama_thumb_src( $args, $src );

// возвращает готовую картинку (img тег)
echo kama_thumb_img( $args, $src );

// возвращает ссылку-картинку. Ссылка ведет на оригинал картинки.
echo kama_thumb_a_img( $args, $src );

// получает ширину или высоту картинки. Или любое свойство экземпляра класса,
// который создает картинку. Обычно там могут пригодится только ширина или высота...
// функция нужна, когда создается миниатюра без заранее известной ширины или высоты...
echo kama_thumb( $optname );
// Пример:
echo '<img src="'. kama_thumb_src('w=200') .'" width="200" height="'. kama_thumb('height') .'" alt="" />';
// но в данном случае лучше использовать готовую kama_thumb_img() она все это учитывает...
$args(строка/массив)

Аргументы по которым создавать миниатюру. Все возможные параметры:

  • w | width
    Ширина миниатюры. Если указана только ширина, то высота будет подобрана пропорционально.

  • h | height
    Высота миниатюры. Если указана только высота, то ширина будет подобрана пропорционально.

    Если параметры 'w' и 'h' не указаны, то они будут равны 100: получится квадратная картинка 100х100 пикселей.

  • notcrop
    Если указать этот параметр (любое значение), то параметр crop выставиться в false: crop=false. Этот параметр в приоритете перед crop...

  • crop
    Отвечает за кадрирование. По умолчанию кадрирование всегда включено. С версии плагина 2.7.3.

    Чтобы отключить кадрирование, укажите false/0/no/none или определите параметр 'notcrop'. Тогда картинка не будет кадрироваться, а будет создаваться как уменьшенная копия оригинала по указанным размерам одной из сторон: либо высота, либо ширина - выбирается наименьшая подходящая сторона (т.е. одна сторона будет соответствовать h или w, а противоположная будет меньше чем указана в h или w).

    Позиция кадрирования

    Можно указать строку: 'right/bottom' или 'top', 'bottom', 'left', 'right', 'center' и любые их комбинации, через /.

    • 'left', 'right' - для краев
    • 'top', 'bottom' - для верхи и низа
    • 'center' - для обоих сторон

    Когда указывается одно значение, второе будет по умолчанию. По умолчанию 'center/center'.

    Примеры:

    // картинка скорее всего будет уменьшаться по высоте (большая сторона),
    // а ширина будет срезаться. right означает, что нужно показать 
    // правую часть картинки при срезе, а левую отрезать...
    kama_thumb_img('w=200 &h=400 &crop=right');
    
    // картинка будет показана полностью по ширине (большая сторона),
    // а высота будет срезаться. 
    // top говорит срезать нижнюю часть и оставить верх
    kama_thumb_img('w=400 &h=200 &crop=top');
    
    // указываем два параметра сразу, порядок значения не имеет: 
    // top/right или right/top...
    kama_thumb_img('w=400 &h=200 &crop=top/right');

    По умолчанию: true

  • alt
    alt атрибут картинки.

  • title
    title атрибут картинки.

  • class
    class атрибут <img> тега. По умолчанию: 'aligncenter'.

  • style
    style атрибут IMG тега.

  • attr
    Атрибуты для тега <img>. Строка передается как есть, без очисток.

  • a_class
    class атрибут <a> тега. Для функции kama_thumb_a_img().

  • a_style
    style атрибут <a> тега. Для функции kama_thumb_a_img().

  • a_attr
    Атрибуты для тега <a>. Строка передается как есть, без очисток. Для функции kama_thumb_a_img().

  • no_stub
    Указываем, если не нужно выводить заглушку. Вместо нее будет возвращен пустой результат.

  • yes_stub
    Указываем, если нужно выводить заглушку, когда она отключена в настройках.

  • post_id | post
    Идентификатор или объект поста. Его нужно передавать, когда функция вызывается не из Цикла WordPress, например, внутри какой-нибудь функции. Или, когда переменная $post определяется неправильно. Например, определяется картинка от другой записи или еще какие-нибудь глюки.

    Если передать этот параметр, то скрипт будет точно знать какой пост обрабатывать. Если этот параметр не передан, то будет обрабатываться пост, находящийся в текущий момент (когда вызывается функция) в  переменной $post.

  • attach_id
    ID изображения (вложения) в структуре WordPress. Этот ID можно еще указать числом в параметре $src - во втором параметре функции:

    echo kama_thumb_img('h=200', 250 );
    echo kama_thumb_img('h=200 &attach_id=250');

    attach_id имеет больший приоритет чем src. Т.е. в следующем примере ссылка на картинку http://site.ru/img.png будет обработана, только если нет вложения 250, иначе будет обработано указанное вложение.

    echo kama_thumb_img('h=200 &attach_id=250', 'http://site.ru/img.png');
  • allow
    Разрешенные хосты только для текущего вызова. Эта настройка ставиться глобально в настройках плагина. Но когда нужно указать разрешенный хост не глобально, а только для текущего вызова, его можно указать в этом параметре.

    Если указать 'any', то будет разрешено создавать миниатюры с любых сайтов (хостов). Напомню, что по умолчанию разрешается только с текущего домена и под-доменов. С версии (2.5)

  • q | quality
    Качество сжатия jpg (по умолчанию 85. макс.100).

  • rise_small (true/false)
    Добавлено в версии: 2.8.3

    Увеличивать ли изображения, если они меньше указанных размеров. По умолчанию, если создаваемая миниатюра маленькая (меньше указанного размера), она увеличиться до указанных размеров. Если такое поведение нужно отменить, укажите в этом параметре false.

    Эту настройку можно определить глобально в настройках плагина.

    По умолчанию: true.

$src(строка)

Ссылка на картинку, миниатюру которой нужно создать.

В этом случае плагине не будет пытаться получить ссылку из поста, а будет обрабатывать указанную тут картинку.

Можно указать число, тогда плагин будет считать что указано ID вложения - медиафайла WordPress и сам получит URL этого медиафайла и обработает его...

По умолчанию: ''

Если параметр передается как массив, то второй аргумент $src можно передать в этом массиве, под ключом: src, url, link или img:

echo kama_thumb_img( array(
	'src' => 'http://yousite.com/IMAGE_URL.jpg',
	'w' => 150,
	'h' => 100,
) );
меню

Заметки

Параметры можно указывать строкой или массивом
// строкой
kama_thumb_img('w=200 &h=100 &alt=название картинки &class=aligncenter', 'ссылка на произвольную картинку');
// 'ссылка на произвольную картинку' должна указываться как второй аргумент функции. Потому что в ссылке могут быть свои параметры запроса, чтобы не смешались с указанными.

// или массивом (рекомендуется)
kama_thumb_img( array(
	'width'  => 200,
	'height' => 150,
	'class'  => 'alignleft',
	'src'    => '',
) );
Можно указать только ширину или высоту

Тогда противоположная сторона (высота или ширина) будут подобраны пропорционально уменьшенной копии;

Параметр src

Нужен для случаев, когда нужно создать миниатюру к любой картинке.

Если параметры передаются строкой, то src нужно указывать во втором аргументе функции.

Очистка кэша

В настройках плагина есть 2 кнопки очистки кэша: "весь кэш" и "кэш заглушек". Нужно это для случаев, когда по каким-либо причинам, плагин не смог создать миниатюру по УРЛ. В этом случае для картинки создается заглушка, чтобы не пытаться создать картинку каждый раз при вызове. При очистке кэша заглушек, удаляются только заглушки и для всех заглушек, плагин пытается создать миниатюры еще раз.

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

Картинки с других доменов

По умолчанию можно создавать картинки только с текущего домена или поддоменов.

Чтобы можно было создавать картинки с внешних доменов укажите названия разрешенных доменов в настройках плагина: Настройки - Медиафайлы или в параметре allow при вызове функции.

Если вместо названия домена(ов) указать any, то будет разрешено создание картинок с любых доменов.

Миниатюра в тексте статьи (шоткод)

Если в статье нужно уменьшить картинку и сделать её ссылкой на оригинал, то укажите картинке класс mini и задайте нужные размеры (width или height).

Например, мы вставили картинку в статью:

<img src="http://site.ru/foo.jpg" alt="alt_text" width="1000" height="800" class="aligncenter" />

Но такая большая не нужна, а нужно её уменьшить не визуально, а реально. Для этого добавляем к ней класс mini и указываем нужные размеры (width="300"):

<img src="http://site.ru/foo.jpg" alt="alt_text" width="300" class="aligncenter mini" />

Высота, которую мы удалили будет подобрана автоматически, пропорционально.

Такой подход - не использовать шоткод, мне показался удобнее: мы можем создавать миниатюры к картинкам и при этом видеть как картинка выглядит при редактировании поста, также при возможном удалении плагина, картинки в постах по-прежнему будут показываться (не останется непонятный шоткод).

Чтобы картинка миниатюра создавалась, эта опция должна быть включена в настройках Kama Thumbnail: Настройки > Медиафайлы.

Проверка обязательной установки плагина

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

Для этого поместите такой код в файл темы functions.php.

// обязательный для темы плагин kama thumbnail
if( ! is_admin() && ! function_exists('kama_thumb_img') ){
	 wp_die('Активируйте обязательный для темы плагин Kama Thumbnail');
}

Теперь в случае деактивации плагина, во фронтэнде пользователь увидит сообщение: «Активируйте обязательный для темы плагин Kama Thumbnail».

Скорость работы функций (замеры)

Первая обработка картинки долгая и скорость зависит от размера картинки. Остальные обработки уже гораздо быстрее, потому что берется из кэша...

Замеры проводились на картинке размером 32КБ (650x350), из которой создавалась миниатюра размером 100x100.

  • kama_thumb_src() - 1 раз = 0.01403, 50 000 раз = 0.54830 сек. (очень быстро)
  • kama_thumb_img() - 1 раз = 0.01471, 50 000 раз = 1.38748 сек. (быстро)
  • kama_thumb_a_img() - 1 раз = 0.01471, 50 000 раз = 1.72967 сек. (быстро)

При работе с кэшем, а это 99% работы плагина, нет разницы какой у картинки размер...

меню

Сообщения о необходимости установить этот плагин

Допустим, ваша тема или плагин использует этот плагин и требует его установки для корректной работы. Так, если плагин не установлен тема может совсем не работать, потому что будет использовать функцию, которой попросту нет в PHP. Давайте отловим такой момент и выведем PHP ошибку уровня NOTICE:

if( ! function_exists('kama_thumb_src') ){
	add_action( 'admin_notices', function(){
		echo '<div class="error"><p>'. __( 'This theme requires plugin Kama Thumbnail. Install it please.', 'dom' ) .'</p></div>';
	} );

	function kama_thumb_src(){}

	function kama_thumb_img(){}

	function kama_thumb_a_img(){}

	function kama_thumb(){}
}
меню

Примеры

#1 Получаем миниатюру

Внутри цикла WordPress, где нужна миниатюра к посту, с  размерами 150х100, используем такой код:

<?php echo kama_thumb_img('w=150 &h=100 &class=alignleft myimg'); ?>

В результате на месте этого кода появится готовый тег <img>:

<img src='ссылка на миниатюру' alt='' class='alignleft myimg' width='150' height='100' />

#1.2 Уменьшение картинки только по указанной стороне

Чтобы получить не кадрированную пропорционально уменьшенную картинку по указанной стороне: по ширине или по высоте, нужно указать только ширину или высоту, тогда противоположная сторона будет подобрана пропорционально. Кадрирования при этом не будет.

kama_thumb_img('w=200');

Теперь ширина всегда будет 200, а высота какая получится... При этом картинка всегда будет полная, без кадрирования.

#2 Не выводим картинку-заглушку

Чтобы картинка-заглушка не выводилась, если у записи нет картинок, то нужно определить параметр no_stub:

<?php echo kama_thumb_img('w=150 &h=100 &no_stub'); ?>

#3 Проверка наличия картинки для записи

Если нужно проверить есть ли у поста картинка и если нет, то сделать что-то другое, то используйте такой код:

$img = kama_thumb_img('w=150 &h=150 &no_stub');
if( ! $img )
	echo 'Картинки нет';

#4 Получаем только УРЛ миниатюры

Если не нужно выводить готовый тег img, а нужно получить только ссылку на миниатюру, чтобы затем её использовать, используйте функцию kama_thumb_src():

<?php echo kama_thumb_src('w=100 &h=80'); ?>

Вернет УРЛ миниатюры: /wp-content/cache/thumb/ec799941f_100x80.png. Этот УРЛ можно использовать, например, так:

<img src='<?php echo kama_thumb_src('w=100 &h=80 &q=75'); ?>' alt='' />

#5 Получаем миниатюру-ссылку на оригинал

Если нужно сделать миниатюру, как картинку, кликнув на которую откроется большое изображение, то используйте такой код:

<?php echo kama_thumb_a_img('w=150 &h=100 &class=alignleft myimg &q=75'); ?>

Выведет на экран:

<a href='ссылка на оригинал картинки'><img src='ссылка на миниатюру' alt='' class='alignleft myimg' width='150' height='100' /></a>

#6 Получаем миниатюру по ссылке на картинку

Если нужно создать миниатюру на определенную картинку (не картинку из текста статьи), то можно передать второй аргумент функции, в котором указать ссылку на картинку.

$src = 'http://домен/картинка.jpg';
echo kama_thumb_img('w=150 &h=100 &class=alignleft', $src );

#7 Параметр post_id

По умолчанию миниатюры создаются для текущего поста, тот который записан в глобальной переменной $post. Иногда эта переменная определена неправильно и картинки могут создаваться другие, относящиеся к другому посту. Чтобы точно определить для какого поста должна создаться миниатюра определите post_id.  Если вызов происходит в Цикле WordPress, то этот параметр указывать не нужно!

<?php echo kama_thumb_img("w=150 &h=100 &post_id=идентификатор_поста"); ?>

#8 Картинки с других доменов: параметр allow

Если в настройках плагина, в разрешенных хостах, не установлен нужный хост и не установлена строка any (разрешить все домены). То разрешенные домены можно указать в параметре allow:

Допустим наш домен это site.ru, а нам нужно создать картинку с сайта 'http://static.othersite.ru/img.jpg'.

// можно указать точно
echo kama_thumb_img('w=200 &h=150 &allow=othersite.ru', 'http://static.othersite.ru/img.jpg');

// или можно указать для всех, чтобы можно было создавать с любого сайта
echo kama_thumb_img('w=200 &h=150 &allow=any', 'http://other-site.ru/img.jpg');

// точно можно указывать несколько доменов через запятую
echo kama_thumb_img('w=200 &h=150 &allow=othersite.ru, foo.com', 'http://foo.com/img.jpg');
меню

Использование не как плагин (интеграция в тему)

Если вы разрабатываете тему и вам нужен функционал этого плагина, но при этом не нужно устанавливать плагин. То этот плагин можно использовать не как плагин, а как часть темы или как mustuse плагин.

Для этого нужно скопировать папку плагина (со всеми файлами) в папку темы и подключить основной файл плагина kama_thumbnail.php в файле functions.php. Это все!

Например, в теме есть папка includes и в нее мы скопировали папку плагина, тогда главный файл нужно подключить так:

require_once 'includes/kama-thumbnail/kama_thumbnail.php';

Отключение страницы опций

Если страница опций не нужна (делаете сайт для клиента). То её можно отключить. Для этого нужно прописать нужные опции через фильтр kama_thumb_def_options. Сделать это можно в файле темы functions.php или где-либо еще:

// Переопределяет настройки плагина Kama Thumbnail
// Автоматически отключают страницу опций в админке и использование опций.
add_filter( 'kama_thumb_def_options', function( $opts ){

	/* исходные, см. код плагина
	'meta_key'          => 'photo_URL', // называние мета поля записи.
	'cache_folder'      => '',          // полный путь до папки миниатюр.
	'cache_folder_url'  => '',          // URL до папки миниатюр.
	'no_photo_url'      => '',          // УРЛ на заглушку.
	'use_in_content'    => 'mini',      // искать ли класс mini у картинок в тексте, чтобы изменить их размер.
	'no_stub'           => false,       // не выводить картинку-заглушку.
	'auto_clear'        => false,       // очищать ли кэш каждые Х дней.
	'auto_clear_days'   => 7,           // каждые сколько дней очищать кэш.
	'rise_small'        => true,        // увеличить создаваемую миниатюру (ширину/высоту), если её размер меньше указанного размера.
	'quality'           => 90,          // качество создаваемых миниатюр.
	'allow_hosts'       => '',          // доступные хосты, кроме родного, через запятую. 'any' - любые хосты.
	'debug'             => 0,           // режим дебаг (для разработчиков).
	*/

	$opts['cache_folder']     = get_template_directory() . '/cache';
	$opts['cache_folder_url'] = get_template_directory_uri() .'/cache';
	$opts['no_stub']          = true;
	$opts['auto_clear']       = true;

	return $opts;
} );

Условие использования - упоминание об этом плагине или этой странице в описании темы.

меню

FAQ

Опрос по плагину

Что добавить/убрать в Kama Thumbnail?

  • Добавить ответ
Результаты

То что было реализовано из результатов опроса:

1. Добавить плагин в каталог плагинов WordPress - 21 голос
2. Дать отдельно функцию, а не плагин - 12 голосов
3. Готово! Чтобы делал миниатюры на SRC с удаленного ресурса, скачивая их в папку wp-content/cache/thumb - 11 голосов

На avi1.ru Вы можете накрутить просмотры на видео в Инстаграме с критериями на любой вкус: быстрые, медленные живые и т. д. К тому же, Вы можете уже сейчас получить неплохие оптовые скидки на продвижение в социальной сети.

504 коммента
Полезные 30 Вопросы 1 Все
  • Даже не ожидал найти что-то подобное для WP.

    Спасибо большое за такой плагин. good2

    Ответить20 дней назад #
Здравствуйте, !     Войти . Зарегистрироваться