[ Index ]

PHP Cross Reference of Wordpress 2.9.1

title

Body

[close]

/wp-admin/includes/ -> template.php (summary)

Template WordPress Administration API. A Big Mess. Also some neat functions that are nicely written.

File Size: 3824 lines (132 kb)
Included or required: 1 time
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Walker_Category_Checklist:: (72 methods):
  start_lvl()
  end_lvl()
  start_el()
  end_el()
  wp_category_checklist()
  wp_popular_terms_checklist()
  dropdown_link_categories()
  wp_link_category_checklist()
  _tag_row()
  tag_rows()
  wp_manage_posts_columns()
  wp_manage_media_columns()
  wp_manage_pages_columns()
  get_column_headers()
  print_column_headers()
  register_column_headers()
  get_hidden_columns()
  inline_edit_row()
  get_inline_data()
  post_rows()
  _post_row()
  display_page_row()
  page_rows()
  _page_rows()
  user_row()
  _wp_get_comment_list()
  _wp_comment_row()
  wp_comment_reply()
  wp_comment_trashnotice()
  wp_dropdown_cats()
  list_meta()
  _list_meta_row()
  meta_form()
  touch_time()
  page_template_dropdown()
  parent_dropdown()
  browse_happy()
  the_attachment_links()
  wp_dropdown_roles()
  wp_convert_hr_to_bytes()
  wp_convert_bytes_to_hr()
  wp_max_upload_size()
  wp_import_upload_form()
  wp_remember_old_slug()
  add_meta_box()
  do_meta_boxes()
  remove_meta_box()
  meta_box_prefs()
  get_hidden_meta_boxes()
  add_settings_section()
  add_settings_field()
  do_settings_sections()
  do_settings_fields()
  manage_columns_prefs()
  find_posts_div()
  the_post_password()
  favorite_actions()
  _draft_or_post_title()
  _admin_search_query()
  iframe_header()
  tb_close()
  iframe_footer()
  _post_states()
  screen_meta()
  add_contextual_help()
  drag_drop_help()
  plugins_search_help()
  widgets_help()
  screen_layout()
  screen_options()
  screen_icon()
  compression_test()

Defines 72 functions

  cat_rows()
  _cat_rows()
  _cat_row()
  inline_edit_term_row()
  link_cat_row()
  checked()
  selected()
  __checked_selected_helper()
  dropdown_categories()

Class: Walker_Category_Checklist  - X-Ref

{@internal Missing Short Description}}

start_lvl(&$output, $depth, $args)   X-Ref
No description

end_lvl(&$output, $depth, $args)   X-Ref
No description

start_el(&$output, $category, $depth, $args)   X-Ref
No description

end_el(&$output, $category, $depth, $args)   X-Ref
No description

wp_category_checklist( $post_id = 0, $descendants_and_self = 0, $selected_cats = false, $popular_cats = false, $walker = null, $checked_ontop = true )   X-Ref
{@internal Missing Short Description}}

param: unknown_type $post_id
param: unknown_type $descendants_and_self
param: unknown_type $selected_cats
param: unknown_type $popular_cats

wp_popular_terms_checklist( $taxonomy, $default = 0, $number = 10, $echo = true )   X-Ref
{@internal Missing Short Description}}

param: unknown_type $taxonomy
param: unknown_type $default
param: unknown_type $number
param: unknown_type $echo
return: unknown

dropdown_link_categories( $default = 0 )   X-Ref
{@internal Missing Short Description}}

param: unknown_type $default

wp_link_category_checklist( $link_id = 0 )   X-Ref
{@internal Missing Short Description}}

param: unknown_type $link_id

_tag_row( $tag, $class = '', $taxonomy = 'post_tag' )   X-Ref
{@internal Missing Short Description}}

param: unknown_type $tag
param: unknown_type $class
return: unknown

tag_rows( $page = 1, $pagesize = 20, $searchterms = '', $taxonomy = 'post_tag' )   X-Ref
{@internal Missing Short Description}}

param: unknown_type $page
param: unknown_type $pagesize
param: unknown_type $searchterms
return: unknown

wp_manage_posts_columns()   X-Ref
{@internal Missing Short Description}}

return: unknown

wp_manage_media_columns()   X-Ref
{@internal Missing Short Description}}

return: unknown

wp_manage_pages_columns()   X-Ref
{@internal Missing Short Description}}

return: unknown

get_column_headers($page)   X-Ref
{@internal Missing Short Description}}

param: unknown_type $page
return: unknown

print_column_headers( $type, $id = true )   X-Ref
{@internal Missing Short Description}}

param: unknown_type $type
param: unknown_type $id

register_column_headers($screen, $columns)   X-Ref
Register column headers for a particular screen.  The header names will be listed in the Screen Options.

param: string $screen The handle for the screen to add help to.  This is usually the hook name returned by the add_*_page() functions.
param: array $columns An array of columns with column IDs as the keys and translated column names as the values

get_hidden_columns($page)   X-Ref
{@internal Missing Short Description}}

param: unknown_type $page

inline_edit_row( $type )   X-Ref
{@internal Missing Short Description}}

Outputs the quick edit and bulk edit table rows for posts and pages

param: string $type 'post' or 'page'

get_inline_data($post)   X-Ref
{@internal Missing Short Description}}

param: unknown_type $post

post_rows( $posts = array()   X-Ref
{@internal Missing Short Description}}

param: unknown_type $posts

_post_row($a_post, $pending_comments, $mode)   X-Ref
{@internal Missing Short Description}}

param: unknown_type $a_post
param: unknown_type $pending_comments
param: unknown_type $mode

display_page_row( $page, $level = 0 )   X-Ref
{@internal Missing Short Description}}

param: unknown_type $page
param: unknown_type $level

page_rows($pages, $pagenum = 1, $per_page = 20)   X-Ref
{@internal Missing Short Description}}

param: unknown_type $pages
param: unknown_type $pagenum
param: unknown_type $per_page
return: unknown

_page_rows( &$children_pages, &$count, $parent, $level, $pagenum, $per_page )   X-Ref
{@internal Missing Short Description}}

param: unknown_type $children_pages
param: unknown_type $count
param: unknown_type $parent
param: unknown_type $level
param: unknown_type $pagenum
param: unknown_type $per_page

user_row( $user_object, $style = '', $role = '' )   X-Ref
{@internal Missing Short Description}}

param: unknown_type $user_object
param: unknown_type $style
param: unknown_type $role
return: unknown

_wp_get_comment_list( $status = '', $s = false, $start, $num, $post = 0, $type = '' )   X-Ref
{@internal Missing Short Description}}

param: string $status Comment status (approved, spam, trash, etc)
param: string $s Term to search for
param: int $start Offset to start at for pagination
param: int $num Maximum number of comments to return
param: int $post Post ID or 0 to return all comments
param: string $type Comment type (comment, trackback, pingback, etc)
return: array [0] contains the comments and [1] contains the total number of comments that match (ignoring $start and $num)

_wp_comment_row( $comment_id, $mode, $comment_status, $checkbox = true, $from_ajax = false )   X-Ref
{@internal Missing Short Description}}

param: unknown_type $comment_id
param: unknown_type $mode
param: unknown_type $comment_status
param: unknown_type $checkbox

wp_comment_reply($position = '1', $checkbox = false, $mode = 'single', $table_row = true)   X-Ref
{@internal Missing Short Description}}

param: unknown_type $position
param: unknown_type $checkbox
param: unknown_type $mode

wp_comment_trashnotice()   X-Ref
Output 'undo move to trash' text for comments


wp_dropdown_cats( $currentcat = 0, $currentparent = 0, $parent = 0, $level = 0, $categories = 0 )   X-Ref
{@internal Missing Short Description}}

param: unknown_type $currentcat
param: unknown_type $currentparent
param: unknown_type $parent
param: unknown_type $level
param: unknown_type $categories
return: unknown

list_meta( $meta )   X-Ref
{@internal Missing Short Description}}

param: unknown_type $meta

_list_meta_row( $entry, &$count )   X-Ref
{@internal Missing Short Description}}

param: unknown_type $entry
param: unknown_type $count
return: unknown

meta_form()   X-Ref
{@internal Missing Short Description}}


touch_time( $edit = 1, $for_post = 1, $tab_index = 0, $multi = 0 )   X-Ref
{@internal Missing Short Description}}

param: unknown_type $edit
param: unknown_type $for_post
param: unknown_type $tab_index
param: unknown_type $multi

page_template_dropdown( $default = '' )   X-Ref
{@internal Missing Short Description}}

param: unknown_type $default

parent_dropdown( $default = 0, $parent = 0, $level = 0 )   X-Ref
{@internal Missing Short Description}}

param: unknown_type $default
param: unknown_type $parent
param: unknown_type $level
return: unknown

browse_happy()   X-Ref
{@internal Missing Short Description}}


the_attachment_links( $id = false )   X-Ref
{@internal Missing Short Description}}

param: unknown_type $id
return: unknown

wp_dropdown_roles( $selected = false )   X-Ref
Print out <option> html elements for role selectors based on $wp_roles

param: string $default slug for the role that should be already selected

wp_convert_hr_to_bytes( $size )   X-Ref
{@internal Missing Short Description}}

param: unknown_type $size
return: unknown

wp_convert_bytes_to_hr( $bytes )   X-Ref
{@internal Missing Short Description}}

param: unknown_type $bytes
return: unknown

wp_max_upload_size()   X-Ref
{@internal Missing Short Description}}

return: unknown

wp_import_upload_form( $action )   X-Ref
Outputs the form used by the importers to accept the data to be imported

param: string $action The action attribute for the form.

wp_remember_old_slug()   X-Ref
{@internal Missing Short Description}}


add_meta_box($id, $title, $callback, $page, $context = 'advanced', $priority = 'default', $callback_args=null)   X-Ref
Add a meta box to an edit form.

param: string $id String for use in the 'id' attribute of tags.
param: string $title Title of the meta box.
param: string $callback Function that fills the box with the desired content. The function should echo its output.
param: string $page The type of edit page on which to show the box (post, page, link).
param: string $context The context within the page where the boxes should show ('normal', 'advanced').
param: string $priority The priority within the context where the boxes should show ('high', 'low').

do_meta_boxes($page, $context, $object)   X-Ref
{@internal Missing Short Description}}

param: unknown_type $page
param: unknown_type $context
param: unknown_type $object
return: int number of meta_boxes

remove_meta_box($id, $page, $context)   X-Ref
Remove a meta box from an edit form.

param: string $id String for use in the 'id' attribute of tags.
param: string $page The type of edit page on which to show the box (post, page, link).
param: string $context The context within the page where the boxes should show ('normal', 'advanced').

meta_box_prefs($page)   X-Ref
{@internal Missing Short Description}}

param: unknown_type $page

get_hidden_meta_boxes($page)   X-Ref
No description

add_settings_section($id, $title, $callback, $page)   X-Ref
Add a new section to a settings page.

param: string $id String for use in the 'id' attribute of tags.
param: string $title Title of the section.
param: string $callback Function that fills the section with the desired content. The function should echo its output.
param: string $page The type of settings page on which to show the section (general, reading, writing, ...).

add_settings_field($id, $title, $callback, $page, $section = 'default', $args = array()   X-Ref
Add a new field to a settings page.

param: string $id String for use in the 'id' attribute of tags.
param: string $title Title of the field.
param: string $callback Function that fills the field with the desired content. The function should echo its output.
param: string $page The type of settings page on which to show the field (general, reading, writing, ...).
param: string $section The section of the settingss page in which to show the box (default, ...).
param: array $args Additional arguments

do_settings_sections($page)   X-Ref
{@internal Missing Short Description}}

param: unknown_type $page

do_settings_fields($page, $section)   X-Ref
{@internal Missing Short Description}}

param: unknown_type $page
param: unknown_type $section

manage_columns_prefs($page)   X-Ref
{@internal Missing Short Description}}

param: unknown_type $page

find_posts_div($found_action = '')   X-Ref
{@internal Missing Short Description}}

param: unknown_type $found_action

the_post_password()   X-Ref
Display the post password.

The password is passed through {@link esc_attr()} to ensure that it
is safe for placing in an html attribute.


favorite_actions( $screen = null )   X-Ref
{@internal Missing Short Description}}


_draft_or_post_title($post_id = 0)   X-Ref
Get the post title.

The post title is fetched and if it is blank then a default string is
returned.

param: int $id The post id. If not supplied the global $post is used.

_admin_search_query()   X-Ref
Display the search query.

A simple wrapper to display the "s" parameter in a GET URI. This function
should only be used when {@link the_search_query()} cannot.


iframe_header( $title = '', $limit_styles = false )   X-Ref
Generic Iframe header for use with Thickbox

param: string $title Title of the Iframe page.
param: bool $limit_styles Limit styles to colour-related styles only (unless others are enqueued).

tb_close()   X-Ref
No description

iframe_footer()   X-Ref
Generic Iframe footer for use with Thickbox


_post_states($post)   X-Ref
No description

screen_meta($screen)   X-Ref
No description

add_contextual_help($screen, $help)   X-Ref
Add contextual help text for a page

param: string $screen The handle for the screen to add help to.  This is usually the hook name returned by the add_*_page() functions.
param: string $help Arbitrary help text

drag_drop_help()   X-Ref
No description

plugins_search_help()   X-Ref
No description

widgets_help()   X-Ref
No description

screen_layout($screen)   X-Ref
No description

screen_options($screen)   X-Ref
No description

screen_icon($name = '')   X-Ref
No description

compression_test()   X-Ref
Test support for compressing JavaScript from PHP

Outputs JavaScript that tests if compression from PHP works as expected
and sets an option with the result. Has no effect when the current user
is not an administrator. To run the test again the option 'can_compress_scripts'
has to be deleted.


Functions
Functions that are not part of a class:

cat_rows( $parent = 0, $level = 0, $categories = 0, $page = 1, $per_page = 20 )   X-Ref
{@internal Missing Short Description}}

param: unknown_type $parent
param: unknown_type $level
param: unknown_type $categories
param: unknown_type $page
param: unknown_type $per_page

_cat_rows( $parent = 0, $level = 0, $categories, &$children, $page = 1, $per_page = 20, &$count )   X-Ref
{@internal Missing Short Description}}

param: unknown_type $categories
param: unknown_type $count
param: unknown_type $parent
param: unknown_type $level
param: unknown_type $page
param: unknown_type $per_page
return: unknown

_cat_row( $category, $level, $name_override = false )   X-Ref
{@internal Missing Short Description}}

param: unknown_type $category
param: unknown_type $level
param: unknown_type $name_override
return: unknown

inline_edit_term_row($type)   X-Ref
{@internal Missing Short Description}}

param: string $type "tag", "category" or "link-category"
return:

link_cat_row( $category, $name_override = false )   X-Ref
{@internal Missing Short Description}}

param: unknown_type $category
param: unknown_type $name_override
return: unknown

checked( $checked, $current = true, $echo = true)   X-Ref
Outputs the html checked attribute.

Compares the first two arguments and if identical marks as checked

param: any $checked One of the values to compare
param: any $current (true) The other value to compare if not just true
param: bool $echo Whether or not to echo or just return the string

selected( $selected, $current = true, $echo = true)   X-Ref
Outputs the html selected attribute.

Compares the first two arguments and if identical marks as selected

param: any selected One of the values to compare
param: any $current (true) The other value to compare if not just true
param: bool $echo Whether or not to echo or just return the string

__checked_selected_helper( $helper, $current, $echo, $type)   X-Ref
Private helper function for checked and selected.

Compares the first two arguments and if identical marks as $type

param: any $helper One of the values to compare
param: any $current (true) The other value to compare if not just true
param: bool $echo Whether or not to echo or just return the string
param: string $type The type of checked|selected we are doing.

dropdown_categories( $default = 0, $parent = 0, $popular_ids = array()   X-Ref
{@internal Missing Short Description}}

param: unknown_type $default
param: unknown_type $parent
param: unknown_type $popular_ids



Generated: Fri Jan 8 00:19:48 2010 Cross-referenced by PHPXref 0.7