bp_forums_tag_heat_map

Get a heatmap of forum tags for the installation.

Description

bp_forums_tag_heat_map( (string) $args = '' ); 

A wrapper for , which provides it with BP-friendly defaults.

Parameters (1)

0. $args — Optional. (string) => ''
An array of optional arguments.

Options

  • smallest (int) => 0

    Size of the smallest link. Default: 10.

  • largest (int) => 0

    Size of the largest link. Default: 42.

  • sizing (string) => ''

    Unit for $largest and $smallest. Default: px..

array(

    /**
     * Size of the smallest link. Default: 10.
     *
     * @type int
     */
    'smallest' => 0,

    /**
     * Size of the largest link. Default: 42.
     *
     * @type int
     */
    'largest' => 0,

    /**
     * Unit for $largest and $smallest. Default: 'px'.
     *
     * @type string
     * @default ''
     */
    'sizing' => ''
);        


Usage

  1. if ( !function_exists( 'bp_forums_tag_heat_map' ) ) { 
  2. require_once '/bp-forums/bp-forums-template.php'; 
  3.  
  4. // An array of optional arguments. 
  5. $args = array( 
  6. 'smallest' => 0, 
  7. 'largest' => 0, 
  8. 'sizing' => '' 
  9. ); 
  10.  
  11. // NOTICE! Understand what this does before running. 
  12. $result = bp_forums_tag_heat_map($args); 
  13.  

Defined (1)

The function is defined in the following location(s).

/bp-forums/bp-forums-template.php  
  1. function bp_forums_tag_heat_map( $args = '' ) { 
  2. $defaults = array( 
  3. 'smallest' => '10',  
  4. 'largest' => '42',  
  5. 'sizing' => 'px',  
  6. 'limit' => '50' 
  7. ); 
  8.  
  9. $r = wp_parse_args( $args, $defaults ); 
  10. extract( $r, EXTR_SKIP ); 
  11.  
  12. bb_tag_heat_map( $smallest, $largest, $sizing, $limit );