[ Index ]

PHP Cross Reference of BBPress

title

Body

[close]

/src/includes/core/ -> functions.php (summary)

bbPress Core Functions

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

Defines 42 functions

  bbp_version()
  bbp_get_version()
  bbp_db_version()
  bbp_get_db_version()
  bbp_db_version_raw()
  bbp_get_db_version_raw()
  bbp_update_forum_id()
  bbp_update_topic_id()
  bbp_update_reply_id()
  bbp_update_reply_to_id()
  bbp_get_views()
  bbp_register_view()
  bbp_deregister_view()
  bbp_view_query()
  bbp_get_view_query_args()
  bbp_add_error()
  bbp_has_errors()
  bbp_find_mentions_pattern()
  bbp_find_mentions()
  bbp_mention_filter()
  bbp_get_public_status_id()
  bbp_get_pending_status_id()
  bbp_get_private_status_id()
  bbp_get_hidden_status_id()
  bbp_get_closed_status_id()
  bbp_get_spam_status_id()
  bbp_get_trash_status_id()
  bbp_get_orphan_status_id()
  bbp_get_user_rewrite_id()
  bbp_get_edit_rewrite_id()
  bbp_get_search_rewrite_id()
  bbp_get_user_topics_rewrite_id()
  bbp_get_user_replies_rewrite_id()
  bbp_get_user_favorites_rewrite_id()
  bbp_get_user_subscriptions_rewrite_id()
  bbp_get_user_engagements_rewrite_id()
  bbp_get_view_rewrite_id()
  bbp_get_paged_rewrite_id()
  bbp_delete_rewrite_rules()
  bbp_is_post_request()
  bbp_is_get_request()
  bbp_redirect()

Functions
Functions that are not part of a class:

bbp_version()   X-Ref
Output the bbPress version

since: 2.0.0 bbPress (r3468)

bbp_get_version()   X-Ref
Return the bbPress version

since: 2.0.0 bbPress (r3468)

bbp_db_version()   X-Ref
Output the bbPress database version

since: 2.0.0 bbPress (r3468)

bbp_get_db_version()   X-Ref
Return the bbPress database version

since: 2.0.0 bbPress (r3468)

bbp_db_version_raw()   X-Ref
Output the bbPress database version directly from the database

since: 2.0.0 bbPress (r3468)

bbp_get_db_version_raw()   X-Ref
Return the bbPress database version directly from the database

since: 2.0.0 bbPress (r3468)

bbp_update_forum_id( $post_id = 0, $forum_id = 0 )   X-Ref
Update the forum meta ID of a post

since: 2.0.0 bbPress (r3181)
param: int $post_id  The post to update
param: int $forum_id The forum

bbp_update_topic_id( $post_id = 0, $topic_id = 0 )   X-Ref
Update the topic meta ID of a post

since: 2.0.0 bbPress (r3181)
param: int $post_id  The post to update
param: int $topic_id The topic

bbp_update_reply_id( $post_id = 0, $reply_id = 0 )   X-Ref
Update the reply meta ID of a post

since: 2.0.0 bbPress (r3181)
param: int $post_id  The post to update
param: int $reply_id The reply

bbp_update_reply_to_id( $post_id = 0, $reply_id = 0 )   X-Ref
Update the reply-to meta ID of a post

since: 2.6.0 bbPress (r5735)
param: int $post_id  The post to update
param: int $reply_id The reply ID

bbp_get_views()   X-Ref
Get the registered views

Does nothing much other than return the {@link $bbp->views} variable

return: array Views
since: 2.0.0 bbPress (r2789)

bbp_register_view( $view, $title, $query_args = '', $feed = true, $capability = '' )   X-Ref
Register a bbPress view

return: array The just registered (but processed) view
since: 2.0.0 bbPress (r2789)
param: string $view View name
param: string $title View title
param: mixed $query_args {@link bbp_has_topics()} arguments.
param: bool $feed Have a feed for the view? Defaults to true.
param: string $capability Capability that the current user must have

bbp_deregister_view( $view )   X-Ref
Deregister a bbPress view

return: bool False if the view doesn't exist, true on success
since: 2.0.0 bbPress (r2789)
param: string $view View name

bbp_view_query( $view = '', $new_args = '' )   X-Ref
Run the query of a topic-view

return: bool False if the view doesn't exist, otherwise if topics are there
since: 2.0.0 bbPress (r2789)
param: string $view Optional. View id
param: mixed $new_args New arguments. See {@link bbp_has_topics()}

bbp_get_view_query_args( $view = '' )   X-Ref
Return the query arguments of a topic-view

return: array Query arguments
since: 2.0.0 bbPress (r2789)
param: string $view View name

bbp_add_error( $code = '', $message = '', $data = '' )   X-Ref
Adds an error message to later be output in the theme

since: 2.0.0 bbPress (r3381)
param: string $code Unique code for the error message
param: string $message Translated error message
param: string $data Any additional data passed with the error message

bbp_has_errors()   X-Ref
Check if error messages exist in queue

since: 2.0.0 bbPress (r3381)

bbp_find_mentions_pattern()   X-Ref
Set the pattern used for matching usernames for mentions.

Moved into its own function to allow filtering of the regex pattern
anywhere mentions might be used.

return: string Pattern to match usernames with
since: 2.4.0 bbPress (r4997)

bbp_find_mentions( $content = '' )   X-Ref
Searches through the content to locate usernames, designated by an @ sign.

return: bool|array $usernames Existing usernames. False if no matches.
since: 2.2.0 bbPress (r4323)
param: string $content The content

bbp_mention_filter( $content = '' )   X-Ref
Finds and links @-mentioned users in the content

return: string $content Content filtered for mentions
since: 2.2.0 bbPress (r4323)

bbp_get_public_status_id()   X-Ref
Return the public post status ID

return: string
since: 2.0.0 bbPress (r3504)

bbp_get_pending_status_id()   X-Ref
Return the pending post status ID

return: string
since: 2.1.0 bbPress (r3581)

bbp_get_private_status_id()   X-Ref
Return the private post status ID

return: string
since: 2.0.0 bbPress (r3504)

bbp_get_hidden_status_id()   X-Ref
Return the hidden post status ID

return: string
since: 2.0.0 bbPress (r3504)

bbp_get_closed_status_id()   X-Ref
Return the closed post status ID

return: string
since: 2.0.0 bbPress (r3504)

bbp_get_spam_status_id()   X-Ref
Return the spam post status ID

return: string
since: 2.0.0 bbPress (r3504)

bbp_get_trash_status_id()   X-Ref
Return the trash post status ID

return: string
since: 2.0.0 bbPress (r3504)

bbp_get_orphan_status_id()   X-Ref
Return the orphan post status ID

return: string
since: 2.0.0 bbPress (r3504)

bbp_get_user_rewrite_id()   X-Ref
Return the unique ID for user profile rewrite rules

return: string
since: 2.1.0 bbPress (r3762)

bbp_get_edit_rewrite_id()   X-Ref
Return the unique ID for all edit rewrite rules (forum|topic|reply|tag|user)

return: string
since: 2.1.0 bbPress (r3762)

bbp_get_search_rewrite_id()   X-Ref
Return the unique ID for all search rewrite rules

return: string
since: 2.3.0 bbPress (r4579)

bbp_get_user_topics_rewrite_id()   X-Ref
Return the unique ID for user topics rewrite rules

return: string
since: 2.2.0 bbPress (r4321)

bbp_get_user_replies_rewrite_id()   X-Ref
Return the unique ID for user replies rewrite rules

return: string
since: 2.2.0 bbPress (r4321)

bbp_get_user_favorites_rewrite_id()   X-Ref
Return the unique ID for user favorites rewrite rules

return: string
since: 2.2.0 bbPress (r4181)

bbp_get_user_subscriptions_rewrite_id()   X-Ref
Return the unique ID for user subscriptions rewrite rules

return: string
since: 2.2.0 bbPress (r4181)

bbp_get_user_engagements_rewrite_id()   X-Ref
Return the unique ID for user engagement rewrite rules

return: string
since: 2.6.0 bbPress (r6320)

bbp_get_view_rewrite_id()   X-Ref
Return the unique ID for topic view rewrite rules

return: string
since: 2.1.0 bbPress (r3762)

bbp_get_paged_rewrite_id()   X-Ref
Get the id used for paginated requests

return: string
since: 2.4.0 bbPress (r4926)

bbp_delete_rewrite_rules()   X-Ref
Delete a blogs rewrite rules, so that they are automatically rebuilt on
the subsequent page load.

since: 2.2.0 bbPress (r4198)

bbp_is_post_request()   X-Ref
Return true|false if this is a POST request

return: bool
since: 2.3.0 bbPress (r4790)

bbp_is_get_request()   X-Ref
Return true|false if this is a GET request

return: bool
since: 2.3.0 bbPress (r4790)

bbp_redirect( $location = '', $status = 302 )   X-Ref
Perform a safe, local redirect somewhere inside the current site

On some setups, passing the value of wp_get_referer() may result in an empty
value for $location, which results in an error on redirection. If $location
is empty, we can safely redirect back to the forum root. This might change
in a future version, possibly to the site root.

since: 2.6.0 bbPress (r5658)
param: string $location The URL to redirect the user to.
param: int    $status   Optional. The numeric code to give in the redirect



Generated: Sat Sep 21 01:01:35 2019 Cross-referenced by PHPXref 0.7.1