В этой статье предоставлена подробная информация о функциях и шорткодах, которые могут быть использованы для взаимодействия с плагином AdContent.
Функции и шорткоды
Вы можете использовать следующие функции и шорткоды для взаимодействия с плагином:
- WordPress шорткод
[adcontent]
- HTML-шорткод
<div class="adcontent-ajax"></div>
- PHP функции
get_ads()
иthe_ads()
- JavaScript функцию
adcontent_ajax()
Для получения кода используйте генератор кода.
Параметры
Функции и шорткоды поддерживают следующие параметры:
- id (integer|string|array)– ID объявлений через запятую или в виде массива.
- num (integer|string) – Количество объявлений для получения. Используйте
-1
для получения всех объявлений. - format (integer|string|array) – ID форматов объявлений через запятую или в виде массива.
- group (integer|string|array) – ID групп объявлений через запятую или в виде массива.
- post_id (integer|string) – ID записи для которой необходимо получить объявления.
- term_id (integer|string) – ID термина таксономии для которого необходимо получить объявления.
- page (string|array) – типы страниц через запятую или в виде массива. Поддерживаются значения:
- front_page — главная страница;
- page – статические страницы;
- single – страницы постов и пользовательских типов записей;
- term – страницы рубрик, меток и пользовательских таксономий;
- search – страница с результатами поиска;
- attachment – страницы вложений;
- 404 – страница ошибки 404;
- post_type_archive – архивные страницы типов записей;
- author – архивные страницы авторов;
- date – архивные страницы дат;
- device (string|array) – типы устройств через запятую или в виде массива. Поддерживаются значения:
- mobile – смартфоны;
- desktop – настольные компьютеры;
- tablet – планшеты;
- location (string|array) – коды стран Alpha-2 ISO 3166-1 в верхнем регистре через запятую или в виде массива. Пример: RU, UA, DE, NL, US.
- orderby (string) – тип сортировки объявлений. Поддерживаются значения:
- priority – по приоритету;
- post__in – по переданным ID объявлений;
- rand – в случайном порядке;
- date – по дате создания;
- modified – по дате изменения;
- order (string) – порядок сортировки объявлений. Поддерживаются значения:
- ASC – по возрастанию;
- DESK – по убыванию.
- not (integer|string|array) – ID объявлений через запятую или в виде массива, которые необходимо исключить из запроса.
- default (integer|string|array) – ID объявлений через запятую или в виде массива, которые необходимо загружать по умолчанию (если нет релевантных объявлений).
- class (string) – CSS классы через пробел для контейнера с объявлениями.
- role (string) – роли пользователей через запятую или в виде массива. Укажите роли пользователей для показа объявлений.
- timeout (integer|string) – задержка для Ajax запроса (в миллисекундах).
- ajax (bool|integer) – статус загрузки объявлений с помощью Ajax для шорткода
[adcontent]
. - return (string) – тип возвращаемых данных. Используется только для JavaScript функции
adcontent_ajax()
. Поддерживаемые значения:- string – код объявлений будет возвращен в виде строки;
- array – код объявлений будет возвращен в виде индексного массива.
Массивы поддерживаются только PHP функциями get_ads()
и the_ads()
. Во всех остальных случаях используйте строковое представление данных.
Следует отметить, что параметры post_id
, term_id
, page
, device
и location
определяются автоматически, если вы не задали значения значения для этих параметров вручную. Вы можете отключить любой из этих параметров, независимо от его статуса в настройках плагина, указав в качестве значения 0
или false
.
Например, если в плагине включено определение местоположения пользователя, но вы укажете 0
в параметре location
, плагин будет показывать объявления без учета текущего местоположения пользователя. Если же вы укажете свое собственное значение в этом параметре, то плагин будет использовать его вместо реального местоположения пользователя.
Шорткод [adcontent]
По умолчанию данный шорткод может быть использован в контенте записи. Для этого просто разместите шорткод в любом месте в тексте записи или страницы.
Пример:
[adcontent num="5" orderby="rand" class="ads"]
Вы также можете использовать данный шорткод в текстовых и HTML виджетах. Если ваши шорткоды будут отображаться в виджетах, как обычный текст, активируйте опцию «Шорткоды в виджетах» в настройках плагина.
Если вы хотите использовать шорткод в теме или плагинах, используйте функцию do_shortcode
.
Пример:
<?php $ads = do_shortcode( '[adcontent num="5" orderby="rand" class="ads"]' ); ?>
HTML-шорткод
HTML-шорткоды могут быть использованы в любом месте сайта. Для этого просто добавьте HTML-шорткод в любом месте страницы.
Пример:
<span class="adcontent-ajax" data-num="5" data-orderby="rand"></span>
HTML-шорткоды загружают объявления с помощью Ajax, поэтому опции «Скрипты» и «Ajax» в настройках плагина должны быть включены.
PHP функция get_ads()
<?php $ads = get_ads( $args, $return ); ?>
Получает объявления в виде строки или массива. Вы можете использовать эту функцию в теме и плагинах.
Возвращает
Индексный массив или строку, в зависимости от значения параметра $return
. false
или пустую строку ""
, если объявления не были получены.
Параметры
- $args (array) — массив аргументов для получения объявлений.
- $return (string) — тип возвращаемых данных. Поддерживаемые значения:
string
– код объявлений будет возвращен в виде строки.array
– код объявлений будет возвращен в виде индексного массива.
Пример:
<?php $ads = get_ads(array( 'num' => '10', 'orderby' => 'rand' ), 'string'); ?>
PHP функция the_ads()
<?php the_ads( $args, $before, $after, $default ); ?>
Выводит рекламные блоки на экран. Вы можете использовать эту функцию в теме и плагинах.
Параметры
- $args (array) — массив аргументов для получения объявлений.
- $before (string) — текст или HTML-код, который будет добавлен перед объявлениями.
- $after (string) — текст или HTML-код, который будет добавлен после объявлений.
- $default (string) — текст или HTML-код, который будет выведен на экран по умолчанию (если нет релевантных объявлений).
Пример:
<?php the_ads( array( 'num' => '10', 'orderby' => 'rand', ), '<div class="ads">', '</div>' ); ?>
JavaScript функция adcontent_ajax()
adcontent_ajax( args, callback );
Получает объявления в виде строки или массива с помощью Ajax. Вы можете использовать эту функцию в теме и плагинах.
Возвращает
В случае успеха в функцию callback
будут переданы объявления в виде индексного массива или строки. В противном случае — false
. Тип возвращаемых данных задается через параметр args['return']
, который может принимать значение string
или array
.
Пример:
<script> jQuery( document ).ready( function() { jQuery( window ).on( "adcontent_globals_init", function() { adcontent_ajax( { 'num' : '10', 'return' : 'string' }, function( data ) { if ( jQuery.type( data ) === "string" ) { var ads = '<div class="widget">' + data + '</div>'; ads = jQuery( '<div/>' ).html( ads ).contents(); jQuery( '#sidebar' ).append( ads ); } } ); } ); } ); </script>