Php Development » wordpress

Word Press Plugin API/Filter Reference

mahesh chari — Wed, 24 Mar 2010 20:26:37 +0000

Word Press Plugin API/Filter Reference and cheetsheet.

Post, Page, and Attachment Filters

Database Reads

attachment_fields_to_edit: applied to the form fields to be displayed when editing an attachment. Called in the get_attachment_fields_to_edit function. Filter function arguments: an array of form fields, the post object.

attachment_icon: applied to the icon for an attachment in the get_attachment_icon function. Filter function arguments: icon file as an HTML IMG tag, attachment ID.

attachment_innerHTML: applied to the title to be used for an attachment if there is no icon, in the get_attachment_innerHTML function. Filter function arguments: inner HTML (defaults to the title), attachment ID.

content_edit_pre: applied to post content prior to display for editing.

excerpt_edit_pre: applied to post excerpt prior to display for editing.

get_attached_file: applied to the attached file information retrieved by the get_attached_file function. Filter function arguments: file information, attachment ID.

get_enclosed: applied to the enclosures list for a post by the get_enclosed function.

get_pages: applied to the list of pages returned by the get_pages function. Filter function arguments: list of pages (each item of which contains a page data array), get_pages function argument list (telling which pages were requested).

get_pung: applied to the list of pinged URLs for a post by the get_pung function.

get_the_excerpt: applied to the post’s excerpt in the get_the_excerpt function.

get_the_guid: applied to the post’s GUID in the get_the_guid function.

get_to_ping: applied to the list of URLs to ping for a post by the get_to_ping function.

icon_dir: applied to the template’s image directory in several functions. Basically allows a plugin to specify that icons for MIME types should come from a different location.

icon_dir_uri: applied to the template’s image directory URI in several functions. Basically allows a plugin to specify that icons for MIME types should come from a different location.

prepend_attachment: applied to the HTML to be prepended by the prepend_attachment function.

sanitize_title: applied to a post title by the sanitize_title function, after stripping out HTML tags.

single_post_title: applied to the post title when used to create a blog page title by the wp_title and single_post_title functions.

the_content: applied to the post content retrieved from the database, prior to printing on the screen (also used in some other operations, such as trackbacks).

the_content_rss: applied to the post content prior to including in an RSS feed.

the_editor_content: applied to post content before putting it into a rich editor window.

the_excerpt: applied to the post excerpt (or post content, if there is no excerpt) retrieved from the database, prior to printing on the screen (also used in some other operations, such as trackbacks).

the_excerpt_rss: applied to the post excerpt prior to including in an RSS feed.

the_tags: applied to the tags retrieved from the database, prior to printing on the screen.

the_title: applied to the post title retrieved from the database, prior to printing on the screen (also used in some other operations, such as trackbacks).

the_title_rss: applied to the post title before including in an RSS feed (after first filtering with the_title.

title_edit_pre: applied to post title prior to display for editing.

wp_dropdown_pages: applied to the HTML dropdown list of WordPress pages generated by the wp_dropdown_pages function.

wp_list_pages: applied to the HTML list generated by the wp_list_pages function.

wp_list_pages_excludes: applied to the list of excluded pages (an array of page IDs) in the wp_list_pages function.

wp_get_attachment_metadata: applied to the attachment metadata retrieved by the wp_get_attachment_metadata function. Filter function arguments: meta data, attachment ID.

wp_get_attachment_thumb_file: applied to the attachment thumbnail file retrieved by the wp_get_attachment_thumb_file function. Filter function arguments: thumbnail file, attachment ID.

wp_get_attachment_thumb_url: applied to the attachment thumbnail URL retrieved by the wp_get_attachment_thumb_URL function. Filter function arguments: thumbnail URL, attachment ID.

wp_get_attachment_url: applied to the attachment URL retrieved by the wp_get_attachment_url function. Filter function arguments: URL, attachment ID.

wp_mime_type_icon: applied to the MIME type icon for an attachment calculated by the wp_mime_type_icon function. Filter function arguments: icon URI calculated, MIME type, post ID.

wp_title: applied to the blog page title before sending to the browser in the wp_title function.

Database Writes

add_ping: applied to the new value of the pinged field on a post when a ping is added, prior to saving the new information in the database.

attachment_fields_to_save: applied to fields associated with an attachment prior to saving them in the database. Called in the media_upload_form_handler function. Filter function arguments: an array of post attributes, an array of attachment fields including the changes submitted from the form.

attachment_max_dims: applied to the maximum image dimensions before reducing an image size. Filter function input (and return value) is either false (if no maximum dimensions have been specified) or a two-item list (width, height).

category_save_pre: applied to post category comma-separated list prior to saving it in the database (also used for attachments).

comment_status_pre: applied to post comment status prior to saving it in the database (also used for attachments).

content_filtered_save_pre: applied to filtered post content prior to saving it in the database (also used for attachments).

content_save_pre: applied to post content prior to saving it in the database (also used for attachments).

excerpt_save_pre: applied to post excerpt prior to saving it in the database (also used for attachments).

name_save_pre: applied to post name prior to saving it in the database (also used for attachments).

phone_content: applied to the content of a post submitted by email, before saving.

ping_status_pre: applied to post ping status prior to saving it in the database (also used for attachments).

post_mime_type_pre: applied to the MIME type for an attachment prior to saving it in the database.

status_save_pre: applied to post status prior to saving it in the database.

thumbnail_filename: applied to the file name for the thumbnail when uploading an image.

wp_thumbnail_creation_size_limit: applied to the size of the thumbnail when uploading an image. Filter function arguments: max file size, attachment ID, attachment file name.

wp_thumbnail_max_side_length: applied to the size of the thumbnail when uploading an image. Filter function arguments: image side max size, attachment ID, attachment file name.

title_save_pre: applied to post title prior to saving it in the database (also used for attachments).

update_attached_file: applied to the attachment information prior to saving in post metadata in the update_attached_file function. Filter function arguments: attachment information, attachment ID.

wp_delete_file: applied to an attachment file name just before deleting.

wp_generate_attachment_metadata: applied to the attachment metadata array before saving in the database.

wp_update_attachment_metadata: applied to the attachment metadata just before saving in the wp_update_attachment_metadata function. Filter function arguments: meta data, attachment ID.

Comment, Trackback, and Ping Filters

comment_excerpt: applied to the comment excerpt by the comment_excerpt function. See also get_comment_excerpt.

comment_flood_filter: applied when someone appears to be flooding your blog with comments. Filter function arguments: already blocked (true/false, whether a previous filtering plugin has already blocked it; set to true and return true to block this comment in a plugin), time of previous comment, time of current comment.

comment_post_redirect: applied to the redirect location after someone adds a comment. Filter function arguments: redirect location, comment info array.

comment_text: applied to the comment text before displaying on the screen by the comment_text function, and in the admin menus.

comment_text_rss: applied to the comment text prior to including in an RSS feed.

comments_array: applied to the array of comments for a post in the comments_template function. Filter function arguments: array of comment information structures, post ID.

comments_number: applied to the formatted text giving the number of comments generated by the comments_number function. See also get_comments_number.

get_comment_excerpt: applied to the comment excerpt read from the database by the get_comment_excerpt function (which is also called by comment_excerpt. See also comment_excerpt.

get_comment_ID: applied to the comment ID read from the global $comments variable by the get_comment_ID function.

get_comment_text: applied to the comment text of the current comment in the get_comment_text function, which is also called by the comment_text function.

get_comment_type: applied to the comment type (“comment”, “trackback”, or “pingback”) by the get_comment_type function (which is also called by comment_type).

get_comments_number: applied to the comment count read from the $post global variable by the get_comments_number function (which is also called by the comments_number function; see also comments_number filter).

post_comments_feed_link: applied to the feed URL generated for the comments feed by the comments_rss function.

Database Writes

comment_save_pre: applied to the comment data just prior to updating/editing comment data. Function arguments: comment data array, with indices “comment_post_ID”, “comment_author”, “comment_author_email”, “comment_author_url”, “comment_content”, “comment_type”, and “user_ID”.

pre_comment_approved: applied to the current comment’s approval status (true/false) to allow a plugin to override. Return true/false and set first argument to true/false to approve/disapprove the comment, and use global variables such as $comment_ID to access information about this comment.

pre_comment_content: applied to the content of a comment prior to saving the comment in the database.

preprocess_comment: applied to the comment data prior to any other processing, when saving a new comment in the database. Function arguments: comment data array, with indices “comment_post_ID”, “comment_author”, “comment_author_email”, “comment_author_url”, “comment_content”, “comment_type”, and “user_ID”.

wp_insert_post_data: applied to modified and unmodified post data in wp_insert_post() prior to update or insertion of post into database. Function arguments: modified and extended post array and sanitized post array.

Category Filters

category_description: applied to the “description” field categories by the category_description and wp_list_categories functions. Filter function arguments: description, category ID when called from category_description; description, category information array (all fields from the category table for that particular category) when called from wp_list_categories (sorry, but that’s how it is).

category_feed_link: applied to the feed URL generated for the category feed by the get_category_rss_link function.

category_link: applied to the URL created for a category by the get_category_link function. Filter function arguments: link URL, category ID.

get_categories: applied to the category list generated by the get_categories function (which is in turn used by many other functions). Filter function arguments: category list, get_categories options list.

get_category: applied to the category information that the get_category function looks up, which is basically an array of all the fields in WordPress’s category table for a particular category ID.

list_cats: called for two different purposes:

list_cats_exclusions: applied to the SQL WHERE statement giving the categories to be excluded by the get_categories function. Typically, a plugin would add to this list, in order to exclude certain categories or groups of categories from category lists. Filter function arguments: excluded category WHERE clause, get_categories options list.

single_cat_title: applied to the category name when used to create a blog page title by the wp_title and single_cat_title functions.

the_category: applied to the list of categories (an HTML list with links) created by the get_the_category_list function. Filter function arguments: generated HTML text, list separator being used (empty string means it is a default LI list), parents argument to get_the_category_list.

the_category_rss: applied to the category list (a list of category XML elements) for a post by the get_the_category_rss function, before including in an RSS feed. Filter function arguments are the list text and the type (“rdf” or “rss” generally).

wp_dropdown_cats: applied to the drop-down category list (a text string containing HTML option elements) generated by the wp_dropdown_categories function.

wp_list_categories: applied to the category list (an HTML list) generated by the wp_list_categories function.

Database Writes

pre_category_description: applied to the category desription prior to saving in the database.

pre_category_name: applied to the category name prior to saving in the database.

pre_category_nicename: applied to the category nice name prior to saving in the database.

Link Filters

attachment_link: applied to the calculated attachment permalink by the get_attachment_link function. Filter function arguments: link URL, attachment ID.

author_feed_link: applied to the feed URL generated for the author feed by the get_author_rss_link function.

author_link: applied to the author’s archive permalink created by the get_author_posts_url function. Filter function arguments: link URL, author’s “nice” name, author ID. Note that get_author_posts_url is called within functions wp_list_authors and the_author_posts_link.

comment_reply_link: applied to the link generated for replying to a specific comment by the get_comment_reply_link function which is called within function comments_template. Filter function arguments: link (string), custom options (array), current comment (object), current post (object).

day_link: applied to the link URL for a daily archive by the get_day_link function. Filter function arguments: URL, year, month number, day number.

feed_link: applied to the link URL for a feed by the get_feed_link function. Filter function arguments: URL, type of feed (e.g. “rss2″, “atom”, etc.).

get_comment_author_link: applied to the HTML generated for the author’s link on a comment, in the get_comment_author_link function (which is also called by comment_author_link. Action function arguments: user name

get_comment_author_url_link: applied to the HTML generated for the author’s lnik on a comment, in the get_comment_author_url_link function (which is also called by comment_author_link).

month_link: applied to the link URL for a monthly archive by the get_month_link function. Filter function arguments: URL, year, month number.

page_link: applied to the calculated page URL by the get_page_link function. Filter function arguments: URL, page ID. Note that there is also an internal filter called _get_page_link that can be used to filter the URLS of pages that are not designated as the blog’s home page (same arguments).

post_link: applied to the calculated post permalink by the get_permalink function, which is also called by the the_permalink, post_permalink, previous_post_link, and next_post_link functions. Filter function arguments: permalink URL, post data list.

the_permalink: applied to the permalink URL for a post prior to printing by function the_permalink.

year_link: applied to the link URL for a yearly archive by the get_year_link function. Filter function arguments: URL, year.

tag_link: applied to the URL created for a tag by the get_tag_link function. Filter function arguments: link URL, tag ID.

Date and Time Filters

get_comment_date: applied to the formatted comment date generated by the get_comment_date function (which is also called by comment_date).

get_comment_time: applied to the formatted comment time in the get_comment_time function (which is also called by comment_time).

get_the_modified_date: applied to the formatted post modification date generated by the get_the_modified_date function (which is also called by the the_modified_date function).

get_the_modified_time: applied to the formatted post modification time generated by the get_the_modified_time and get_post_modified_time functions (which are also called by the the_modified_time function).

get_the_time: applied to the formatted post time generated by the get_the_time and get_post_time functions (which are also called by the the_time function).

the_date: applied to the formatted post date generated by the the_date function.

the_modified_date: applied to the formatted post modification date generated by the the_modified_date function.

the_modified_time: applied to the formatted post modification time generated by the the_modified_time function.

the_time: applied to the formatted post time generated by the the_time function.

the_weekday: applied to the post date weekday name generated by the the_weekday function.

the_weekday_date: applied to the post date weekday name generated by the the_weekday_date function. Function arguments are the weekday name, before text, and after text (before text and after text are added to the weekday name if the current post’s weekday is different from the previous post’s weekday).

Author and User Filters

login_redirect: applied to the redirect_to post/get variable during the user login process.

Database Reads

author_email: applied to the comment author’s email address retrieved from the database by the comment_author_email function. See also get_comment_author_email.

comment_author: applied to the comment author’s name retrieved from the database by the comment_author function. See also get_comment_author.
comment_author_rss: applied to the comment author’s name prior to including in an RSS feed.

comment_email: applied to the comment author’s email address retrieved from the database by the comment_author_email_link function.

comment_url: applied to the comment author’s URL retrieved from the database by the comment_author_url function (see also get_comment_author_url).

get_comment_author: applied to the comment author’s name retrieved from the database by get_comment_author, which is also called by comment_author. See also comment_author.

get_comment_author_email: applied to the comment author’s email address retrieved from the database by get_comment_author_email, which is also called by comment_author_email. See also author_email.

get_comment_author_IP: applied to the comment author’s IP address retrieved from the database by the get_comment_author_IP function, which is also called by comment_author_IP.

get_comment_author_url: applied to the comment author’s URL retrieved from the database by the get_comment_author_url function, which is also called by comment_author_url. See also comment_url.

login_errors: applied to the login error message printed on the login screen.

login_headertitle: applied to the title for the login header URL (Powered by WordPress by default) printed on the login screen.

login_headerurl: applied to the login header URL (points to wordpress.org by default) printed on the login screen.

login_message: applied to the login message printed on the login screen.

role_has_cap: applied to a role’s capabilities list in the WP_Role->has_cap function. Filter function arguments are the capabilities list to be filtered, the capability being questioned, and the role’s name.

sanitize_user: applied to a user name by the sanitize_user function. Filter function arguments: user name (after some cleaning up), raw user name, strict (true or false to use strict ASCII or not).

the_author: applied to a post author’s displayed name by the get_the_author function, which is also called by the the_author function.

the_author_email: applied to a post author’s email address by the the_author_email function.

Database Writes

pre_comment_author_email: applied to a comment author’s email address prior to saving the comment in the database.

pre_comment_author_name: applied to a comment author’s user name prior to saving the comment in the database.

pre_comment_author_url: applied to a comment author’s URL prior to saving the comment in the database.

pre_comment_user_agent: applied to the comment author’s user agent prior to saving the comment in the database.

pre_comment_user_ip: applied to the comment author’s IP address prior to saving the comment in the database.

pre_user_id: applied to the comment author’s user ID prior to saving the comment in the database.

pre_user_description: applied to the user’s description prior to saving in the database.

pre_user_display_name: applied to the user’s displayed name prior to saving in the database.

pre_user_email: applied to the user’s email address prior to saving in the database.

pre_user_first_name: applied to the user’s first name prior to saving in the database.

pre_user_last_name: applied to the user’s last name prior to saving in the database.

pre_user_login: applied to the user’s login name prior to saving in the database.

pre_user_nicename: applied to the user’s “nice name” prior to saving in the database.

pre_user_nickname: applied to the user’s nickname prior to saving in the database.

pre_user_url: applied to the user’s URL prior to saving in the database.

registration_errors: applied to the list of registration errors generated while registering a user for a new account.

user_registration_email: applied to the user’s email address read from the registration page, prior to trying to register the person as a new user.

validate_username: applied to the validation result on a new user name. Filter function arguments: valid (true/false), user name being validated.

Blog Information and Option Filters

all_options: applied to the option list retrieved from the database by the get_alloptions function.

bloginfo: applied to the blog option information retrieved from the database by the bloginfo function, after first retrieving the information with the get_bloginfo function. A second argument $show gives the name of the bloginfo option that was requested. Note that bloginfo("url"), bloginfo("directory") and bloginfo("home") do not use this filtering function (see bloginfo_url).

bloginfo_rss: applied to the blog option information by function get_bloginfo_rss (which is also called from bloginfo_rss), after first retrieving the information with the get_bloginfo function, stripping out HTML tags, and converting characters appropriately. A second argument $show gives the name of the bloginfo option that was requested.

bloginfo_url: applied to the the output of bloginfo("url"), bloginfo("directory") and bloginfo("home") before returning the information.

loginout: applied to the HTML link for logging in and out (generally placed in the sidebar) generated by the wp_loginout function.

option_(option name): applied to the option value retrieved from the database by the get_option function, after unserializing (which decodes array-based options). To use this filter, you will need to add filters for specific options names, such as “option_foo” to filter the output of get_option("foo").

pre_option_(option name): applied to the option value retrieved from the database by the get_alloptions function, after unserializing (which decodes array-based options). To use this filter, you will need to add filters for specific options names, such as “pre_option_foo” to filter the option “foo”.

register: applied to the sidebar link created for the user to register (if allowed) or visit the admin panels (if already logged in) by the wp_register function.

upload_dir: applied to the directory to be used for uploads calculated by the wp_upload_dir function. Filter function argument is an array with components “dir” (the upload directory path), “url” (the URL of the upload directory), and “error” (which you can set to true if you want to generate an error).

upload_mimes: allows a filter function to return a list of MIME types for uploads, if there is no MIME list input to the wp_check_filetype function. Filter function argument is an associated list of MIME types whose component names are file extensions (separated by vertical bars) and values are the corresponding MIME types.

General Text Filters

attribute_escape: applied to post text and other content by the attribute_escape function, which is called in many places in WordPress to change certain characters into HTML attributes before sending to the browser.

js_escape: applied to JavaScript code before sending to the browser in the js_escape function.

Administrative Filters

autosave_interval: applied to the interval for auto-saving posts.

cat_rows: applied to the category rows HTML generated for managing categories in the admin menus.

comment_edit_pre: applied to comment content prior to display in the editing screen.

comment_edit_redirect: applied to the redirect location after someone edits a comment in the admin menus. Filter function arguments: redirect location, comment ID.

comment_moderation_subject: applied to the mail subject before sending email notifying the administrator of the need to moderate a new comment. Filter function arguments: mail subject, comment ID. Note that this happens inside the default wp_notify_moderator function, which is a “pluggable” function, meaning that plugins can override it; see Plugin API).

comment_moderation_text: applied to the body of the mail message before sending email notifying the administrator of the need to moderate a new comment. Filter function arguments: mail body text, comment ID. Note that this happens inside the default wp_notify_moderator function, which is a “pluggable” function, meaning that plugins can override it; see Plugin API).

comment_notification_headers: applied to the mail headers before sending email notifying the post author of a new comment. Filter function arguments: mail header text, comment ID. Note that this happens inside the default wp_notify_postauthor function, which is a “pluggable” function, meaning that plugins can override it; see Plugin API).

comment_notification_subject: applied to the mail subject before sending email notifying the post author of a new comment. Filter function arguments: mail subject, comment ID. Note that this happens inside the default wp_notify_postauthor function, which is a “pluggable” function, meaning that plugins can override it; see Plugin API).

comment_notification_text: applied to the body of the mail message before sending email notifying the post author of a new comment. Filter function arguments: mail body text, comment ID. Note that this happens inside the default wp_notify_postauthor function, which is a “pluggable” function, meaning that plugins can override it; see Plugin API).

cron_schedules: applied to an empty array to allow a plugin to generate cron schedules in the wp_get_schedules function.

custom_menu_order: used to activate the ‘menu_order’ filter.

default_content: applied to the default post content prior to opening the editor for a new post.

default_excerpt: applied to the default post excerpt prior to opening the editor for a new post.

default_title: applied to the default post title prior to opening the editor for a new post.

editable_slug: applied to the post, page, tag or category slug by the get_sample_permalink function.

explain_nonce_(verb)-(noun): allows a filter function to define text to be used to explain a nonce that is otherwise not explained by the WordPress core code. You will need to define specific verb/noun filters to use this. For instance, if your plugin defines a nonce for updating a tag, you would define a filter for “explain_nonce_update-tag”. Filter function arguments: text to display (defaults to a generic “Are you sure you want to do this?” message) and extra information from the end of the action URL. In the example here, your function might simply return the string “Are you sure you want to update this tag?”.

format_to_edit: applied to post content, excerpt, title, and password by the format_to_edit function, which is called by the admin menus to set up a post for editing. Also applied to when editing comments in the admin menus.

format_to_post: applied to post content by the format_to_post function, which is not used in WordPress by default.

manage_link-manager_columns: was manage_link_columns until wordpress 2.7. applied to the list of columns to print on the blogroll management screen. Filter function argument/return value is an associative list where the element key is the name of the column, and the value is the header text for that column. See also action manage_link_custom_column, which puts the column information into the edit screen.

manage_posts_columns: applied to the list of columns to print on the manage posts screen. Filter function argument/return value is an associative array where the element key is the name of the column, and the value is the header text for that column. See also action manage_posts_custom_column, which puts the column information into the edit screen. (see Scompt’s tutorial for examples and use.)

manage_pages_columns: applied to the list of columns to print on the manage pages screen. Filter function argument/return value is an associative array where the element key is the name of the column, and the value is the header text for that column. See also action manage_pages_custom_column, which puts the column information into the edit screen.

menu_order: applied to the array for the admin menu order. Must be activated with the ‘custom_menu_order’ filter before.

postmeta_form_limit: applied to the number of post-meta information items shown on the post edit screen.

pre_upload_error: applied to allow a plugin to create an XMLRPC error for uploading files.

preview_page_link: applied to the link on the page editing screen that shows the page preview at the bottom of the screen.

preview_post_link: applied to the link on the post editing screen that shows the post preview at the bottom of the screen.

richedit_pre: applied to post content by the wp_richedit_pre function, before displaying in the rich text editor.

show_password_fields: applied to the true/false variable that controls whether the user is presented with the opportunity to change their password on the user profile screen (true means to show password changing fields; false means don’t).

the_editor: applied to the HTML DIV created to house the rich text editor, prior to printing it on the screen. Filter function argument/return value is a string.

user_can_richedit: applied to the calculation of whether the user’s browser has rich editing capabilities, and whether the user wants to use the rich editor, in the user_can_richedit function. Filter function argument and return value is true/false if the current user can/cannot use the rich editor.

user_has_cap: applied to a user’s capabilities list in the WP_User->has_cap function (which is called by the current_user_can function). Filter function arguments are the capabilities list to be filtered, the capability being questioned, and the argument list (which has things such as the post ID if the capability is to edit posts, etc.)

wp_handle_upload: applied to the upload information when uploading a file. Filter function argument: array with elements “file” (file name), “url”, “type”.

wp_upload_tabs: applied to the list of custom tabs to display on the upload management admin screen. Use action upload_files_(tab) to display a page for your custom tab (see Plugin API/Action Reference).

Rich Text Editor Filters

mce_spellchecker_languages: applied to the language selection available in the spell checker.

mce_buttons, mce_buttons_2, mce_buttons_3, mce_buttons_4: applied to the rows of buttons for the rich editor toolbar (each is an array of button names).

mce_css: applied to the CSS file URL for the rich text editor.

mce_external_plugins: applied to the array of external plugins to be loaded by the rich text editor.

mce_external_languages: applied to the array of language files loaded by external plugins, allowing them to use the standard translation method (see tinymce/langs/wp-langs.php for reference).

tiny_mce_before_init: applied to the whole init array for the editor.

Template Filters

kubrick_header_color: applied to the color for the header of the default theme.

kubrick_header_display: applied to the display option for the header of the default theme.

kubrick_header_image: applied to the header image file for the default theme.

locale_stylesheet_uri: applied to the locale-specific stylesheet URI returned by the get_locale_stylesheet_uri function. Filter function arguments: URI, stylesheet directory URI.

stylesheet: applied to the stylesheet returned by the get_stylesheet function.

stylesheet_directory: applied to the stylesheet directory returned by the get_stylesheet_directory function. Filter function arguments: stylesheet directory, stylesheet.

stylesheet_directory_uri: applied to the stylesheet directory URI returned by the get_stylesheet_directory_uri function. Filter function arguments: stylesheet directory URI, stylesheet.

stylesheet_uri: applied to the stylesheet URI returned by the get_stylesheet_uri function. Filter function arguments: stylesheet URI, stylesheet.

template: applied to the template returned by the get_template function.

template_directory: applied to the template directory returned by the get_template_directory function. Filter function arguments: template directory, template.

template_directory_uri: applied to the template directory URI returned by the get_template_directory_uri function. Filter function arguments: template directory URI, template.

theme_root: applied to the theme root directory (normally wp-content/themes) returned by the get_theme_root function.

theme_root_uri

applied to the theme root directory URI returned by the get_theme_root_uri function. Filter function arguments: URI, site URL.

You can also replace individual template files from your theme, by using the following filter hooks. See also the template_redirect action hook. Each of these filters takes as input the path to the corresponding template file in the current theme. A plugin can modify the file to be used by returning a new path to a template file.

404_template

archive_template

attachment_template

author_template
category_template
comments_popup_template
comments_template
date_template
home_template
page_template
paged_template
search_template
single_template

Advanced WordPress Filters

author_rewrite_rules: applied to the author-related rewrite rules after they are generated.

category_rewrite_rules: applied to the category-related rewrite rules after they are generated.

comments_rewrite_rules: applied to the comment-related rewrite rules after they are generated.

create_user_query: applied to the query used to save a new user’s information to the database, just prior to running the query.

date_rewrite_rules: applied to the date-related rewrite rules after they are generated.

found_posts: applied to the list of posts, just after querying from the database.

found_posts_query: after the list of posts to display is queried from the database, WordPress selects rows in the query results. This filter allows you to do something other than SELECT FOUND_ROWS() at that step.

get_editable_authors: applied to the list of post authors that the current user is authorized to edit in the get_editable_authors function.

gettext: applied to the translated text by the __ and _e internationalization functions. Filter function arguments: translated text and untranslated text. Only gets applied if internationalization is in effect, and if the text domain has been loaded.

get_next_post_join: in function get_next_post (which finds the post after the currently-displayed post), applied to the SQL JOIN clause (which normally joins to the category table if user is viewing a category archive). Filter function arguments: JOIN clause, stay in same category (true/false), list of excluded categories.

get_next_post_sort: in function get_next_post (which finds the post after the currently-displayed post), applied to the SQL ORDER BY clause (which normally orders by post date in ascending order with a limit of 1 post). Filter function arguments: ORDER BY clause.

get_next_post_where: in function get_next_post (which finds the post after the currently-displayed post), applied to the SQL WHERE clause (which normally looks for the next dated published post). Filter function arguments: WHERE clause, stay in same category (true/false), list of excluded categories.

get_others_drafts: applied to the query that selects the other users’ drafts for display in the admin menus.

get_previous_post_join: in function get_previous_post (which finds the post before the currently-displayed post), applied to the SQL JOIN clause (which normally joins to the category table if user is viewing a category archive). Filter function arguments: join clause, stay in same category (true/false), list of excluded categories.

get_previous_post_sort: in function get_previous_post (which finds the post before the currently-displayed post), applied to the SQL ORDER BY clause (which normally orders by post date in descending order with a limit of 1 post). Filter function arguments: ORDER BY clause.

get_previous_post_where: in function get_previous_post (which finds the post before the currently-displayed post), applied to the SQL WHERE clause (which normally looks for the previous dated published post). Filter function arguments: WHERE clause, stay in same category (true/false), list of excluded categories.

get_users_drafts: applied to the query that selects the users’ drafts for display in the admin menus.

locale: applied to the locale by the get_locale function.

mod_rewrite_rules: applied to the list of rewrite rules given to the user to put into their .htaccess file when they change their permalink structure. (Note: replaces deprecated filter rewrite_rules.)

post_limits: applied to the LIMIT clause of the query that returns the post array.

posts_distinct: allows a plugin to add a DISTINCTROW clause to the query that returns the post array.

posts_fields: applied to the field list for the query that returns the post array.

posts_groupby: applied to the GROUP BY clause of the query that returns the post array (normally empty).

posts_join_paged: applied to the JOIN clause of the query that returns the post array, after the paging is calculated (though paging does not affect the JOIN, so this is actually equivalent to posts_join).

posts_orderby: applied to the ORDER BY clause of the query that returns the post array.

posts_request: applied to the entire SQL query that returns the post array, just prior to running the query.

post_rewrite_rules: applied to the post-related rewrite rules after they are generated.

root_rewrite_rules: applied to the root-level rewrite rules after they are generated.

page_rewrite_rules: applied to the page-related rewrite rules after they are generated.

posts_where_paged: applied to the WHERE clause of the query that returns the post array, after the paging is calculated (though paging does not affect the WHERE, so this is actually equivalent to posts_where).

posts_join: applied to the JOIN clause of the query that returns the post array. This is typically used to add a table to the JOIN, in combination with the posts_where filter.

posts_where: applied to the WHERE clause of the query that returns the post array.

query: applied to all queries (at least all queries run after plugins are loaded).

query_string: deprecated – use query_vars or request instead.
query_vars: applied to the list of public WordPress query variables before the SQL query is formed. Useful for removing extra permalink information the plugin has dealt with in some other manner.

request: like query_vars, but applied after “extra” and private query variables have been added.

rewrite_rules_array: applied to the entire rewrite rules array after it is generated.

search_rewrite_rules: applied to the search-related rewrite rules after they are generated.

the_posts: applied to the list of posts queried from the database after minimal processing for permissions and draft status on single-post pages.

excerpt_length: Defines the lenght of a single-post excerpt.

excerpt_more: Defines the more string at the end of the excerpt.

update_user_query: applied to the update query used to update user information, prior to running the query.

wp_redirect: applied to a redirect URL by the default wp_redirect function. Filter function arguments: URL, HTTP status code. Note that wp_redierct is also a “pluggable” function, meaning that plugins can override it).

xmlrpc_methods: applied to list of defined XMLRPC methods for the XMLRPC server.

wp_mail_from: applied before any mail is sent by the wp_mail function. Supplied value is the calculated from address which is wordpress at the current hostname (set by $_SERVER['SERVER_NAME']). The filter should return an email address or name/email combo in the form “user@example.com” or “Name ” (without the quotes!).

wp_mail_from_name: applied before any mail is sent by the wp_mail function. The filter should return a name string to be used as the email from name.

Add theme page option menu

mahesh chari — Wed, 24 Mar 2010 14:34:36 +0000

Adding sub menu our word press theme to word press admin panel

We have already learned that how to add all available menu ,sub menu to word press plug in.
Now we learn how to add our themes option menu to word press admin panel.

You must aware some knowledge on developing word press theme.

Word press template tags.
word press theme file structure.
Little bit php concepts.

From above specifications word press template comes with main file “functions.php“, that synchronize word press core and template.And add below code to that file.

add_action( 'admin_menu', 'myThemeMenu' );
 
function myThemeMenu(){
//global theme name stored in this variable
global $ThemeName;
 
//add this menu to our theme edit page
add_theme_page( $ThemeName . ' Theme Options', $ThemeName . ' Options', 'edit_themes',
 basename(__FILE__), 'myThemePage' );
 
}
 
//wat ever you want to change the theme settings here.
//this function was called when user clicks on the 
//theme edit link on appearence admin panel
function myThemePage {
echo 'My Theme Options Page ,we can add any options to change our theme settings.
';
}

Above code comments tells the concept of each line . Now you can see the options on appearance admin panel.

Fore example your theme name is My-theme,then you see My-theme options link on the appearance admin panel.

first step to developing word press plugin

mahesh chari — Tue, 23 Mar 2010 19:39:40 +0000

Very Basic first step to write a word press plug in

To start our first plug in ,first we must have a plan what our plug in do on blog. However this topic we continue on later. To write a plug in ,we have to get idea of our plugin name that suggests to it.Here we write a plugin that filters the post or page title and content.
That replaces “hello” to “hello Mahesh world”.And i named it my-plugin

Download Demo

Manage Files

create a folder called “my-plugin” in the word press plugin directory.

Add a file called “my-plugin.php” and code in that is just PHP tags.

Remember plugin directory and plugin name should be same.

?>

After Adding code go to your admin panel and click the link installed on the All tab of plugins we don’t get our plug in listed there!!!.

Getting listed our plug in on the plug ins page

Yes,absolutely we didn’t great job by adding only file . To get listed we have to add a plug in description and its name.Add below comment code to your plug in page.

/*
Plugin Name: My Plugin
Plugin URI: http://maheshchari.com/
Description: Description of my plugin
Author URI: http://maheshchari.com/
*/

Adding functionality to plug in

Here plugin works as filtering post content and post title while it displayed. Logic is simple for that we use str_replace function.
Word press had to action filters for displaying title,content . they are the_content,the_title.we add our function to this filters by default priority.

 
/*
Plugin Name: My Plugin
Plugin URI: http://maheshchari.com/
Description: Description of my plugin
Author URI: http://maheshchari.com/
*/
 
function my_plugin_filter($text){
$text=str_replace('Hello','hello Mahesh',$text);
return $text;
}
 
add_filter('the_content','my_plugin_filter');
add_filter('the_title','my_plugin_filter');
 
?>

Testing plug in

Now we add a post that contains Hello word in the post title and in the content of it.
It shows this word as Hello Mahesh on title and content.

Download Demo

Now we successfully created our plugin and next adding sub menu on admin panel of word press .

wordpress add admin menu

mahesh chari — Tue, 23 Mar 2010 01:19:41 +0000

Add menu,sub menu,top level menu of our plug in on admin panel of word press

Here we learn how to add the menu to word press admin side panels to control our plug ins functionality like settings ,over view etc.

Download Demo

Word press comes with some admin menus by default ,listed below

Dash board- To get the over view of blog on the admin home page.
Posts – mainain the blog posts
Media – manage media files on blog
Links-blogs default links
Pages-manage blog pages
Comments-manage blog comments
Appearence -maintain blog themes and blog theme settings.
Plugins - manage blog plug ins
Users- manage blog users for admins and registered users
Tools-manage database and files back up.
Settings – blogs over all settings

To continue this tutorial we must aware about

word press hooks ,filters and their functions.
PHP OOP’s concepts

Okay, no problem even you don’t know much about word press hooks,we can manage with a main action hook for this tutorial.

admin_menu action

This action was triggered before admin menu begins and here we can add our menus .

Let start over view of the our plugin

We define the class for our plugin and instantiate it.
In the constructor our class we attach the admin_menu hook as below,that runs our class method my_admin_menu

add_action('admin_menu', array(&$this, 'my_admin_menu'));

Add our own panel with add_menu_page

add_menu_page(‘Panel Title’, ‘Panel first sub link title ‘, ‘level of handler ‘,’unique identifier for page’,'function that to be called’));

In the above line add_menu_page adds the main panel on the word press admin page.

add_menu_page('Mahesh Chari', 'Mahesh Chari', 'administrator', 8, 
array(&$this,'overview'));

Adding our sub links to own panel

Now we add sub links above panel titled settings, general with unique identifiers.

add_submenu_page(8, 'Settings', 'Settings', 'administrator', 1,
 array(&$this,'settings'));
add_submenu_page(8, 'General', 'General', 'administrator', 2, 
array(&$this,'generel'));

Now we add our plug ins link to existing word press panels mentioned above

Word press has already pre built functions to add respective panels.

Add sub menu link to existing posts panel

add_posts_page('Mahesh posts', 'Mahesh  Plugin', 'administrator', basename(__file__),
array(&$this, 'my_plugin_posts'));

Add sub menu link to existing Media panel

add_media_page('Mahesh media', 'Mahesh  Plugin', 'administrator', basename(__file__),
array(&$this, 'my_plugin_media'));

Add sub menu link to existing pages panel

add_pages_page('Mahesh pages', 'Mahesh  Plugin', 'administrator', basename(__file__),
array(&$this, 'my_plugin_pages'));

Add sub menu link to existing appearance panel

 add_theme_page('maheshchari', 'Mahesh  Plugin', 'administrator', basename(__file__),
array(&$this, 'my_plugin_themes'));

Add sub menu link to existing users panel

add_users_page('Mahesh users', 'Mahesh  Plugin', 'administrator', basename(__file__),
array(&$this, 'my_plugin_users'));

Add sub menu link to existing tools panel

add_management_page('maheshchari', 'Mahesh  Plugin', 'administrator',
basename(__file__),array(&$this, 'my_plugin_tools'));

Add sub menu link to existing options panel

add_options_page('Mahesh Options', 'Mahesh  Plugin', 'administrator',
 basename(__file__),array(&$this, 'my_plugin_options'));

Together all the sub menus


/*
Plugin Name: Mahesh Chari
Plugin URI: http://www.maheshchari.com/
Description: Description of my plugin
Author URI: http://www.maheshchari.com/
*/
 
class Maheshchari
{
 
    function Maheshchari()
    {
        add_action('admin_menu', array(&$this, 'my_admin_menu'));
    }
 
    function my_admin_menu()
    {	//create a main admin panel
		//create a sub admin panel link above
        add_menu_page('Mahesh Chari', 'Mahesh Chari', 'administrator', 8, array(&$this,'overview'));
        add_submenu_page(8, 'Settings', 'Settingss', 'administrator', 1, array(&$this,'settings'));
        add_submenu_page(8, 'Generel', 'Generel', 'administrator', 2, array(&$this,'generel'));
		//These functions adds sub menu for different kinds of admin panel on back end
        add_options_page('Mahesh Options', 'Mahesh  Plugin', 'administrator', basename(__file__),array(&$this, 'my_plugin_options'));
        add_posts_page('Mahesh posts', 'Mahesh  Plugin', 'administrator', basename(__file__),array(&$this, 'my_plugin_posts'));
        add_media_page('Mahesh media', 'Mahesh  Plugin', 'administrator', basename(__file__),array(&$this, 'my_plugin_media'));
        add_pages_page('Mahesh pages', 'Mahesh  Plugin', 'administrator', basename(__file__),array(&$this, 'my_plugin_pages'));
        add_users_page('Mahesh users', 'Mahesh  Plugin', 'administrator', basename(__file__),array(&$this, 'my_plugin_users'));
        add_management_page('maheshchari', 'Mahesh  Plugin', 'administrator', basename(__file__),array(&$this, 'my_plugin_tools'));
        add_theme_page('maheshchari', 'Mahesh  Plugin', 'administrator', basename(__file__),array(&$this, 'my_plugin_themes'));
 
    }
 
 
    function overview()
    {
        echo 'My Wordpress Plugin Overview
';
    }
 
    function settings()
    {
        echo 'My Wordpress Plugin Settings
';
    }
 
    function generel()
    {
        echo 'My Wordpress Plugin Generel
';
    }
    function my_plugin_options()
    {
        echo 'My Wordpress Plugin Options
';
 
    }
    function my_plugin_posts()
    {
        echo 'My Wordpress Plugin posts
';
    }
    function my_plugin_media()
    {
        echo 'My Wordpress Plugin media
';
    }
    function my_plugin_pages()
    {
        echo 'My Wordpress Plugin pages
';
    }
    function my_plugin_users()
    {
        echo 'My Wordpress Plugin users
';
    }
 
    function my_plugin_tools()
    {
        echo 'My Wordpress Plugin tools
';
    }
 
    function my_plugin_themes()
    {
        echo 'My Wordpress Plugin themes
';
    }
 
 
}
 
 
$mybackuper = &new Maheshchari();//instance of the plugin class
 
?>

To see the above code inaction,please download the zip of demo plug in and copy to your word press plug ins directory and activate the plugin ,then you see all the sub menus in admin panels menu

Download the Demo

wordpress custom contact form template

mahesh chari — Sun, 19 Jul 2009 02:03:05 +0000

How to make contact us form page for wordpress default theme .

We know that word press is popular open source blog.it has thousands of plugins to enhance it’s features.we can extend it to complicated CMS.here we learn how to make a simple contact form,that needs a every web site.please refere my previous article "how to make a custom page template" before moving . word press comes with two default thems classic,default. here we customize the default theme.

go to wp-content/themes/default directory and make a php file name contact_form.php.

open contact_form.php and single.php in the default template directory with your favorite editor.

copy the every code in single.php to contact_form.php.

delete every thing in the between

and

replace that with our generel contact form.

then click add new link in main page side navigation.make title as contact form .

then select a contact_form template attribute of the page on right .

publish this page you have done.

you can download the template file and test yourself.

Template Code


/*
Template Name: contact_form
*/
?>
 get_header(); ?>
 
 

 echo get_option('home'); ?>/">Home 
  Contact Us
   
if(isset($_POST['Submit'])){ //check if user submitted the contact form
$error="";
	if($_POST['contact_name']=='')$error.="Name required.
";
	if($_POST['contact_email']=='')$error.="Email required.
";
	if($_POST['contact_phone']=='')$error.="Phone  required.
";
	if($_POST['contact_comment']=='')$error.="Comment required.
";
if($error!=""){
	//if any errors skip mailing and display the errors for users.
	echo "$error";
}else{
	// get admin email from wordpress default options
	$to=get_option('admin_email');
	$subject="One contact enquire at noblefligh re: ".$_POST['contact_reason'];
	$body="\r\n Hi Admin";
	$body.="\r\n You had an enquiry:";
	$body.="\r\n Regarding:\t".$_POST['contact_reason'];
	$body.="\r\n Name: \t".$_POST['contact_name'];
	$body.="\r\n Email: \t".$_POST['contact_email'];
	$body.="\r\n Phone:\t".$_POST['contact_phone'];
	$body.="\r\n Comment: \r\n ".$_POST['contact_comment'];
	// wordpress default handy mail function
	wp_mail( $to, $subject, $body);
	echo "your comment sent to admin successfully";
	// display success message.
}
 
}
	?>
   echo the_permalink(); ?>">
    
      
        About 
        
        
      
      
        Name
        
      
      
        Email
        
      
      
        Phone
        
      
      
        Comment
        
      
      
        
          
      
    
  


 get_sidebar(); ?>
 get_footer(); ?>

Preview

wordpress custom page template

mahesh chari — Wed, 15 Jul 2009 04:25:55 +0000

How to add custom template to wordpress page or post

It is need to some pages of wordpress should be different for different pages or categories as per client requirements.but wordpress theme looks common for all pages and all posts. here we find simple steps to customize the wordpress theme templates.
just make custom template with your requirement.
add below code to start of the file.
upload it to wp_content/thems/your active theme folder via any FTP program.
go to admin panel of your wordpress and click add new link on pages left navigation.
then you can see a select box of templates on below attributes section on right side.
select custompagetemplate from template.
publish the page.
you can see a button view page.click it.
its done.


/*
Template Name: custompagetemplate
*/
?>

Simple Code


/*
Template Name: custompagetemplate
*/
<html>
<body>
<h1>This is your customized template .h1>
body>
html>
?>

Download Example Template

custometemplate

break long post wordpress

mahesh chari — Sat, 11 Jul 2009 00:05:00 +0000

How to Break A post or page on wordpress

Actually i have this problem while posting articles in this blog. so i googled the codex of wordpress and discovered solution.
just simple,while posting just decide where you want break the post or page, place a comment like below,its over worderess symptomatically splits into pages.

Code

Output

Page 1,2,3..

Php Development » wordpress

Word Press Plugin API/Filter Reference

Word Press Plugin API/Filter Reference and cheetsheet.

Post, Page, and Attachment Filters

Database Reads

Database Writes

Comment, Trackback, and Ping Filters

Database Writes

Category Filters

Database Writes

Link Filters

Date and Time Filters

Author and User Filters

Database Reads

Database Writes

Blogroll Filters

Blog Information and Option Filters

General Text Filters

Administrative Filters

Rich Text Editor Filters

Template Filters

Advanced WordPress Filters

Add theme page option menu

Adding sub menu our word press theme to word press admin panel

My Theme Options Page ,we can add any options to change our theme settings.

first step to developing word press plugin

Very Basic first step to write a word press plug in

Download Demo

Manage Files

Getting listed our plug in on the plug ins page

Adding functionality to plug in

Testing plug in

Download Demo

wordpress add admin menu

Add menu,sub menu,top level menu of our plug in on admin panel of word press

Download Demo

Let start over view of the our plugin

Add our own panel with add_menu_page

Adding our sub links to own panel

Now we add our plug ins link to existing word press panels mentioned above

Add sub menu link to existing posts panel

Add sub menu link to existing Media panel

Add sub menu link to existing pages panel

Add sub menu link to existing appearance panel

Add sub menu link to existing users panel

Add sub menu link to existing tools panel

Add sub menu link to existing options panel

Together all the sub menus

My Wordpress Plugin Overview

My Wordpress Plugin Settings

My Wordpress Plugin Generel

My Wordpress Plugin Options

My Wordpress Plugin posts

My Wordpress Plugin media

My Wordpress Plugin pages

My Wordpress Plugin users

My Wordpress Plugin tools

My Wordpress Plugin themes

Download the Demo

wordpress custom contact form template

How to make contact us form page for wordpress default theme .

Template Code

Contact Us

Preview

wordpress custom page template

How to add custom template to wordpress page or post

Simple Code

Download Example Template

break long post wordpress

How to Break A post or page on wordpress

Code

Output