Определите свои собственные виджеты WordPress

Панель параметров виджета является дополнительной

Определение функций form() и update() является обязательным. Они необходимы, только если ваш виджет нуждается в некотором вводе конфигурации от пользователя. Вы можете оставить их, если вы не хотите предоставлять какие-либо параметры виджета. В этом случае панель параметров будет показана так, как показано на рисунке ниже.

Шаг 4. Определите интерфейс панели параметров

WordPress ожидает, что функция form() определенная выше, будет выводить поля ввода для получения ввода от пользователя. В случае виджета Twitter Feed мы предоставим следующие опции:

1. Название виджета
2. Имя пользователя Twitter
3. Количество твитов, чтобы показать.

Ниже приведено определение функции form() для виджета ленты Twitter:

  форма функции ($ config)
 {
 ?>
     <label for = "<? php echo $ this-> get_field_id (" title ");?>">
     <p> Title: <input type = "text" value = "<? php echo $ config ['title'];?>" name = "<? php echo $ this-> get_field_name (" title ");?> "id =" <? php echo $ this-> get_field_id ("title")?> "> </ p>
     </ Метка>

     <label for = "<? php echo $ this-> get_field_id (" username ");?>">
     <p> Имя пользователя Twitter: <input type = "text" value = "<? php echo $ config ['username'];?>" name = "<? php echo $ this-> get_field_name (" username ");? > "id =" <? php echo $ this-> get_field_id ("username")?> "> </ p>
     </ Метка>

     <label for = "<? php echo $ this-> get_field_id (" num ");?>">
     <p> Количество твитов: <input type = "text" size = "3" value = "<? php echo $ config ['num'];?>" name = "<? php echo $ this-> get_field_name ( "num");?> "id =" <? php echo $ this-> get_field_id ("num")?> "> </ p>
     </ Метка>
 <? PHP
 } 

form() Функция Объяснил

1. Функция принимает один аргумент — $config . Эта переменная содержит значения конфигурации для этого виджета.
2. Поля в опциях помещаются в <form> который отправляется через запрос AJAX. Что означает, что тег формы не должен быть добавлен в определение выше. WordPress обрабатывает сохранение данных виджета для вас.
3. Функции $this->get_field_name() и $this->get_field_id() используются для генерации имен для полей формы, чтобы не было конфликтов в именах с полями ввода на странице параметров виджета.

Шаг 5: Сохранить настройки панели параметров

Бизнес-логика, которая сохраняет настройки, выбранные на панели параметров выше, должна быть помещена в функцию save() . В случае нашего твиттера:

  обновление функции ($ newinstance, $ oldinstance)
 {
 $ instance = $ oldinstance;
     // обновляем имя пользователя
     $ instance ['username'] = $ newinstance ['username'];
     $ instance ['title'] = $ newinstance ['title'];
     $ num = (int) $ newinstance ['num'];
     $ num = intval ($ num);
     $ num = ($ num> 1)? $ num: 1;
     $ instance ['url'] = "http://api.twitter.com/1/statuses/user_timeline.json?screen_name= enj$newinstance['username']]&count= enj$num}";
     $ instance ['num'] = $ num;
     вернуть $ экземпляр;
 } 

Функция update() объяснена

• Функция принимает два аргумента:

1. Первый аргумент — в этом случае $newinstances — содержит информацию о конфигурации виджета, которая была введена на панели параметров. WordPress автоматически обнаруживает все элементы формы и использует их имена для элементов массива.
2. Второй аргумент — в данном случае $oldinstance — содержит информацию о конфигурации виджета до изменения настроек.

Панель параметров не поддерживает загрузку файлов

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

Шаг 6: Определите виджет

Теперь мы собираемся определить сам виджет. WordPress ожидает, что HTML-код виджета будет сгенерирован функцией с именем widget() . Ниже показано определение виджета Twitter:

  виджет функции ($ args, $ instance)
 {
      экстракт ($ арг, EXTR_SKIP);
      if (empty ($ instance ['url']) || empty ($ instance ['username']))
    	   возвращение;
      $ title = ($ instance ['title'])? $ instance ['title']: "Последние твиты";

      $ tweets = $ this-> get_tweets ($ instance ['url'], $ instance ['username'], $ instance ['num']);
      $ max = $ instance ['num'];
      echo $ before_widget;
 ?>
 <div class = "twitter-feed-widget">
 <php echo $ before_title;  ?>
 <strong> <? php echo $ title;  ?> </ STRONG>
 <php echo $ after_title;  ?>
 <? PHP
 $ Кол = 0;
 foreach ($ твиты как $ твит)
 {
     $ text = $ tweet ['tweet'];
 ?>
 <div class = "tfw-tweet"> <a href="<?php echo $tweet['url'] ?> "> <? php echo $ text;  ?> </a> </ DIV> <br/>
 <? PHP
     $ Количество ++;
     если ($ count == $ num)
      перемена;
 }
 ?>
 </ DIV>
 <? PHP
 echo $ after_widget;
 } 

Функция widget() объяснена

Функция виджета принимает два параметра: $args и $instance .

1. Переменная $ args содержит несколько переменных относительных тем:

1. before_widget — HTML- before_widget который будет напечатан перед телом виджета.
2. > after_widget — HTML-код, который будет напечатан после тела виджета.
3. before_title — HTML- before_title который будет напечатан перед заголовком виджета.
4. after_title — HTML- after_title который будет напечатан после заголовка для виджета.

• Вышеупомянутые переменные устанавливаются в теме WordPress автором темы в объявлении боковой панели темы в файле functions.php .
• Переменная $instance содержит информацию о конфигурации для этого экземпляра виджета, которая была сохранена в функции update() на предыдущем шаге.
• Приведенная get_tweets() функция get_tweets() будет извлекать твиты пользователя твиттера, переданные в переменной $username . Твиты возвращаются в виде ассоциативного массива. Реализация функции выглядит следующим образом:

    функция get_tweets ($ feed_url, $ username, $ num = 10)
      {
          // проверяем, есть ли канал в списке каналов
          $ feeds = get_option ("_ tfw_feeds");
          $ hash = md5 ($ feed_url);
          $ твиты = массив ();
          if (isset ($ feeds [$ hash]))
          {
              $ timeOfLastFetch = intval (@ $ feeds [$ hash] ["last_update"]);
              if ($ timeOfLastFetch-time ()> 300) // обновляем твиты каждые 5 минут
              {
                   $ ifUpdateTweets = true;
              }
              еще
              {
                    if (is_array ($ feeds [$ hash] ['tweets']) && count ($ feeds [$ hash] ['tweets']> = $ num))
                    {
                       return $ feeds [$ hash] ['tweets'];
                    }
                    еще
                    {
                         $ WhetherUpdateTweets = истина;
                    }
              }
          }
          еще
              $ ifUpdateTweets = true;      
  
          if ($ лиUpdateTweets)
          {
  	        if ($ tweetsList = file_get_contents ($ feed_url))
  	        {
  		    $ tweetsList = json_decode ($ tweetsList);
  		    foreach ($ tweetsList как $ твит)
  		    {
  		        $ tweets [] = array ("tweet" => $ tweet-> text, "url" => "https://twitter.com/#!/ enj$username‹/status/ enj$tweet->id_str}" );
  		    }
  	        }
  	        $ hash = md5 ($ feed_url);
  	        $ feeds = get_option ("_ tfw_feeds");
  	        $ feeds [$ hash] = array ("last_update" => time (), "tweets" => $ tweets);
  	        update_option ( "_ tfw_feeds", $ фиды);
          }
          вернуть $ твиты;
  
      } 

• Первая строка вызывает функцию extract() . Функция принимает ассоциативный массив. Он создает переменные, названные в честь ключей массива, и устанавливает для них значение, соответствующее этим ключам.
• Вторая строка гарантирует, что виджет вообще не отображается, если пользователь не сохраняет свое имя пользователя.
• Четвертая строка гарантирует, что переменная $title всегда установлена ​​в пригодную для использования строку.
• Следующие четыре строки печатают содержимое вышеупомянутых переменных, связанных с темой.
• Функция get_tweets() извлекает список твитов пользователя Twitter. Имя файла RSS, которое было сохранено на этапе обновления, передается этой функции в качестве параметра. Он возвращает массив ассоциативных массивов, каждый из которых имеет текст твита и URL твита в качестве элементов.
• Цикл foreach печатает твиты.

Шаг 7: Определите конструктор класса виджетов

Конструктор класса виджета дает WordPress некоторую информацию о виджете. Имя виджета, размеры панели параметров виджета, описание, отображаемое под именем виджета на странице администрирования виджетов, все настраиваются в этой функции. Этот конструктор определяет два массива, а затем передает их родительскому классу WP_Widget .

  функция Twitter_Feed_Widget ()
 {
    $ widget_options = array (
       'Имя_класса' => 'виджет-твит',
       'description' => __ ('Этот виджет показывает канал Twitter для выбранного пользователя.')
    );
    $ control_options = array (
       'Высота' => 300,
       'ширина' => 300
    );
    $ this-> WP_Widget ('twitter_feed_widget', 'Twitter Feed Widget', $ widget_options, $ control_options);
 } 

  add_action ( "widgets_init", "myplugin_widget_init"); 

  функция myplugin_widget_init ()
 {
     register_widget ( "Twitter_Feed_Widget");
 }