[ Index ]

PHP Cross Reference of BBPress

title

Body

[close]

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

bbPress Updater

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

Defines 18 functions

  bbp_is_install()
  bbp_is_update()
  bbp_is_activation()
  bbp_is_deactivation()
  bbp_version_bump()
  bbp_setup_updater()
  bbp_setup_new_site()
  bbp_create_initial_content()
  bbp_version_updater()
  bbp_add_activation_redirect()
  bbp_do_activation_redirect()
  bbp_make_current_user_keymaster()
  bbp_get_pending_upgrade_count()
  bbp_get_pending_upgrades()
  bbp_add_pending_upgrade()
  bbp_remove_pending_upgrade()
  bbp_clear_pending_upgrades()
  bbp_maybe_append_pending_upgrade_count()

Functions
Functions that are not part of a class:

bbp_is_install()   X-Ref
If there is no raw DB version, this is the first installation

since: 2.1.0 bbPress (r3764)
return: bool True if update, False if not

bbp_is_update()   X-Ref
Compare the bbPress version to the DB version to determine if updating

since: 2.0.0 bbPress (r3421)
return: bool True if update, False if not

bbp_is_activation( $basename = '' )   X-Ref
Determine if bbPress is being activated

Note that this function currently is not used in bbPress core and is here
for third party plugins to use to check for bbPress activation.

since: 2.0.0 bbPress (r3421)
return: bool True if activating bbPress, false if not

bbp_is_deactivation( $basename = '' )   X-Ref
Determine if bbPress is being deactivated

since: 2.0.0 bbPress (r3421)
return: bool True if deactivating bbPress, false if not

bbp_version_bump()   X-Ref
Update the DB to the latest version

since: 2.0.0 bbPress (r3421)

bbp_setup_updater()   X-Ref
Setup the bbPress updater

since: 2.0.0 bbPress (r3419)

bbp_setup_new_site( $site_id = 0 )   X-Ref
Runs when a new site is created in a multisite network, and bbPress is active
on that site (hooked to `bbp_new_site`)

since: 2.6.0 bbPress (r6779)

bbp_create_initial_content( $args = array()   X-Ref
Create a default forum, topic, and reply

since: 2.1.0 bbPress (r3767)
param: array $args Array of arguments to override default values

bbp_version_updater()   X-Ref
The version updater looks at what the current database version is, and
runs whatever other code is needed.

This is most-often used when the data schema changes, but should also be used
to correct issues with bbPress meta-data silently on software update.

since: 2.2.0 bbPress (r4104)

bbp_add_activation_redirect()   X-Ref
Redirect user to the "What's New" page on activation

since: 2.2.0 bbPress (r4389)
return: If network admin or bulk activation

bbp_do_activation_redirect()   X-Ref
Redirect user to "What's New" page on activation

since: 2.2.0 bbPress (r4389)
return: If no transient, or in network admin, or is bulk activation

bbp_make_current_user_keymaster()   X-Ref
Hooked to the 'bbp_activate' action, this helper function automatically makes
the current user a Key Master in the forums if they just activated bbPress,
regardless of the bbp_allow_global_access() setting.

since: 2.4.0 bbPress (r4910)
return: If user can't activate plugins or is already a keymaster

bbp_get_pending_upgrade_count( $type = '' )   X-Ref
Return the number of pending upgrades

since: 2.6.0 bbPress (r6895)
return: int
param: string $type Type of pending upgrades (upgrade|repair|empty)

bbp_get_pending_upgrades( $type = '' )   X-Ref
Return an array of pending upgrades

since: 2.6.0 bbPress (r6895)
return: array
param: string $type Type of pending upgrades (upgrade|repair|empty)

bbp_add_pending_upgrade( $upgrade_id = '' )   X-Ref
Add an upgrade ID to pending upgrades array

since: 2.6.0 bbPress (r6895)
param: string $upgrade_id

bbp_remove_pending_upgrade( $upgrade_id = '' )   X-Ref
Add an upgrade ID to pending upgrades array

since: 2.6.0 bbPress (r6895)
param: string $upgrade_id

bbp_clear_pending_upgrades()   X-Ref
Delete all pending upgrades

since: 2.6.0 bbPress (r6895)

bbp_maybe_append_pending_upgrade_count( $string = '', $type = '' )   X-Ref
Maybe append an upgrade count to a string

since: 2.6.0 bbPress (r6896)
return: string
param: string $string Text to append count to
param: string $type   Type of pending upgrades (upgrade|repair|empty)



Generated: Tue May 26 01:01:19 2020 Cross-referenced by PHPXref 0.7.1