[ Index ]

PHP Cross Reference of zeList

title

Body

[close]

/includes/ -> duplicate.php (summary)

(no description)

File Size: 447 lines (16 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 8 functions

  zelist_list_bookmarks()
  _hack_walk_bookmarks()
  wp_count_links()
  get_links_tags()
  wp_edit_links_query()
  get_available_link_statuses()
  single_link_tag_title()
  link_category_exists()

Functions
Functions that are not part of a class:

zelist_list_bookmarks($args = '')   X-Ref
Duplicated version of wp_list_bookmarks... only the _walk function is modified

List of default arguments are as follows:
'orderby' - Default is 'name' (string). How to order the links by. String is
based off of the bookmark scheme.
'order' - Default is 'ASC' (string). Either 'ASC' or 'DESC'. Orders in either
ascending or descending order.
'limit' - Default is -1 (integer) or show all. The amount of bookmarks to
display.
'category' - Default is empty string (string). Include the links in what
category ID(s).
'category_name' - Default is empty string (string). Get links by category
name.
'hide_invisible' - Default is 1 (integer). Whether to show (default) or hide
links marked as 'invisible'.
'show_updated' - Default is 0 (integer). Will show the time of when the
bookmark was last updated.
'echo' - Default is 1 (integer). Whether to echo (default) or return the
formatted bookmarks.
'categorize' - Default is 1 (integer). Whether to show links listed by
category (default) or show links in one column.

These options define how the Category name will appear before the category
links are displayed, if 'categorize' is 1. If 'categorize' is 0, then it will
display for only the 'title_li' string and only if 'title_li' is not empty.
'title_li' - Default is 'Bookmarks' (translatable string). What to show
before the links appear.
'title_before' - Default is '<h2>' (string). The HTML or text to show before
the 'title_li' string.
'title_after' - Default is '</h2>' (string). The HTML or text to show after
the 'title_li' string.
'class' - Default is 'linkcat' (string). The CSS class to use for the
'title_li'.

'category_before' - Default is '<li id="%id" class="%class">'. String must
contain '%id' and '%class' to get
the id of the category and the 'class' argument. These are used for
formatting in themes.
Argument will be displayed before the 'title_before' argument.
'category_after' - Default is '</li>' (string). The HTML or text that will
appear after the list of links.

These are only used if 'categorize' is set to 1 or true.
'category_orderby' - Default is 'name'. How to order the bookmark category
based on term scheme.
'category_order' - Default is 'ASC'. Set the order by either ASC (ascending)
or DESC (descending).

param: string|array $args Optional. Overwrite the defaults of the function
return: string|null Will only return if echo option is set to not echo.

_hack_walk_bookmarks($bookmarks, $args = '' )   X-Ref
Thanks to WordPress limited usage of hooks, this function is duplicated with 2 lines changed. The formatted output of a list of bookmarks.

The $bookmarks array must contain bookmark objects and will be iterated over
to retrieve the bookmark to be used in the output.

The output is formatted as HTML with no way to change that format. However,
what is between, before, and after can be changed. The link itself will be
HTML.

This function is used internally by wp_list_bookmarks() and should not be
used by themes.

The defaults for overwriting are:
'show_updated' - Default is 0 (integer). Will show the time of when the
bookmark was last updated.
'show_description' - Default is 0 (integer). Whether to show the description
of the bookmark.
'show_images' - Default is 1 (integer). Whether to show link image if
available.
'show_name' - Default is 0 (integer). Whether to show link name if
available.
'before' - Default is '<li>' (string). The html or text to prepend to each
bookmarks.
'after' - Default is '</li>' (string). The html or text to append to each
bookmarks.
'link_before' - Default is '' (string). The html or text to prepend to each
bookmarks inside the <a> tag.
'link_after' - Default is '' (string). The html or text to append to each
bookmarks inside the <a> tag.
'between' - Default is '\n' (string). The string for use in between the link,
description, and image.
'show_rating' - Default is 0 (integer). Whether to show the link rating.

param: array $bookmarks List of bookmarks to traverse
param: string|array $args Optional. Overwrite the defaults.
return: string Formatted output in HTML

wp_count_links( )   X-Ref
Count number of links and is user has permissions to view.

This function provides an efficient method of finding the amount of post's
type a blog has. Another method is to count the amount of items in
get_posts(), but that method has a lot of overhead with doing so. Therefore,
when developing for 2.5+, use this function instead.

The $perm parameter checks for 'readable' value and if the user can read
private posts, it will display that for the user that is signed in.

param: string $type Optional. Post type to retrieve count
param: string $perm Optional. 'readable' or empty.
return: object Number of posts for each status

get_links_tags( $args = '' )   X-Ref
Retrieves all link tags.

param: string|array $args Tag arguments to use when retrieving tags.
return: array List of tags.

wp_edit_links_query( $q = false )   X-Ref
{@internal Missing Short Description}}

param: unknown_type $q
return: unknown

get_available_link_statuses($type = 'link')   X-Ref
Returns availables ( = with 1 link or more) statuses for links

param: unknown_type $type
return: unknown

single_link_tag_title($prefix = '', $display = true )   X-Ref
Display or retrieve page title for link_tag post archive.

Useful for link_tag template files for displaying the link_tag page title. It has less
overhead than {@link wp_title()}, because of its limited implementation.

It does not support placing the separator after the title, but by leaving the
prefix parameter empty, you can set the title separator manually. The prefix
does not automatically place a space between the prefix, so if there should
be a space, the parameter value will need to have it at the end.

param: string $prefix Optional. What to display before the title.
param: bool $display Optional, default is true. Whether to display or retrieve title.
return: string|null Title when retrieving, null when displaying or failure.

link_category_exists($cat_name)   X-Ref
{@internal Missing Short Description}}

param: unknown_type $cat_name
return: unknown



Generated: Sat May 30 23:51:06 2009 Cross-referenced by PHPXref 0.7