coffee2code

Extended Description

<?php
// Say we're in the sidebar

// We've gotten some post object on our own.
$posts = c2c_get_random_posts(5, '');
// Inject the posts
inject_query_posts($posts);
// Now let's display them via template tags:
if (have_posts()) :
    while (have_posts()) : the_post(); ?>

        <li><a href="<?php the_permalink() ?>" rel="bookmark" title="Permanent Link to <?php the_title_attribute(); ?>"><?php the_title(); ?></a></li>

    <?php endwhile;?>
<?php endif; ?>

Installation

Template Tags

The plugin provides one template tag for use in your theme templates, functions.php, or plugins.

Functions

• <?php function inject_query_posts( $posts, $config = array(), $query_obj = null, $preserve_query_obj = true ) ?>
  Injects an array of posts into a query object as if that query object had obtained those posts via a query.

Arguments

• $posts (array)
  Array of posts to inject into the query object.

• $config (array)
  Optional. Associative array of query object variables to directly set, and their values.

• $query_obj (WP_Query|null)
  Optional. The query object to modify. If null, then the global wp_query object will be used. Pass a string or non-zero integer to have a new query object created and used.

• $preserve_query_obj (bool)
  Optional. Should the query object be re-initialized (i.e. reset) prior to injecting posts?

Examples

• (See Description section for an additional example.)

• Similar to previous example, for WP 3.0+

<?php
$posts = c2c_get_random_posts( 5, '' ); // Obtain posts via your favorite related posts, find posts, etc plugin, or via custom query
inject_query_posts( $posts );
get_template_part('loop');
?>

Filters

The plugin is further customizable via one filter. Typically, these customizations would be put into your active theme’s functions.php file, or used by another plugin.

inject_query_posts_preserve_query_obj (filter)

The ‘inject_query_posts_preserve_query_obj’ filter allows you override the value of the $preserve_query_obj argument passed to the function. This is not typical usage for most users.

Arguments:

• $preserve_query_obj (bool) : Boolean indicating if the query object was set to be preserved or not
• $query_obj (WP_Query object) : The WP_Query object passed to the inject_query_posts()

Example:

// Never preserve the condition of the WP_Query object
add_filter( 'inject_query_posts_preserve_query_obj', 'my_preserve_query_obj', 10, 2 );
function my_preserve_query_obj( $preserve_query_obj, $query_obj ) {
    return false;
}

Release Log

2.0.4

• Note compatibility through WP 3.2+
• Add link to plugin directory page to readme.txt
• Update copyright date (2012)

2.0.3

• Remove unnecessary reset of meta_query and tax_query query object variables

2.0.2

• Note compatibility through WP 3.2+
• Minor code formatting changes (spacing)
• Fix plugin homepage and author links in description in readme.txt

2.0.1

• Note compatibility through WP 3.1+
• Update copyright date (2011)

2.0

• If no query_obj is sent, use the global $wp_query object (previously used to create a new query object)
• If a not-false, non-object value is sent as $wp_query object (namely any non-empty string or non-zero integer), then create a new WP_Query object for use
• Add ability to preserve the state of the existing query_obj
  • Add $preserve_query_obj arg (optional) to inject_query_posts(), default to true
  • Add filter ‘inject_query_posts_preserve_query_obj’ that gets passed value of $preserve_query_obj
• Reset more query_obj settings
• Wrap function in if(!function_exists()) check
• Remove docs from top of plugin file (all that and more are in readme.txt)
• Minor code reformatting (spacing)
• Add PHPDoc documentation
• Note compatibility with WP 2.8+, 2.9+, 3.0+
• Update copyright date
• Add package info to top of plugin file
• Add Changelog, Filters, Template Tags, and Upgrade Notice sections to readme.txt
• Remove trailing whitespace
• Add to plugin repo

1.0

• Initial release

Copyright & Disclaimer