从自定义窗口小部件中将类添加到before_widget


10

我有一个简单的自定义窗口小部件,要求它的宽度(稍后在前端使用)。宽度字段是选择下拉列表,因此用户具有预定义的选项。

我将有许多小部件实例,每个实例都有自己的宽度设置。

现在,在我的小部件代码中,我有以下代码:

echo $before_widget;

结果是:

<div class="widget my" id="my-widget-1"></div>

我想做的是以某种方式挂入$before_widget并添加自己的类(从选择下拉列表中指定的宽度)。因此,我想要以下标记:

<div class="widget my col480" id="my-widget-3"></div>

如果没有指定类,那么我想添加class="col480"

我该如何实现?

感谢帮助!大沙

Answers:


14

嗯,所以$before_widget变量是一个表示div元素的字符串:<div class="widget my" id="my-widget-1">。因此,我检查了$before_widget“ class”子字符串,并在其中添加了我的$widget_width值。

该代码来自我的自定义小部件文件:

function widget( $args, $instance ) {
  extract( $args );
  ... //other code

  $widget_width = !empty($instance['widget_width']) ? $instance['widget_width'] : "col300";
  /* Add the width from $widget_width to the class from the $before widget */
  // no 'class' attribute - add one with the value of width
  if( strpos($before_widget, 'class') === false ) {
    // include closing tag in replace string
    $before_widget = str_replace('>', 'class="'. $widget_width . '">', $before_widget);
  }
  // there is 'class' attribute - append width value to it
  else {
    $before_widget = str_replace('class="', 'class="'. $widget_width . ' ', $before_widget);
  }
  /* Before widget */
  echo $before_widget;

  ... //other code
}

我想将$widget_width变量添加到我自己的窗口小部件代码中的窗口小部件div元素中(同时我可以轻松访问该$widget_width变量)。

希望这是有道理的,并将对某人有所帮助。

谢谢大沙


不错的工作-帮助我解决了小部件问题-谢谢:)
Q Studio

10

您可以使用dynamic_sidebar_params过滤器挂钩找到您的小部件并向其中添加类:

add_filter('dynamic_sidebar_params', 'add_classes_to__widget'); 
function add_classes_to__widget($params){
    if ($params[0]['widget_id'] == "my-widget-1"){ //make sure its your widget id here
        // its your widget so you add  your classes
        $classe_to_add = 'col480 whatever bla bla '; // make sure you leave a space at the end
        $classe_to_add = 'class=" '.$classe_to_add;
        $params[0]['before_widget'] = str_replace('class="',$classe_to_add,$params[0]['before_widget']);
    }
    return $params;
} 

谢谢回复。我将有很多自定义小部件的实例,每个实例都有各自的特定宽度。这就是为什么我想在小部件代码本身中添加额外的类,而不是通过过滤器。希望这有意义吗?
dashaluna 2011年

实例选项保存在选项表中,因此您可以使用get_option('widget-name')
Bainternet,2011年

1
非常感谢你的帮助!对不起,我不太了解您的解决方案:(而且,我希望所有代码都在我的自定义小部件文件中,同时我可以轻松访问width变量。我最终对$before_widget字符串进行了黑客入侵。正确的轨道,发现它$before_widget是一个字符串。再次感谢:)
dashaluna 2011年

这将是首选方法,因为它使用wordpress过滤器而不是编辑主题文件
Rhysclay

6

我发现为自定义窗口小部件添加类的另一种方法是使用构造函数的“ classname ”键,如下所示:

class My_Widget_Class extends WP_Widget {
// Prior PHP5 use the children class name for the constructor…
// function My_Widget_Class()
       function __construct() {
            $widget_ops = array(
                'classname' => 'my-class-name',
                'description' => __("Widget for the sake of Mankind",'themedomain'),
            );
            $control_ops = array(
                'id_base' => 'my-widget-class-widget'
            );
   //some more code after...

   // Call parent constructor you may substitute the 1st argument by $control_ops['id_base'] and remove the 4th.
            parent::__construct(@func_get_arg(0),@func_get_arg(1),$widget_ops,$control_ops);
        }
}

并确保在主题中使用默认的“ before_widget ”,或者如果register_sidebar()在function.php中使用,请按照以下步骤进行操作:

//This is just an example.
register_sidebar(array(
          'name'=> 'Sidebar',
            'id' => 'sidebar-default',
            'class' => '',//I never found where this is used...
            'description' => 'A sidebar for Mankind',
            'before_widget' => '<aside id="%1$s" class="widget %2$s">',//This is the important code!!
            'after_widget' => '</aside>',
            'before_title' => '<h3>',
            'after_title' => '</h3>',
        ));

然后,在小部件的每个实例上,您都将具有以下类“ widget my-class-name”:

<aside class="widget my-class-name" id="my-widget-class-widget-N"><!-- where N is a number -->
  <h3>WIDGET TITLE</h3>
  <p>WIDGET CONTENT</p>
</aside>

您也可以先调用父构造函数,然后附加所需的任何类名:

class My_Widget_Class extends WP_Widget {
    // Better defining the parent argument list …
    function __construct($id_base, $name, $widget_options = array(), $control_options = array())
    {    parent::__construct($id_base, $name, $widget_options, $control_options);
         // Change the class name after
         $this->widget_options['classname'].= ' some-extra';
    }
}

1

首先在构造函数中添加一个自定义占位符类

<?php
public function __construct() {
   $widget_ops  = array(
      'classname'                   =>; 'widget_text eaa __eaa__', //__eaa__ is my placeholder css class
      'description'                 =>; __( 'AdSense ads, arbitrary text, HTML or JS.','eaa' ),
      'customize_selective_refresh' =>; true,
   );
   $control_ops = array( 'width' =>; 400, 'height' =>; 350 );
   parent::__construct( 'eaa', __( 'Easy AdSense Ads &amp; Scripts', 'eaa' ), $widget_ops, $control_ops );
}
?>

然后根据像这样的小部件选项将其替换为您选择的类

<?php
if ( $instance['no_padding'] ) {
   $args['before_widget'] = str_replace( '__eaa__', 'eaa-clean', $args['before_widget'] );
}
?>

您可以在http://satishgandham.com/2017/03/adding-dynamic-classes-custom-wordpress-widgets/上找到示例的详细信息。


0

您可以尝试以下过滤器:

/**
 * This function loops through all widgets in sidebar 
 * and adds a admin form value to the widget as a class name  
 *  
 * @param array $params Array of widgets in sidebar
 * @return array
*/

add_filter( 'dynamic_sidebar_params', 'nen_lib_add_class_to_widget' );
function nen_lib_add_class_to_widget( $params )
{
    foreach( $params as $key => $widget )
    {
        if( !isset($widget['widget_id']) ) continue;

        // my custom function to get widget data from admin form (object)
        $widget_data = nen_get_widget_data($widget['widget_id']) ;

        // check if field excists and has value
        if( isset($widget_data->wm_name) && $widget_data->wm_name )
        {
            // convert and put value in array
            $classes = array( sanitize_title( $widget_data->wm_name ) );

            // add filter, to be able to add more
            $classes = apply_filters( 'nen_lib_add_class_to_widget' , $classes , $widget['widget_id'] , $widget , $widget_data  );

            // get 'before_widget' element, set find and replace
            $string     = $params[$key]['before_widget'];
            $find       = '"widget ';
            $replace    = '"widget '.implode( ' ' , $classes ).' ';

            // new value
            $new_before = str_replace( $find , $replace , $string ) ;

            // set new value
            $params[$key]['before_widget'] = $new_before;
        }
    }
    return $params;
}
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.