<?php
/* A brief overview of filters that are now available in Youtube Favorite Video Posts.
 *
 * These allow easy overriding of the default post title and content before the
 * new post is created.
 */

add_filter( 'yfvp_new_video_embed_code', 'myprefix_change_yfvp_post_content', 10, 1 );
/* Adds a little nonsense introduction to the video before embedding the 
 * iframe that was provided by default */
function myprefix_change_yfvp_post_content( $video_embed_code, $video_token ) {

	$new_content = 'My video post includes the token - ' . $video_token . ' - before embedding!';
	$new_content .= $video_embed_code;

	return $new_content;
}

add_filter( 'yfvp_new_video_item_title' 'myprefix_change_yfvp_post_title', 10, 1 );
/* Changes the default title from Youtube */
function myprefix_change_yfvp_post_title( $current_title ) {
	return 'This is a video: ' . $current_title;
}

Youtube Favorite Video Posts can be downloaded through the WordPress plugin repository. More info can be found through the overall project status page.

As part of that refresh, I’m hoping to use this write up as a way to further explore what’s actually going on behind the scenes.

To serve as a very brief guide, here is an example use of register_post_type(). After, I’ll dive into a few of the arguments to expand on the intent involved with each.:

<?php
/*
 * Creates a custom post type with the key 'prefix_post_type', with a basic
 * configuration that provides for public access on the front end and admin.
 *
*/
add_action( 'init', 'prefix_register_post_type' );
function prefix_register_post_types() {
	$public_pt_args = array(
		'label' => 'My Post Type',
		'public' => true,
		'publicly_queryable' => true,
		'exclude_from_search' => false,
		'show_ui' => true,
		'show_in_menu' => true,
		'has_archive' => true,
		'rewrite' => true,
		'query_var' => true,
	);
	register_post_type( 'prefix_post_type', $public_pt_args );
}

‘public’

Implies overall intent for the post type.

The word public in this case should not be confused with front-end. There is no hard definition, and a post type can be public while remaining hidden from any front-end view. The setting for public is used for admin, front-end and XML-RPC requests and should not be underestimated.

If no additional arguments are set, the value for public also helps to trigger values for publicly_queryable, exclude_from_search, show_ui, and show_in_nav_menus as such:

<?php
/* If public is not specified when registering a custom post type, false
 * is used by default. */
$non_public_pt_args = array( 'public' => false );

/* The above is the same as specifying the following. */
$non_public_pt_args = array(
	'public' => false,
	'publicly_queryable' => false,
	'exclude_from_search' => true,
	'show_ui' => false,
	'show_in_nav_menus' => false,
);

/* Setting public to true results in a different set of values */
$public_pt_args = array( 'public' => true );

/* The above is the same asa specifying the following. */
$public_pt_args = array(
	'public' => true,
	'publicly_queryable' => true,
	'exclude_from_search' => false,
	'show_ui' => true,
	'show_in_nav_menus' => true,
);

Any easy assumption to make here is that public only triggers other arguments. That is not correct. While other arguments can inherit its value, public is very much an argument on its own.

How ‘public’ is used in WordPress (as of 3.4)

• Checked for as ‘true’ during redirect_guess_404_permalink() in canonical.php if the ‘name’ query var exists without a request for ‘post_type’.
• Checked for as ‘true’ during wp_link_query() in class-wp-editor.php to provide the list of possible internal links when using WP Editor.
• Checked for as ‘true’ during _get_last_post_time() in post.php to query for the last posted post object.
• Checked for as ‘false’ when looking for lost attachments in upload.php to help exclude post types (in addition to attachments) that attachments cannont be attached to.
• Checked for as ‘true’ during find_posts_div() in template.php to help find posts that attachments can be attached to.
• Depended on when using _prepare_post_type() and wp_getPostTypes() in class-wp-xmlrpc-server.php to provide the post type’s ‘public’ status to XML-RPC requests.
• Checked for as true during wp_admin_bar_edit_menu() in wp-includes/admin-bar.php to display the ‘View Item’ link in the admin bar.
  • The show_ui argument is used for this on the front end.
• Checked for as true during redirect_canonical() in canonical.php when trying to redirect based on a valid page, post or attachment ID passed via query_var.
• Checked for as false during _update_blog_date_on_post_publish()  and _update_blog_date_on_post_delete() in ms-blogs.php to help decide whether or noth to update a site’s last updated time in a multisite environment.
• Used during edit-form-advanced.php when determining whether to show a sample permalink and the associated Edit, View Post and Get Shortlink buttons.
• Used when displaying single rows in class-wp-posts-list-table.php to determine if preview/view links should be shown .
• list still in progress, feel free to chip in…

‘publicly_queryable’

Should the post type be queried for on the front-end via parse_request()?

This is very much related to what can be seen by a user on the front-end of a WordPress installation. Most URLs associated with a post type will cause a related query_var to be available during parse_request() in order to handle the direction of the page load.

In fact, the only use of publicly_queryable in core code outside of register_post_type() is in class-wp.php as part of parse_request() when the post_type is set as a query var.

• If $query_var['post_type'] is a string and matches a post_type that is publicly_queryable, it continues.
• If $query_var['post_type'] is a string and does not match a publicly_queryable post_type, the $query_var['post_type'] is unset entirely.
• If $query_var['post_type'] is an array, it is matched with an array of post types that have publicly_queryable set to true.

If not explicitly defined, publicly_queryable inherits the public setting, which is false by default.

‘exclude_from_search’

Should the post type be available to front-end search requests?

This argument is checked for during get_posts() in query.php only if the post_type of the query is set to ‘any’. A check is done then for all post types that have ‘exclude_from_search’ set to false.

For any of the other conditions, whether multiple post types or single post types are specified, no check is done to see if should be exluded from search. This results in slightly unexpected search behavior, as seen in this document of test results.

If not explicitly defined, exclude_from_search inherits the opposite of the public setting, which results in ‘true’ by default.

‘query_var’

What should be used as the query_var key in parse_request()?

This helps control the query_var used when a URL is loaded to be processed by parse_request().

• If true, a post loaded at site/?{post_type_key}={post-slug} will be successful, as the query_var is set to the post_type key.
• If false, a post loaded at site/?{post_type_key}={post-slug} will not be successful, as the query_var is not registered for use.
• If a string, such as ‘my-cpt-slug’, is set, a post loaded at site/?my-cpt-slug={post-slug} will be successful.

By default, query_var is set to true and the key used to register the post type becomes the query_var string.

In Progress….

This is very much a work in progress, especially with the settings for public, as its value is used far more in WordPress core than I’ve been able to find so far. I’ll be updating this document as I find more examples, and would be happy to include any input. While exploring, I’ve compiled a horribly formatted document (saved as a Gist here) that attempts to provide examples for each combination of some relative arguments.

Fire away!

I tried a few things to make this work, but there are two primary issues:

1. I hook into the ‘add_attachment’ hook in WordPress. This runs immediately after an image is uploaded and the attachment data is added to the database. I can grab this data immediately, but only for the full size version of the new image. The thumbnails are crunched in the background and I haven’t yet found the right way to grab a smaller image for display. This works fine at times, but your site could quickly become bogged down with multiple 2MB files loading on your home page.
2. If I was able to solve the first issue, it would still be hard to determine what the new post content should look like. Should I only use the medium image? Should it be center aligned? The varieties are fairly endless, where as using the featured image makes the display very flexible. [what are WordPress Post Thumbnails/Featured Images?]

So with those in mind, while this request stretches the bounds of the primary purpose for the plugin, it is easy enough to provide filters to allow content to be handled on a custom basis.

With today’s update for Automatic Featured Image Posts, I’m adding 3 filters that allow you to easily set the new post title, categories, and content as you upload images. The new image will continue to be attached as the featured image for the post, but this will allow more flexibility for those who want it.

Here are a few snippets that show the filters in action. These can be added to your theme’s functions.php file, or, as is often applicable, to the child theme you have created from your primary theme of choice.

<?php
/* A brief overview of filters that are now available in Automatic Featured Image Posts.
 *
 * These allow easy overriding of the default post title, categories, and content before
 * the new post is created, while still maintaining the core priority of the plugin,
 * which is to add a new post with a featured image assigned to it */
add_filter( 'afip_new_post_title', 'myprefix_change_afip_post_title', 10, 2 );
/* Adds 'Magic Photo: ' to the front of every auto generated post tile from
 * Automatic Featured Image Posts */
function myprefix_change_afip_post_title( $post_title, $attachment_id ) {

	return 'Magic Photo: ' . $post_title;

}

add_filter( 'afip_new_post_category', 'myprefix_change_afip_post_category', 10, 2 );
/* Adds every auto generated post to the category with the slug 'photos' */
function myprefix_change_afip_post_category( $post_category, $attachment_id ) {

	$my_photo_category = get_category_by_slug( 'photos' );

	if ( is_object( $my_photo_category ) )
		$post_category[] = $my_photo_category->term_id;

	return $post_category;

}

add_filter( 'afip_new_post_content', 'myprefix_change_afip_post_content', 10, 2 );
/* Grabs the image source for the newly created image and inserts it
 * into the new post content along with a one line paragraph. */
function myprefix_change_afip_post_content( $post_content, $attachment_id ) {

	$my_uploaded_image = wp_get_attachment_image_src( $attachment_id );

	$post_content = '<p>This is my new uploaded image....</p>';
	$post_content .= '<img src="' . $my_uploaded_image[0] . '">';

	return $post_content;

}

Automatic Featured Image Posts can be downloaded through the WordPress repository. More info can be found through the overall project status page.

You’ve hooked into the appropriate core actions, loaded a template file and added a quick echo to test the beginnings of your feed. You bring up a browser, load the feed, and are satisfied when you see the output you were expecting.

Now, you code out the rest of the feed. Put in a query, loop over the results and mold your output. Sweet.

Refresh the feed in your browser and bam – same test output from before.

What the?

You hit Google and start searching. One place tells you to delete your transients, another tells you to define your own Magpie cache settings. All of them were written in 2007.

And then you run into this page, which dutifully informs you that WordPress is not caching your custom feed.

You are. In your browser. Clear the cache.

[singlepic id=5 w=600 h=450 float=left]

Our walk around Wildwood Trail and its neighbors was gorgeous, with a heavy wet snow falling most of the way. So cool to see the green moss and ferns covered with a dusting. Very much different from the snowfall on dead stuff that we grew up with in the Midwest.

[nggallery id=1]

The presence of any game reassures Rabbit. Where any game is being played a hedge exists against fury.

I haven’t exactly figured out how much that means yet, but it sounds good.

I’m not entirely sure why Skype would choose to tie up port 80 by default, as that configuration has to be so unlikely for the average user, but they do. So if you’re having trouble starting Apache, uncheck that little box first.

I wouldn’t normally create a post for this, but if you don’t get the search terms right, you run into a bunch of ‘tutorials’ that take forever to just say the words ‘Skype uses port 80′. Sometimes all you need is a little screenshot. So now this exists, and it can now provide more juice to other similarly helpful posts such as Apache and Skype from Otto, which I ran into after being amazed at the other several hundred word tutorials.