Featured Content.
This module will allow users to define a subset of posts to be displayed in a theme-designated featured content area.
This feature will only be activated for themes that declare that they support it. This can be done by adding code similar to the following during the "after_setup_theme" action:
add_theme_support( 'featured-content', array(
'filter' => 'mytheme_get_featured_content',
'max_posts' => 20,
'post_types' => array( 'post', 'page' ),) );
For maximum compatibility with different methods of posting users will designate a featured post tag to associate posts with. Since this tag now has special meaning beyond that of a normal tags, users will have the ability to hide it from the front-end of their site.
get_featured_posts() : array
Get featured posts
This method is not intended to be called directly. Theme developers should place a filter directly in their theme and then pass its name as a value of the "filter" key in the array passed as the $args parameter during the call to: add_theme_support( 'featured-content', $args ).
pre_get_posts(\WP_Query $query) : \WP_Query
Exclude featured posts from the blog query when the blog is the front-page.
Filter the home page posts, and remove any featured post ID's from it. Hooked onto the 'pre_get_posts' action, this changes the parameters of the query before it gets any posts.
| \WP_Query | $query |
Possibly modified WP_Query
delete_post_tag(int $tag_id) : void
Reset tag option when the saved tag is deleted.
It's important to mention that the transient needs to be deleted, too. While it may not be obvious by looking at the function alone, the transient is deleted by Featured_Content::validate_settings().
Hooks in the "delete_post_tag" action.
| int | $tag_id | The term_id of the tag that has been deleted. |
hide_featured_term(array $terms, array $taxonomies) : array
Hide featured tag from displaying when global terms are queried from the front-end.
Hooks into the "get_terms" filter.
| array | $terms | A list of term objects. This is the return value of get_terms(). |
| array | $taxonomies | An array of taxonomy slugs. |
$terms
hide_the_featured_term(array $terms, int $id, array $taxonomy) : array
Hide featured tag from displaying when terms associated with a post object are queried from the front-end.
Hooks into the "get_the_terms" filter.
| array | $terms | A list of term objects. This is the return value of get_the_terms(). |
| int | $id | The ID field for the post object that terms are associated with. |
| array | $taxonomy | An array of taxonomy slugs. |
$terms
get_setting(string $key) : mixed
Get settings
Get all settings recognized by this module. This function will return all settings whether or not they have been stored in the database yet. This ensures that all keys are available at all times.
In the event that you only require one setting, you may pass its name as the first parameter to the function and only that value will be returned.
| string | $key | The key of a recognized setting. |
Array of all settings by default. A single value if passed as first parameter.
validate_settings(array $input) : array
Validate settings
Make sure that all user supplied content is in an expected format before saving to the database. This function will also delete the transient set in Featured_Content::get_featured_content().
| array | $input |
$output