| [ Index ] |
PHP Cross Reference of WordPress |
[Source view] [Print] [Project Stats]
Post format functions.
| File Size: | 267 lines (7 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
| get_post_format( $post = null ) X-Ref |
| Retrieve the format slug for a post param: int|WP_Post|null $post Optional. Post ID or post object. Defaults to the current post in the loop. return: string|false The format if successful. False otherwise. since: 3.1.0 |
| has_post_format( $format = array() X-Ref |
| Check if a post has any of the given formats, or any format. param: string|string[] $format Optional. The format or formats to check. param: WP_Post|int|null $post Optional. The post to check. Defaults to the current post in the loop. return: bool True if the post has any of the given formats (or any format, if no format specified), since: 3.1.0 |
| set_post_format( $post, $format ) X-Ref |
| Assign a format to a post param: int|object $post The post for which to assign a format. param: string $format A format to assign. Use an empty string or array to remove all formats from the post. return: array|WP_Error|false Array of affected term IDs on success. WP_Error on error. since: 3.1.0 |
| get_post_format_strings() X-Ref |
| Returns an array of post format slugs to their translated and pretty display versions return: string[] Array of post format labels keyed by format slug. since: 3.1.0 |
| get_post_format_slugs() X-Ref |
| Retrieves the array of post format slugs. return: string[] The array of post format slugs as both keys and values. since: 3.1.0 |
| get_post_format_string( $slug ) X-Ref |
| Returns a pretty, translated version of a post format slug param: string $slug A post format slug. return: string The translated post format name. since: 3.1.0 |
| get_post_format_link( $format ) X-Ref |
| Returns a link to a post format index. param: string $format The post format slug. return: string|WP_Error|false The post format term link. since: 3.1.0 |
| _post_format_request( $qvs ) X-Ref |
| Filters the request to allow for the format prefix. param: array $qvs return: array since: 3.1.0 |
| _post_format_link( $link, $term, $taxonomy ) X-Ref |
| Filters the post format term link to remove the format prefix. param: string $link param: WP_Term $term param: string $taxonomy return: string since: 3.1.0 |
| _post_format_get_term( $term ) X-Ref |
| Remove the post format prefix from the name property of the term object created by get_term(). param: object $term return: object since: 3.1.0 |
| _post_format_get_terms( $terms, $taxonomies, $args ) X-Ref |
| Remove the post format prefix from the name property of the term objects created by get_terms(). param: array $terms param: string|array $taxonomies param: array $args return: array since: 3.1.0 |
| _post_format_wp_get_object_terms( $terms ) X-Ref |
| Remove the post format prefix from the name property of the term objects created by wp_get_object_terms(). param: array $terms return: array since: 3.1.0 |
| Generated: Sun Dec 22 01:00:02 2024 | Cross-referenced by PHPXref 0.7.1 |