| Метод | Описание | |
|---|---|---|
| add_description_additions ( integer $id = '', object | string $term = '' ) : boolean | Determines whether to add description additions. (╯°□°）╯︵ ┻━┻ | |
| description_from_custom_field ( array $args = [], boolean $escape = true ) : string | mixed | Creates description from custom fields. | |
| escape_description ( string $description = '' ) : string | Escapes and beautifies description. | |
| generate_description ( string $description = '', array $args = [] ) : string | Creates description. Base function. | |
| generate_description_additions ( integer $id = '', object | empty $term = '', boolean $ignore = false ) : array | Generates description additions. | |
| generate_description_from_id ( array $args = [], boolean $escape = true ) : string | Generates description from content while parsing filters. | |
| generate_description_title ( integer $id = '', void | object $term = '', boolean $page_on_front = false ) : string | Generates the Title for description. | |
| generate_excerpt ( integer | string $page_id, object | null $term = '', integer $max_char_length = 155 ) | Generates the excerpt. | |
| generate_home_page_description ( boolean $custom_field = true, boolean $escape = true ) : string | Generates the home page description. | |
| get_description_separator ( ) : string | Gets Description Separator. | |
| parse_description_args ( array $args = [], array $defaults = [], boolean $get_defaults = false ) : array | Parses and sanitizes description arguments. | |
| reparse_description_args ( array $args = [] ) : array | Reparses description args. | |
| trim_excerpt ( string $excerpt, integer $excerpt_length, integer $max_char_length ) : string | Trims the excerpt by word and determines sentence stops. |
| Метод | Описание | |
|---|---|---|
| __construct ( ) | Constructor, loads parent constructor. | |
| generate_the_description ( array $args, boolean $escape = true ) : string | Generates description from content. | |
| get_custom_archive_description ( array $args ) : string | Fetch Archive Description from custom field. | |
| get_custom_homepage_description ( array $args ) : string | Fetches HomePage Description from custom field. | |
| get_custom_singular_description ( integer $id ) : string | Fetches Singular Description from custom field. |
| public description_from_custom_field ( array $args = [], boolean $escape = true ) : string | mixed | ||
| $args | array | description args : { @param int $id the term or page id. @param string $taxonomy taxonomy name. @param bool $is_home We're generating for the home page. } |
| $escape | boolean | Escape the output if true. |
| Результат | string | mixed | The description. |
| public escape_description ( string $description = '' ) : string | ||
| $description | string | The description to escape and beautify. |
| Результат | string | Escaped and beautified description. |
| public generate_description ( string $description = '', array $args = [] ) : string | ||
| $description | string | The optional description to simply parse. |
| $args | array | description args : { @param int $id the term or page id. @param string $taxonomy taxonomy name. @param bool $is_home We're generating for the home page. @param bool $get_custom_field Do not fetch custom title when false. @param bool $social Generate Social Description when true. } |
| Результат | string | The description |
| public generate_description_additions ( integer $id = '', object | empty $term = '', boolean $ignore = false ) : array | ||
| $id | integer | The post or term ID |
| $term | object | empty | The term object |
| $ignore | boolean | Whether to ignore options and filters. |
| Результат | array | : { $title => The title $on => The word separator $blogname => The blogname $sep => The separator } |
| public generate_description_from_id ( array $args = [], boolean $escape = true ) : string | ||
| $args | array | description args : { @param int $id the term or page id. @param string $taxonomy taxonomy name. @param bool $is_home We're generating for the home page. @param bool $get_custom_field Do not fetch custom title when false. @param bool $social Generate Social Description when true. } |
| $escape | boolean | Escape output when true. |
| Результат | string | $output The description. |
| protected generate_the_description ( array $args, boolean $escape = true ) : string | ||
| $args | array | description args : { @param int $id the term or page id. @param string $taxonomy taxonomy name. @param bool $is_home We're generating for the home page. @param bool $get_custom_field Do not fetch custom title when false. @param bool $social Generate Social Description when true. } |
| $escape | boolean | Whether to escape the description. NOTE: When this is false, be sure to trim the output. |
| Результат | string | The description. |
| protected get_custom_archive_description ( array $args ) : string | ||
| $args | array | |
| Результат | string | The Description |
| protected get_custom_homepage_description ( array $args ) : string | ||
| $args | array | Description args. |
| Результат | string | The Description |
| protected get_custom_singular_description ( integer $id ) : string | ||
| $id | integer | The page ID. |
| Результат | string | The Description |
| public get_description_separator ( ) : string | ||
| Результат | string | The Separator, unescaped. |
| public reparse_description_args ( array $args = [] ) : array | ||
| $args | array | required The passed arguments. |
| Результат | array | $args parsed args. |