云策 WordPress 开发者社区

类文档

WP_Widget_Tag_Cloud

查看官方原文 ↗
💡 云策文档标注

概述

WP_Widget_Tag_Cloud 是 WordPress 核心类，用于实现标签云小工具。它继承自 WP_Widget，提供创建、配置和显示标签云的功能。

关键要点

  • 继承自 WP_Widget，用于构建标签云小工具。
  • 主要方法包括 __construct（构造函数）、widget（输出内容）、update（更新设置）和 form（输出设置表单）。
  • 支持自定义标题、显示计数和选择分类法（如 post_tag）。
  • 使用 wp_tag_cloud 函数生成标签云，并应用 widget_tag_cloud_args 过滤器。
  • 在更新设置时进行数据清理，如 sanitize_text_field。

代码示例

// 示例：WP_Widget_Tag_Cloud 的构造函数
public function __construct() {
    $widget_ops = array(
        'description'                 => __( 'A cloud of your most used tags.' ),
        'customize_selective_refresh' => true,
        'show_instance_in_rest'       => true,
    );
    parent::__construct( 'tag_cloud', __( 'Tag Cloud' ), $widget_ops );
}

注意事项

  • 确保主题支持 HTML5 或 XHTML 格式，以正确输出导航小工具。
  • 使用 _get_current_taxonomy 方法获取当前分类法，默认为 post_tag。
  • 在 widget 方法中，应用了 widget_title 和 navigation_widgets_format 过滤器，需注意兼容性。
📄 原文内容

Core class used to implement a Tag cloud widget.

Description

See also

Methods

Name Description
WP_Widget_Tag_Cloud::__construct Sets up a new Tag Cloud widget instance.
WP_Widget_Tag_Cloud::_get_current_taxonomy Retrieves the taxonomy for the current Tag cloud widget instance.
WP_Widget_Tag_Cloud::form Outputs the Tag Cloud widget settings form.
WP_Widget_Tag_Cloud::update Handles updating settings for the current Tag Cloud widget instance.
WP_Widget_Tag_Cloud::widget Outputs the content for the current Tag Cloud widget instance.

Source

class WP_Widget_Tag_Cloud extends WP_Widget {


	/**

	 * Sets up a new Tag Cloud widget instance.

	 *

	 * @since 2.8.0

	 */

	public function __construct() {

		$widget_ops = array(

			'description'                 => __( 'A cloud of your most used tags.' ),

			'customize_selective_refresh' => true,

			'show_instance_in_rest'       => true,

		);

		parent::__construct( 'tag_cloud', __( 'Tag Cloud' ), $widget_ops );

	}


	/**

	 * Outputs the content for the current Tag Cloud widget instance.

	 *

	 * @since 2.8.0

	 *

	 * @param array $args     Display arguments including 'before_title', 'after_title',

	 *                        'before_widget', and 'after_widget'.

	 * @param array $instance Settings for the current Tag Cloud widget instance.

	 */

	public function widget( $args, $instance ) {

		$current_taxonomy = $this->_get_current_taxonomy( $instance );


		if ( ! empty( $instance['title'] ) ) {

			$title = $instance['title'];

		} else {

			if ( 'post_tag' === $current_taxonomy ) {

				$title = __( 'Tags' );

			} else {

				$tax   = get_taxonomy( $current_taxonomy );

				$title = $tax->labels->name;

			}

		}


		$default_title = $title;


		$show_count = ! empty( $instance['count'] );


		$tag_cloud = wp_tag_cloud(

			/**

			 * Filters the taxonomy used in the Tag Cloud widget.

			 *

			 * @since 2.8.0

			 * @since 3.0.0 Added taxonomy drop-down.

			 * @since 4.9.0 Added the `$instance` parameter.

			 *

			 * @see wp_tag_cloud()

			 *

			 * @param array $args     Args used for the tag cloud widget.

			 * @param array $instance Array of settings for the current widget.

			 */

			apply_filters(

				'widget_tag_cloud_args',

				array(

					'taxonomy'   => $current_taxonomy,

					'echo'       => false,

					'show_count' => $show_count,

				),

				$instance

			)

		);


		if ( empty( $tag_cloud ) ) {

			return;

		}


		/** This filter is documented in wp-includes/widgets/class-wp-widget-pages.php */

		$title = apply_filters( 'widget_title', $title, $instance, $this->id_base );


		echo $args['before_widget'];

		if ( $title ) {

			echo $args['before_title'] . $title . $args['after_title'];

		}


		$format = current_theme_supports( 'html5', 'navigation-widgets' ) ? 'html5' : 'xhtml';


		/** This filter is documented in wp-includes/widgets/class-wp-nav-menu-widget.php */

		$format = apply_filters( 'navigation_widgets_format', $format );


		if ( 'html5' === $format ) {

			// The title may be filtered: Strip out HTML and make sure the aria-label is never empty.

			$title      = trim( strip_tags( $title ) );

			$aria_label = $title ? $title : $default_title;

			echo '<nav aria-label="' . esc_attr( $aria_label ) . '">';

		}


		echo '<div class="tagcloud">';


		echo $tag_cloud;


		echo "</div>n";


		if ( 'html5' === $format ) {

			echo '</nav>';

		}


		echo $args['after_widget'];

	}


	/**

	 * Handles updating settings for the current Tag Cloud widget instance.

	 *

	 * @since 2.8.0

	 *

	 * @param array $new_instance New settings for this instance as input by the user via

	 *                            WP_Widget::form().

	 * @param array $old_instance Old settings for this instance.

	 * @return array Settings to save or bool false to cancel saving.

	 */

	public function update( $new_instance, $old_instance ) {

		$instance             = array();

		$instance['title']    = sanitize_text_field( $new_instance['title'] );

		$instance['count']    = ! empty( $new_instance['count'] ) ? 1 : 0;

		$instance['taxonomy'] = stripslashes( $new_instance['taxonomy'] );

		return $instance;

	}


	/**

	 * Outputs the Tag Cloud widget settings form.

	 *

	 * @since 2.8.0

	 *

	 * @param array $instance Current settings.

	 */

	public function form( $instance ) {

		$title = ! empty( $instance['title'] ) ? $instance['title'] : '';

		$count = isset( $instance['count'] ) ? (bool) $instance['count'] : false;

		?>

		<p>

			<label for="<?php echo $this->get_field_id( 'title' ); ?>"></label>

			<input type="text" class="widefat" id="<?php echo $this->get_field_id( 'title' ); ?>" name="<?php echo $this->get_field_name( 'title' ); ?>" value="<?php echo esc_attr( $title ); ?>" />

		</p>

		 true ), 'object' );

		$current_taxonomy = $this->_get_current_taxonomy( $instance );


		switch ( count( $taxonomies ) ) {


			// No tag cloud supporting taxonomies found, display error message.

			case 0:

				?>

				<input type="hidden" id="<?php echo $this->get_field_id( 'taxonomy' ); ?>" name="<?php echo $this->get_field_name( 'taxonomy' ); ?>" value="" />

				<p>


				</p>


				<input type="hidden" id="<?php echo $this->get_field_id( 'taxonomy' ); ?>" name="<?php echo $this->get_field_name( 'taxonomy' ); ?>" value="<?php echo esc_attr( $taxonomy ); ?>" />


				<p>

					<label for="<?php echo $this->get_field_id( 'taxonomy' ); ?>"></label>

					<select class="widefat" id="<?php echo $this->get_field_id( 'taxonomy' ); ?>" name="<?php echo $this->get_field_name( 'taxonomy' ); ?>">

					 $tax ) : ?>

						<option value="<?php echo esc_attr( $taxonomy ); ?>" <?php selected( $taxonomy, $current_taxonomy ); ?>>

							labels->name ); ?>

						</option>


					</select>

				</p>

				 0 ) {

			?>

			<p>

				<input type="checkbox" class="checkbox" id="<?php echo $this->get_field_id( 'count' ); ?>" name="<?php echo $this->get_field_name( 'count' ); ?>" <?php checked( $count, true ); ?> />

				<label for="<?php echo $this->get_field_id( 'count' ); ?>"></label>

			</p>

			</pre><p class="wporg-dot-link-list"><a href="https://developer.wordpress.org/reference/files/wp-includes/widgets/class-wp-widget-tag-cloud.php/">View all references</a> <a href="https://core.trac.wordpress.org/browser/tags/6.9.4/src/wp-includes/widgets/class-wp-widget-tag-cloud.php#L17">View on Trac</a> <a href="https://github.com/WordPress/wordpress-develop/blob/6.9.4/src/wp-includes/widgets/class-wp-widget-tag-cloud.php#L17-L220">View on GitHub</a></p></section>


		<section class="wp-block-wporg-code-reference-related" data-nosnippet="true"><h2 id="related" class="is-toc-heading wp-block-heading has-heading-5-font-size" tabindex="-1" ><a href="#related">Related</a></h2> <section style="margin-top:var(--wp--preset--spacing--20)" class="wp-block-wporg-code-table" id="uses"><figure class="wp-block-table "><table><thead><tr><th scope="col">Uses</th><th scope="col">Description</th></tr></thead><tbody><tr class=""><td><a href="https://developer.wordpress.org/reference/classes/wp_widget/">WP_Widget</a><code>wp-includes/class-wp-widget.php


Core base class extended to register widgets.

Changelog

Version Description
2.8.0 Introduced.