| Property | Type | Description | |
|---|---|---|---|
| $object_type | |||
| $vocabulary |
| Method | Description | |
|---|---|---|
|
get_by_frequency ( integer $limit = null, mixed $post_type = null, integer $min = 1, integer $max = null, mixed $search = null, $orderby = 'count', $inverse = false ) : |
Returns a list of terms from this vocabulary ordered by frequency of use on the post type specified | |
|
get_by_id ( integer $tag ) : |
Returns a Tag object based on a supplied ID | |
|
get_by_slug ( string $tag ) : |
Return a tag based on a tag's text | |
|
get_by_text ( string $tag ) : |
Return a tag based on a tag's text | |
|
get_one ( string | integer $tag ) : |
Return a tag based on an id, tag text or slug | |
| object_type ( ) : String | Returns the default type Tags uses | |
| parse_url_tags ( String $tags, $objectify = false ) : Array. | Parse tag parameters from a URL string | |
| save_associations ( $terms, $object_id, $object_type = 'post' ) : boolean. | Save the tags associated to this object into the terms and object_terms tables | |
|
search ( string $q ) : |
Return a terms that match a substring criteria | |
|
vocabulary ( ) : |
Returns the tags vocabulary |
|
public static get_by_frequency ( integer $limit = null, mixed $post_type = null, integer $min = 1, integer $max = null, mixed $search = null, $orderby = 'count', $inverse = false ) : |
||
| $limit | integer | If supplied, limits the results to the specified number |
| $post_type | mixed | If a name or id of a post type is supplied, limits the results to the terms applying to that type |
| $min | integer | If supplied, limits the results to tags associated with at least this number of posts |
| $max | integer | If supplied, limits the results to tags associated with at most this number of posts |
| $search | mixed | If supplied, limits the results to tags containing that value in their display string |
| return | A Tags instance containing the terms, each having an additional property of "count" that tells how many times the term was used | |
|
public static get_by_slug ( string $tag ) : |
||
| $tag | string | The tag slug |
| return | A Tag object | |
|
public static get_by_text ( string $tag ) : |
||
| $tag | string | The tag's text (not slug) |
| return | A Tag object | |
| public static object_type ( ) : String | ||
| return | String | The default type name |
| public static parse_url_tags ( String $tags, $objectify = false ) : Array. | ||
| $tags | String | The URL parameter string |
| return | Array. | |
| public static save_associations ( $terms, $object_id, $object_type = 'post' ) : boolean. | ||
| return | boolean. | |
|
public static vocabulary ( ) : |
||
| return | The tags vocabulary | |
