Il Template Tag sitetree_get_hyperlist()

Un Template Tag è una funzione che può essere chiamata da qualsiasi Template File del tuo sito, solitamente per mostrarvi informazioni dinamicamente.

sitetree_get_hyperlist() è l'unico Template Tag fornito da SiteTree, e può essere usato per mostrare un'iper-lista ovunque in un Template File. La sua firma è la seguente:

function sitetree_get_hyperlist( $type, $arguments = array() );

Funziona in modo simile allo shortcode [sitetree], infatti per ciascun tipo di iper-lista un diverso insieme di argomenti si rende disponibile. Nelle successive sezioni troverai dettagli riguardo questi argomenti dinamici.

Parametri

$type

(string)(Obbligatorio) Identifica il tipo di iper-lista, ed è sempre una parola al singolare.

Valori validi: post, page, {custom_post_type_key}, post_tag, category, {custom_taxonomy_key}, author.

$arguments

(array)(Facoltativo) Collezione di coppie chiave-valore che controllano il contenuto dell'iper-lista. Per ogni valore di $type è possibile fornire al Template Tag un nuovo insieme di argomenti.

Valore Restituito

(string) L'iper-lista da visualizzare.

Argomenti Comuni a Tutti i Tipi di Iper-lista

title

Descrizione: il titolo dell'iper-lista. Il titolo viene taggato con <h3> ed incluso nel <div> contenitore che racchiude l'iper-lista.

Valore di default: il nome del tipo di contenuto, generalmente al plurale.

show_title

(true/false) Se mostrare o meno il titolo dell'iper-lista.

Valore di default: true

limit

Descrizione: il massimo numero di voci di cui deve essere composta l'iper-lista.

Valori validi: un intero positivo fino a 1000.

Valore di default: 100

Argomenti Comuni ad Iper-liste di Tipo 'post', 'page' e {custom_post_type_key}

exclude

Descrizione: lista di ID di Articoli, Pagine o Post Personalizzati da escludere dall'iper-lista — gli ID devono essere separati da virgola.

Valori validi: lista di interi positivi separati da virgola.

include_only

Descrizione: whitelist di ID. Tutti gli Articoli, Pagine o Post Personalizzati al di fuori di questa lista non vengono mostrati nell'iper-lista.

Valori validi: lista di interi positivi separati da virgola.

Quando $type è uguale a 'post'

group_by

Descrizione: indica a SiteTree se e come raggruppare gli Articoli.

Valori validi: none, date, category, author

Valore di default: none

hyperlink_group_title

(true/false) Se linkare o meno il titolo di ciascun gruppo. Perché SiteTree prenda in considerazione questo argomento, gli Articoli devono essere stati preventivamente raggruppati tramite l'argomento group_by.

Valore di default: true

order_by

Descrizione: indica a SiteTree come ordinare l'iper-lista di Articoli.

Valori validi: post_date, post_date_asc, comment_count, post_title

Valore di default: post_date

pop_stickies

(true/false) Se mantenere o meno gli Articoli in Evidenza in cima all’iper-lista.

Valore di default: false

show_excerpt

(true/false) Se visualizzare o meno un breve estratto per ogni Articolo.

Valore di default: false

excerpt_length

Descrizione: definisce il massimo numero di caratteri (spazi bianchi inclusi) di cui deve essere costituito l'estratto di ciascun Articolo. Perché SiteTree prenda in considerazione questo argomento, l'argomento show_excerpt deve essere uguale a true.

Valori validi: un intero positivo tra 50 e 300.

Valore di default: 100

show_comments_count

(true/false) Se mostrare o meno per ogni Articolo la data di pubblicazione.

Valore di default: false

Quado $type è uguale a 'page'

show_home

(true/false) Se mostrare o meno un link "Home" in cima all'iper-lista.

Valore di default: false

hierarchical

(true/false) Se mostrare o meno l'iper-lista di Pagine in modo gerarchico.

Valore di default: true

order_by

Descrizione: indica a SiteTree come ordinare l'iper-lista di Pagine.

Valori validi: menu_order, title

Valore di default: menu_order

group_by_topic

(true/false) Indica a SiteTree se raggruppare le Pagine per Topic.

Valore di default: false

show_topicless

(true/false) Indica a SiteTree se mostrare le Pagine alle quali non è stato assegnato un Topic.

Valore di default: false

exclude_children

(true/false) Se escludere o meno dall'iper-lista tutte le Pagine secondarie.

Valore di default: false

only_children_of

Descrizione: ID di una Pagina genitore. SiteTree mostrerà un'iper-lista di Pagine figlie della pagina scelta.

Valori validi: un intero positivo.

dehyperlink_parents

(true/false) Se disabilitare o meno l'hyperlinking delle Pagine genitore.

Valore di default: false

dehyperlinking_level

Descrizione: indica a SiteTree fino a quale livello di nidificazione un'iper-lista gerarchica di Pagine deve vedere le sue voci genitore de-linkate. Perché SiteTree prenda in considerazione questo argomento, l'argomento dehyperlink_parents deve essere uguale a true.

Valori validi: 0, 1, 2

Valore di default: 0

Quando $type è uguale a {custom_post_type_key}

order_by

Descrizione: indica a SiteTree come ordinare l'iper-lista di Post Personalizzati.

Valori validi: post_title, post_date, post_date_asc

Valore di default: post_title

hierarchical

(true/false) Se mostrare o meno l'iper-lista di Post Personalizzati in modo gerarchico. Questo argomento è disponibile solo per Custom Post Types gerarchici.

Valore di default: true

Quando $type è uguale a 'post_tag'

show_count

(true/false) Se mostrare o meno per ogni Tag il numero di Articoli pubblicati.

Valore di default: false

order_by

Descrizione: indica a SiteTree come ordinare l'iper-lista di Tag.

Valori validi: name, count

Valore di default: name

Quando $type è uguale a 'category'

show_count

(true/false) Se mostrare o meno per ogni Categoria il numero di Articoli pubblicati.

Valore di default: true

feed_text

Descrizione: testo del link al Feed RSS di ogni Categoria. Quando non è fornito alcun testo, il link viene nascosto.

Valore di default: stringa vuota.

hierarchical

(true/false) Se mostrare o meno l'iper-lista di Categorie in modo gerarchico.

Valore di default: true

order_by

Descrizione: indica a SiteTree come ordinare l'iper-lista di Categorie.

Valori validi: name, count

Valore di default: name

Quando $type é uguale a {custom_taxonomy_key}

order_by

Descrizione: indica a SiteTree come ordinare l'iper-lista di Termini.

Valori validi: name, count

Valore di default: name

hierarchical

(true/false) Se mostrare o meno l'iper-lista di Termini in modo gerarchico. Questo argomento è disponibile solo per Tassonomie gerarchiche.

Valore di default: true

Quando $type è uguale a 'author'

show_count

(true/false) Se mostrare o meno il numero di Articoli pubblicati da ciascun autore.

Valore di default: true

show_avatar

(true/false) Se mostrare o meno l'avatar dell'autore.

Valore di default: false

avatar_size

Descrizione: la larghezza (o altezza) in pixel dell'immagine quadrata usata come avatar. Perché SiteTree prenda in considerazione questo argomento, l'argomento show_avatar deve essere uguale a true.

Valori validi: un intero positivo tra 20 e 512.

Valore di default: 60

show_bio

(true/false) Se mostrare o meno le informazioni biografiche impostate nella pagina del profilo dell'autore.

Valore di default: false

order_by

Descrizione: indica a SiteTree come ordinare l'iper-lista di autori.

Valori validi: display_name, posts_count

Valore di default: display_name

Last update: