PHPXRef 0.7.1 : BuddyPress : Detail view of functions.bb-core.php

Functions that are not part of a class:

bb_log_deprecated( $type, $name, $replacement = 'none' ) X-Ref

Marks things as deprecated and informs when they have been used.

param: string $type The type of thing that was attempted: function, class::function, constant, variable or page.
param: string $name The thing that was called.
param: string $replacement Optional. The thing that should have been called.
since: 0.9

bb_global_sanitize( $array, $trim = true ) X-Ref

Sanitizes user input en-masse.

param: mixed $array The array of values or a single value to sanitize, usually a global variable like $_GET or $_POST.
param: boolean $trim Optional. Whether to trim the value or not. Default is true.
return: mixed The sanitized data.

bb_is_installed() X-Ref

Reports whether bbPress is installed by getting forums.

return: boolean True if there are forums, otherwise false.

bb_set_custom_user_tables() X-Ref

Sets the required variables to connect to custom user tables.

return: boolean Always returns true.

bb_paginate_links( $args = '' ) X-Ref

Retrieve paginated links for pages.

Technically, the function can be used to create paginated link list for any
area. The 'base' argument is used to reference the url, which will be used to
create the paginated links. The 'format' argument is then used for replacing
the page number. It is however, most likely and by default, to be used on the
archive post pages.

The 'type' argument controls format of the returned value. The default is
'plain', which is just a string with the links separated by a newline
character. The other possible values are either 'array' or 'list'. The
'array' value will return an array of the paginated link list to offer full
control of display. The 'list' value will place all of the paginated links in
an unordered HTML list.

The 'total' argument is the total amount of pages and is an integer. The
'current' argument is the current page number and is also an integer.

An example of the 'base' argument is "http://example.com/all_posts.php%_%"
and the '%_%' is required. The '%_%' will be replaced by the contents of in
the 'format' argument. An example for the 'format' argument is "?page=%#%"
and the '%#%' is also required. The '%#%' will be replaced with the page
number.

You can include the previous and next links in the list by setting the
'prev_next' argument to true, which it is by default. You can set the
previous text, by using the 'prev_text' argument. You can set the next text
by setting the 'next_text' argument.

If the 'show_all' argument is set to true, then it will show all of the pages
instead of a short list of the pages near the current page. By default, the
'show_all' is set to false and controlled by the 'end_size' and 'mid_size'
arguments. The 'end_size' argument is how many numbers on either the start
and the end list edges, by default is 1. The 'mid_size' argument is how many
numbers to either side of current page, but not including current page.

It is possible to add query vars to the link by using the 'add_args' argument
and see {@link add_query_arg()} for more information.

param: string|array $args Optional. Override defaults.
return: array|string String of page links or array of page links.
since: 1.0

bb_get_uri_page() X-Ref

No description

bb_get_page_number( $item, $per_page = 0 ) X-Ref

No description

bb_timer_stop($display = 0, $precision = 3) X-Ref

No description

bb_since( $original, $args = '' ) X-Ref

No description

bb_current_time( $type = 'timestamp' ) X-Ref

No description

bb_offset_time( $time, $args = null ) X-Ref

No description

bb_uri( $resource = null, $query = null, $context = BB_URI_CONTEXT_A_HREF ) X-Ref

Echo a URI based on the URI setting

param: $resource string The directory, may include a querystring
param: $query mixed The query arguments as a querystring or an associative array
param: $context integer The context of the URI, use BB_URI_CONTEXT_*
return: void
since: 1.0

bb_get_uri( $resource = null, $query = null, $context = BB_URI_CONTEXT_A_HREF ) X-Ref

Return a URI based on the URI setting

param: $resource string The directory, may include a querystring
param: $query mixed The query arguments as a querystring or an associative array
param: $context integer The context of the URI, use BB_URI_CONTEXT_*
return: string The complete URI
since: 1.0

bb_ssl_redirect() X-Ref

Forces redirection to an SSL page when required

return: void
since: 1.0

bb_get_path( $level = 1, $base = false, $request = false ) X-Ref

No description

bb_find_filename( $text ) X-Ref

No description

bb_send_headers() X-Ref

No description

bb_pingback_header() X-Ref

No description

bb_repermalink() X-Ref

No description

bb_global_profile_menu_structure() X-Ref

No description

bb_add_profile_tab($tab_title, $users_cap, $others_cap, $file, $arg = false) X-Ref

No description

bb_can_access_tab( $profile_tab, $viewer_id, $owner_id ) X-Ref

No description

bb_get_profile_info_keys( $context = null ) X-Ref

No description

bb_get_profile_admin_keys( $context = null ) X-Ref

No description

bb_get_assignable_caps() X-Ref

No description

bb_get_views() X-Ref

No description

bb_register_view( $view, $title, $query_args = '', $feed = TRUE ) X-Ref

No description

bb_deregister_view( $view ) X-Ref

No description

bb_view_query( $view, $new_args = '' ) X-Ref

No description

bb_get_view_query_args( $view ) X-Ref

No description

bb_register_default_views() X-Ref

No description

bb_send_304( $bb_last_modified ) X-Ref

Send status headers for clients supporting Conditional Get

The function sends the Last-Modified and ETag headers for all clients. It
then checks both the If-None-Match and If-Modified-Since headers to see if
the client has used them. If so, and the ETag does matches the client ETag
or the last modified date sent by the client is newer or the same as the
generated last modified, the function sends a 304 Not Modified and exits.

param: string $bb_last_modified Last modified time. Must be a HTTP-date

bb_nonce_url( $actionurl, $action = -1 ) X-Ref

Retrieve URL with nonce added to URL query.

param: string $actionurl URL to add nonce action
param: string $action Optional. Nonce action name
return: string URL with nonce action added.
since: 1.0

bb_nonce_field( $action = -1, $name = "_wpnonce", $referer = true , $echo = true ) X-Ref

Retrieve or display nonce hidden field for forms.

The nonce field is used to validate that the contents of the form came from
the location on the current site and not somewhere else. The nonce does not
offer absolute protection, but should protect against most cases. It is very
important to use nonce field in forms.

If you set $echo to true and set $referer to true, then you will need to
retrieve the {@link wp_referer_field() wp referer field}. If you have the
$referer set to true and are echoing the nonce field, it will also echo the
referer field.

The $action and $name are optional, but if you want to have better security,
it is strongly suggested to set those two parameters. It is easier to just
call the function without any parameters, because validation of the nonce
doesn't require any parameters, but since crackers know what the default is
it won't be difficult for them to find a way around your nonce and cause
damage.

The input name will be whatever $name value you gave. The input value will be
the nonce creation value.

param: string $action Optional. Action name.
param: string $name Optional. Nonce name.
param: bool $referer Optional, default true. Whether to set the referer field for validation.
param: bool $echo Optional, default true. Whether to display or return hidden form field.
return: string Nonce field.
since: 1.0

bb_nonce_ays( $action ) X-Ref

No description

bb_install_header( $title = '', $header = false, $logo = false ) X-Ref

No description

bb_install_footer() X-Ref

No description

bb_die( $message, $title = '', $header = 0 ) X-Ref

No description

bb_explain_nonce($action) X-Ref

No description

bb_count_last_query( $query = '' ) X-Ref

No description