[ Index ]

PHP Cross Reference of BBPress

title

Body

[close]

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

bbPress Reply Functions

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

Defines 38 functions

  bbp_insert_reply()
  bbp_insert_reply_update_counts()
  bbp_new_reply_handler()
  bbp_edit_reply_handler()
  bbp_update_reply()
  bbp_update_reply_walker()
  bbp_update_reply_forum_id()
  bbp_update_reply_topic_id()
  bbp_update_reply_to()
  bbp_get_reply_ancestors()
  bbp_update_reply_revision_log()
  bbp_move_reply_handler()
  bbp_move_reply_count()
  bbp_toggle_reply_handler()
  bbp_toggle_reply()
  bbp_get_reply_statuses()
  bbp_get_reply_toggles()
  bbp_spam_reply()
  bbp_unspam_reply()
  bbp_approve_reply()
  bbp_unapprove_reply()
  bbp_delete_reply()
  bbp_trash_reply()
  bbp_untrash_reply()
  bbp_deleted_reply()
  bbp_trashed_reply()
  bbp_untrashed_reply()
  bbp_get_replies_per_page()
  bbp_get_replies_per_rss_page()
  bbp_reply_content_autoembed()
  _bbp_has_replies_where()
  bbp_display_replies_feed_rss2()
  bbp_check_reply_edit()
  bbp_update_reply_position()
  bbp_get_reply_position_raw()
  bbp_thread_replies()
  bbp_list_replies()
  bbp_validate_reply_to()

Functions
Functions that are not part of a class:

bbp_insert_reply( $reply_data = array()   X-Ref
A wrapper for wp_insert_post() that also includes the necessary meta values
for the reply to function properly.

param: array $reply_data Forum post data
param: arrap $reply_meta Forum meta data
since: 2.0.0 bbPress (r3349)

bbp_insert_reply_update_counts( $reply_id = 0, $topic_id = 0, $forum_id = 0 )   X-Ref
Update counts after a reply is inserted via `bbp_insert_reply`.

param: int $reply_id The reply id.
param: int $topic_id The topic id.
param: int $forum_id The forum id.
since: 2.6.0 bbPress (r6036)
return: void

bbp_new_reply_handler( $action = '' )   X-Ref
Handles the front end reply submission

param: string $action The requested action to compare this function to
since: 2.0.0 bbPress (r2574)

bbp_edit_reply_handler( $action = '' )   X-Ref
Handles the front end edit reply submission

param: string $action The requested action to compare this function to

bbp_update_reply( $reply_id = 0, $topic_id = 0, $forum_id = 0, $anonymous_data = array()   X-Ref
Handle all the extra meta stuff from posting a new reply or editing a reply

param: int $reply_id Optional. Reply id
param: int $topic_id Optional. Topic id
param: int $forum_id Optional. Forum id
param: array $anonymous_data Optional - if it's an anonymous post. Do not
param: int $author_id Author id
param: bool $is_edit Optional. Is the post being edited? Defaults to false.
param: int $reply_to Optional. Reply to id

bbp_update_reply_walker( $reply_id, $last_active_time = '', $forum_id = 0, $topic_id = 0, $refresh = true )   X-Ref
Walk up the ancestor tree from the current reply, and update all the counts

param: int $reply_id Optional. Reply id
param: string $last_active_time Optional. Last active time
param: int $forum_id Optional. Forum id
param: int $topic_id Optional. Topic id
param: bool $refresh If set to true, unsets all the previous parameters.
since: 2.0.0 bbPress (r2884)

bbp_update_reply_forum_id( $reply_id = 0, $forum_id = 0 )   X-Ref
Update the reply with its forum id it is in

param: int $reply_id Optional. Reply id to update
param: int $forum_id Optional. Forum id
since: 2.0.0 bbPress (r2855)
return: bool The forum id of the reply

bbp_update_reply_topic_id( $reply_id = 0, $topic_id = 0 )   X-Ref
Update the reply with its topic id it is in

param: int $reply_id Optional. Reply id to update
param: int $topic_id Optional. Topic id
since: 2.0.0 bbPress (r2855)
return: bool The topic id of the reply

bbp_update_reply_to( $reply_id = 0, $reply_to = 0 )   X-Ref
No description

bbp_get_reply_ancestors( $reply_id = 0 )   X-Ref
Get all ancestors to a reply

Because settings can be changed, this function does not care if hierarchical
replies are active or to what depth.

param: int $reply_id
since: 2.6.0 bbPress (r5390)
return: array

bbp_update_reply_revision_log( $args = array()   X-Ref
Update the revision log of the reply

param: array $args Supports these args:
since: 2.0.0 bbPress (r2782)
return: mixed False on failure, true on success

bbp_move_reply_handler( $action = '' )   X-Ref
Move reply handler

Handles the front end move reply submission

param: string $action The requested action to compare this function to
since: 2.3.0 bbPress (r4521)

bbp_move_reply_count( $move_reply_id, $source_topic_id, $destination_topic_id )   X-Ref
Fix counts on reply move

When a reply is moved, update the counts of source and destination topic
and their forums.

param: int $move_reply_id Move reply id
param: int $source_topic_id Source topic id
param: int $destination_topic_id Destination topic id
since: 2.3.0 bbPress (r4521)

bbp_toggle_reply_handler( $action = '' )   X-Ref
Handles the front end spamming/unspamming and trashing/untrashing/deleting of
replies

param: string $action The requested action to compare this function to
since: 2.0.0 bbPress (r2740)

bbp_toggle_reply( $args = array()   X-Ref
Do the actual reply toggling

This function is used by `bbp_toggle_reply_handler()` to do the actual heavy
lifting when it comes to toggling replies. It only really makes sense to call
within that context, so if you need to call this function directly, make sure
you're also doing what the handler does too.

param: array $args
since: 2.6.0 bbPress (r6133)

bbp_get_reply_statuses( $reply_id = 0 )   X-Ref
Return an associative array of available reply statuses

param: int $reply_id   Optional. Reply id.
since: 2.6.0 bbPress (r5399)
return: array

bbp_get_reply_toggles( $reply_id = 0 )   X-Ref
Return array of available reply toggle actions

param: int $reply_id   Optional. Reply id.
since: 2.6.0 bbPress (r6133)
return: array

bbp_spam_reply( $reply_id = 0 )   X-Ref
Marks a reply as spam

param: int $reply_id Reply id
since: 2.0.0 bbPress (r2740)
return: mixed False or {@link WP_Error} on failure, reply id on success

bbp_unspam_reply( $reply_id = 0 )   X-Ref
Unspams a reply

param: int $reply_id Reply id
since: 2.0.0 bbPress (r2740)
return: mixed False or {@link WP_Error} on failure, reply id on success

bbp_approve_reply( $reply_id = 0 )   X-Ref
Approves a reply

param: int $reply_id Reply id
since: 2.6.0 bbPress (r5506)
return: mixed False or {@link WP_Error} on failure, reply id on success

bbp_unapprove_reply( $reply_id = 0 )   X-Ref
Unapproves a reply

param: int $reply_id Reply id
since: 2.6.0 bbPress (r5506)
return: mixed False or {@link WP_Error} on failure, reply id on success

bbp_delete_reply( $reply_id = 0 )   X-Ref
Called before deleting a reply


bbp_trash_reply( $reply_id = 0 )   X-Ref
Called before trashing a reply


bbp_untrash_reply( $reply_id = 0 )   X-Ref
Called before untrashing (restoring) a reply


bbp_deleted_reply( $reply_id = 0 )   X-Ref
Called after deleting a reply

since: 2.0.0 bbPress (r2993)

bbp_trashed_reply( $reply_id = 0 )   X-Ref
Called after trashing a reply

since: 2.0.0 bbPress (r2993)

bbp_untrashed_reply( $reply_id = 0 )   X-Ref
Called after untrashing (restoring) a reply

since: 2.0.0 bbPress (r2993)

bbp_get_replies_per_page( $default = 15 )   X-Ref
Return the replies per page setting

param: int $default Default replies per page (15)
since: 2.0.0 bbPress (r3540)
return: int

bbp_get_replies_per_rss_page( $default = 25 )   X-Ref
Return the replies per RSS page setting

param: int $default Default replies per page (25)
since: 2.0.0 bbPress (r3540)
return: int

bbp_reply_content_autoembed()   X-Ref
Check if autoembeds are enabled and hook them in if so

since: 2.1.0 bbPress (r3752)

_bbp_has_replies_where( $where = '', $query = false )   X-Ref
Used by bbp_has_replies() to add the lead topic post to the posts loop

This function filters the 'post_where' of the WP_Query, and changes the query
to include both the topic AND its children in the same loop.

param: string $where
since: 2.1.0 bbPress (r4058)
return: string

bbp_display_replies_feed_rss2( $replies_query = array()   X-Ref
Output an RSS2 feed of replies, based on the query passed.

param: array $replies_query
since: 2.0.0 bbPress (r3171)

bbp_check_reply_edit()   X-Ref
Redirect if unauthorized user is attempting to edit a reply

since: 2.1.0 bbPress (r3605)

bbp_update_reply_position( $reply_id = 0, $reply_position = false )   X-Ref
Update the position of the reply.

The reply position is stored in the menu_order column of the posts table.
This is done to prevent using a meta_query to retrieve posts in the proper
freshness order. By updating the menu_order accordingly, we're able to
leverage core WordPress query ordering much more effectively.

param: int $reply_id
param: int $reply_position
since: 2.1.0 bbPress (r3933)
return: mixed

bbp_get_reply_position_raw( $reply_id = 0, $topic_id = 0 )   X-Ref
Get the position of a reply by querying the DB directly for the replies
of a given topic.

param: int $reply_id
param: int $topic_id
since: 2.1.0 bbPress (r3933)

bbp_thread_replies()   X-Ref
Are replies threaded?

param: bool $default Optional. Default value true
since: 2.4.0 bbPress (r4944)
since: 2.6.0 bbPress (r6245) Always false on user profile reply pages
return: bool Are replies threaded?

bbp_list_replies( $args = array()   X-Ref
List threaded replies

since: 2.4.0 bbPress (r4944)

bbp_validate_reply_to( $reply_to = 0, $reply_id = 0 )   X-Ref
Validate a `reply_to` field for hierarchical replies

Checks for 2 scenarios:
-- The reply to ID is actually a reply
-- The reply to ID does not match the current reply

param: int $reply_to
param: int $reply_id
since: 2.5.4 bbPress (r5377)
return: int $reply_to



Generated: Mon Jul 22 01:01:32 2019 Cross-referenced by PHPXref 0.7.1