| @@ -1,8 +1,8 @@ | ||
| 1 | 1 | <?php |
| 2 | 2 | |
| 3 | 3 | /** |
| 4 | - * bbPress Options. | |
| 4 | + * bbPress Options | |
| 5 | 5 | * |
| 6 | 6 | * @package bbPress |
| 7 | 7 | * @subpackage Core |
| 8 | 8 | */ |
| @@ -16,9 +16,9 @@ | ||
| 16 | 16 | * These option |
| 17 | 17 | * |
| 18 | 18 | * @since 2.0.0 bbPress (r3421) |
| 19 | 19 | * |
| 20 | - * @return array Filtered option names and values. | |
| 20 | + * @return array Filtered option names and values | |
| 21 | 21 | */ |
| 22 | 22 | function bbp_get_default_options() { |
| 23 | 23 | static $options = null; |
| 24 | 24 | |
| @@ -154,9 +154,9 @@ | ||
| 154 | 154 | return (array) apply_filters( 'bbp_get_default_options', $options ); |
| 155 | 155 | } |
| 156 | 156 | |
| 157 | 157 | /** |
| 158 | - * Add default options. | |
| 158 | + * Add default options | |
| 159 | 159 | * |
| 160 | 160 | * Hooked to bbp_activate, it is only called once when bbPress is activated. |
| 161 | 161 | * This is non-destructive, so existing settings will not be overridden. |
| 162 | 162 | * |
| @@ -173,9 +173,9 @@ | ||
| 173 | 173 | do_action( 'bbp_add_options' ); |
| 174 | 174 | } |
| 175 | 175 | |
| 176 | 176 | /** |
| 177 | - * Delete default options. | |
| 177 | + * Delete default options | |
| 178 | 178 | * |
| 179 | 179 | * Hooked to bbp_uninstall, it is only called once when bbPress is uninstalled. |
| 180 | 180 | * This is destructive, so existing settings will be destroyed. |
| 181 | 181 | * |
| @@ -217,12 +217,12 @@ | ||
| 217 | 217 | * |
| 218 | 218 | * @since 2.0.0 bbPress (r3451) |
| 219 | 219 | * @access private |
| 220 | 220 | * |
| 221 | - * @param bool $value Default value false. | |
| 222 | - * @param string $option Name of the option. | |
| 221 | + * @param bool $value Default value false | |
| 222 | + * @param string $option Name of the option | |
| 223 | 223 | * |
| 224 | - * @return mixed false if not overloaded, mixed if set. | |
| 224 | + * @return mixed false if not overloaded, mixed if set | |
| 225 | 225 | */ |
| 226 | 226 | function bbp_filter_pre_get_option( $value = false, $option = '' ) { |
| 227 | 227 | |
| 228 | 228 | // Check the options global for preset value |
| @@ -241,10 +241,10 @@ | ||
| 241 | 241 | * |
| 242 | 242 | * @since 2.6.0 bbPress (r3451) |
| 243 | 243 | * @access private |
| 244 | 244 | * |
| 245 | - * @param bool $value Optional. Default value false. | |
| 246 | - * @return mixed false if not overloaded, mixed if set. | |
| 245 | + * @param bool $value Optional. Default value false | |
| 246 | + * @return mixed false if not overloaded, mixed if set | |
| 247 | 247 | */ |
| 248 | 248 | function bbp_filter_default_option( $default = false, $option = '', $passed_default = false ) { |
| 249 | 249 | $options = bbp_get_default_options(); |
| 250 | 250 | |
| @@ -326,10 +326,10 @@ | ||
| 326 | 326 | * Checks if favorites feature is enabled. |
| 327 | 327 | * |
| 328 | 328 | * @since 2.0.0 bbPress (r2658) |
| 329 | 329 | * |
| 330 | - * @param bool $default Optional.Default value true. | |
| 331 | - * @return bool Is favorites enabled or not. | |
| 330 | + * @param bool $default Optional.Default value true | |
| 331 | + * @return bool Is favorites enabled or not | |
| 332 | 332 | */ |
| 333 | 333 | function bbp_is_favorites_active( $default = 1 ) { |
| 334 | 334 | |
| 335 | 335 | // Filter & return |
| @@ -340,10 +340,10 @@ | ||
| 340 | 340 | * Checks if subscription feature is enabled. |
| 341 | 341 | * |
| 342 | 342 | * @since 2.0.0 bbPress (r2658) |
| 343 | 343 | * |
| 344 | - * @param bool $default Optional.Default value true. | |
| 345 | - * @return bool Is subscription enabled or not. | |
| 344 | + * @param bool $default Optional.Default value true | |
| 345 | + * @return bool Is subscription enabled or not | |
| 346 | 346 | */ |
| 347 | 347 | function bbp_is_subscriptions_active( $default = 1 ) { |
| 348 | 348 | |
| 349 | 349 | // Filter & return |
| @@ -354,10 +354,10 @@ | ||
| 354 | 354 | * Checks if engagements feature is enabled. |
| 355 | 355 | * |
| 356 | 356 | * @since 2.6.0 bbPress (r6320) |
| 357 | 357 | * |
| 358 | - * @param bool $default Optional.Default value true. | |
| 359 | - * @return bool Is engagements enabled or not. | |
| 358 | + * @param bool $default Optional.Default value true | |
| 359 | + * @return bool Is engagements enabled or not | |
| 360 | 360 | */ |
| 361 | 361 | function bbp_is_engagements_active( $default = 1 ) { |
| 362 | 362 | |
| 363 | 363 | // Filter & return |
| @@ -368,9 +368,9 @@ | ||
| 368 | 368 | * Is content editing available when posting new topics & replies? |
| 369 | 369 | * |
| 370 | 370 | * @since 2.6.0 bbPress (r6441) |
| 371 | 371 | * |
| 372 | - * @param bool $default Optional. Default value false. | |
| 372 | + * @param bool $default Optional. Default value false | |
| 373 | 373 | * @return bool Is content editing allowed? |
| 374 | 374 | */ |
| 375 | 375 | function bbp_allow_content_edit( $default = 1 ) { |
| 376 | 376 | |
| @@ -382,9 +382,9 @@ | ||
| 382 | 382 | * Is content throttling engaged when posting new topics & replies? |
| 383 | 383 | * |
| 384 | 384 | * @since 2.6.0 bbPress (r6441) |
| 385 | 385 | * |
| 386 | - * @param bool $default Optional. Default value false. | |
| 386 | + * @param bool $default Optional. Default value false | |
| 387 | 387 | * @return bool Is content throttling allowed? |
| 388 | 388 | */ |
| 389 | 389 | function bbp_allow_content_throttle( $default = 1 ) { |
| 390 | 390 | |
| @@ -392,13 +392,13 @@ | ||
| 392 | 392 | return (bool) apply_filters( 'bbp_allow_content_throttle', (bool) get_option( '_bbp_allow_content_throttle', $default ) ); |
| 393 | 393 | } |
| 394 | 394 | |
| 395 | 395 | /** |
| 396 | - * Are topic tags allowed. | |
| 396 | + * Are topic tags allowed | |
| 397 | 397 | * |
| 398 | 398 | * @since 2.2.0 bbPress (r4097) |
| 399 | 399 | * |
| 400 | - * @param bool $default Optional. Default value true. | |
| 400 | + * @param bool $default Optional. Default value true | |
| 401 | 401 | * @return bool Are tags allowed? |
| 402 | 402 | */ |
| 403 | 403 | function bbp_allow_topic_tags( $default = 1 ) { |
| 404 | 404 | |
| @@ -406,9 +406,9 @@ | ||
| 406 | 406 | return (bool) apply_filters( 'bbp_allow_topic_tags', (bool) get_option( '_bbp_allow_topic_tags', $default ) ); |
| 407 | 407 | } |
| 408 | 408 | |
| 409 | 409 | /** |
| 410 | - * Are per-forum moderators allowed. | |
| 410 | + * Are per-forum moderators allowed | |
| 411 | 411 | * |
| 412 | 412 | * @since 2.6.0 bbPress (r5834) |
| 413 | 413 | * |
| 414 | 414 | * @param bool $default Optional. Default value true. |
| @@ -421,9 +421,9 @@ | ||
| 421 | 421 | return (bool) apply_filters( 'bbp_allow_forum_mods', (bool) get_option( '_bbp_allow_forum_mods', $default ) ); |
| 422 | 422 | } |
| 423 | 423 | |
| 424 | 424 | /** |
| 425 | - * Are moderators allowed to edit users. | |
| 425 | + * Are moderators allowed to edit users | |
| 426 | 426 | * |
| 427 | 427 | * @since 2.6.0 bbPress (r6562) |
| 428 | 428 | * |
| 429 | 429 | * @param bool $default Optional. Default value true. |
| @@ -436,13 +436,13 @@ | ||
| 436 | 436 | return (bool) apply_filters( 'bbp_allow_super_mods', (bool) get_option( '_bbp_allow_super_mods', $default ) ); |
| 437 | 437 | } |
| 438 | 438 | |
| 439 | 439 | /** |
| 440 | - * Is forum-wide searching allowed. | |
| 440 | + * Is forum-wide searching allowed | |
| 441 | 441 | * |
| 442 | 442 | * @since 2.4.0 bbPress (r4970) |
| 443 | 443 | * |
| 444 | - * @param bool $default Optional. Default value true. | |
| 444 | + * @param bool $default Optional. Default value true | |
| 445 | 445 | * @return bool Is forum-wide searching allowed? |
| 446 | 446 | */ |
| 447 | 447 | function bbp_allow_search( $default = 1 ) { |
| 448 | 448 | |
| @@ -450,13 +450,13 @@ | ||
| 450 | 450 | return (bool) apply_filters( 'bbp_allow_search', (bool) get_option( '_bbp_allow_search', $default ) ); |
| 451 | 451 | } |
| 452 | 452 | |
| 453 | 453 | /** |
| 454 | - * Are threaded replies allowed. | |
| 454 | + * Are threaded replies allowed | |
| 455 | 455 | * |
| 456 | 456 | * @since 2.4.0 bbPress (r4964) |
| 457 | 457 | * |
| 458 | - * @param bool $default Optional. Default value false. | |
| 458 | + * @param bool $default Optional. Default value false | |
| 459 | 459 | * @return bool Are threaded replies allowed? |
| 460 | 460 | */ |
| 461 | 461 | function bbp_allow_threaded_replies( $default = 0 ) { |
| 462 | 462 | |
| @@ -464,14 +464,14 @@ | ||
| 464 | 464 | return (bool) apply_filters( '_bbp_allow_threaded_replies', (bool) get_option( '_bbp_allow_threaded_replies', $default ) ); |
| 465 | 465 | } |
| 466 | 466 | |
| 467 | 467 | /** |
| 468 | - * Maximum reply thread depth. | |
| 468 | + * Maximum reply thread depth | |
| 469 | 469 | * |
| 470 | 470 | * @since 2.4.0 bbPress (r4944) |
| 471 | 471 | * |
| 472 | - * @param int $default Thread replies depth. | |
| 473 | - * @return int Thread replies depth. | |
| 472 | + * @param int $default Thread replies depth | |
| 473 | + * @return int Thread replies depth | |
| 474 | 474 | */ |
| 475 | 475 | function bbp_thread_replies_depth( $default = 2 ) { |
| 476 | 476 | |
| 477 | 477 | // Filter & return |
| @@ -478,13 +478,13 @@ | ||
| 478 | 478 | return (int) apply_filters( 'bbp_thread_replies_depth', (int) get_option( '_bbp_thread_replies_depth', $default ) ); |
| 479 | 479 | } |
| 480 | 480 | |
| 481 | 481 | /** |
| 482 | - * Are topic and reply revisions allowed. | |
| 482 | + * Are topic and reply revisions allowed | |
| 483 | 483 | * |
| 484 | 484 | * @since 2.0.0 bbPress (r3412) |
| 485 | 485 | * |
| 486 | - * @param bool $default Optional. Default value true. | |
| 486 | + * @param bool $default Optional. Default value true | |
| 487 | 487 | * @return bool Are revisions allowed? |
| 488 | 488 | */ |
| 489 | 489 | function bbp_allow_revisions( $default = 1 ) { |
| 490 | 490 | |
| @@ -496,9 +496,9 @@ | ||
| 496 | 496 | * Is the anonymous posting allowed? |
| 497 | 497 | * |
| 498 | 498 | * @since 2.0.0 bbPress (r2659) |
| 499 | 499 | * |
| 500 | - * @param bool $default Optional. Default value. | |
| 500 | + * @param bool $default Optional. Default value | |
| 501 | 501 | * @return bool Is anonymous posting allowed? |
| 502 | 502 | */ |
| 503 | 503 | function bbp_allow_anonymous( $default = 0 ) { |
| 504 | 504 | |
| @@ -510,9 +510,9 @@ | ||
| 510 | 510 | * Is this forum available to all users on all sites in this installation? |
| 511 | 511 | * |
| 512 | 512 | * @since 2.0.0 bbPress (r3378) |
| 513 | 513 | * |
| 514 | - * @param bool $default Optional. Default value false. | |
| 514 | + * @param bool $default Optional. Default value false | |
| 515 | 515 | * @return bool Is global access allowed? |
| 516 | 516 | */ |
| 517 | 517 | function bbp_allow_global_access( $default = 1 ) { |
| 518 | 518 | |
| @@ -521,14 +521,14 @@ | ||
| 521 | 521 | } |
| 522 | 522 | |
| 523 | 523 | /** |
| 524 | 524 | * Get the default forums role (issued to users on their first visit to the |
| 525 | - * forums) by bbp_set_current_user_default_role() and repair tools. | |
| 525 | + * forums) by bbp_set_current_user_default_role() and repair tools | |
| 526 | 526 | * |
| 527 | 527 | * @since 2.2.0 bbPress (r4294) |
| 528 | 528 | * |
| 529 | - * @param string $default Optional. Default value empty. | |
| 530 | - * @return string The default forums user role. | |
| 529 | + * @param string $default Optional. Default value empty | |
| 530 | + * @return string The default forums user role | |
| 531 | 531 | */ |
| 532 | 532 | function bbp_get_default_role( $default = 'bbp_participant' ) { |
| 533 | 533 | |
| 534 | 534 | // Filter & return |
| @@ -535,13 +535,13 @@ | ||
| 535 | 535 | return apply_filters( 'bbp_get_default_role', get_option( '_bbp_default_role', $default ) ); |
| 536 | 536 | } |
| 537 | 537 | |
| 538 | 538 | /** |
| 539 | - * Use the WordPress editor if available. | |
| 539 | + * Use the WordPress editor if available | |
| 540 | 540 | * |
| 541 | 541 | * @since 2.0.0 bbPress (r3386) |
| 542 | 542 | * |
| 543 | - * @param bool $default Optional. Default value true. | |
| 543 | + * @param bool $default Optional. Default value true | |
| 544 | 544 | * @return bool Use WP editor? |
| 545 | 545 | */ |
| 546 | 546 | function bbp_use_wp_editor( $default = 1 ) { |
| 547 | 547 | |
| @@ -549,13 +549,13 @@ | ||
| 549 | 549 | return (bool) apply_filters( 'bbp_use_wp_editor', (bool) get_option( '_bbp_use_wp_editor', $default ) ); |
| 550 | 550 | } |
| 551 | 551 | |
| 552 | 552 | /** |
| 553 | - * Use WordPress's oEmbed API. | |
| 553 | + * Use WordPress's oEmbed API | |
| 554 | 554 | * |
| 555 | 555 | * @since 2.1.0 bbPress (r3752) |
| 556 | 556 | * |
| 557 | - * @param bool $default Optional. Default value true. | |
| 557 | + * @param bool $default Optional. Default value true | |
| 558 | 558 | * @return bool Use oEmbed? |
| 559 | 559 | */ |
| 560 | 560 | function bbp_use_autoembed( $default = 1 ) { |
| 561 | 561 | |
| @@ -563,14 +563,14 @@ | ||
| 563 | 563 | return (bool) apply_filters( 'bbp_use_autoembed', (bool) get_option( '_bbp_use_autoembed', $default ) ); |
| 564 | 564 | } |
| 565 | 565 | |
| 566 | 566 | /** |
| 567 | - * Get the current theme package ID. | |
| 567 | + * Get the current theme package ID | |
| 568 | 568 | * |
| 569 | 569 | * @since 2.1.0 bbPress (r3829) |
| 570 | 570 | * |
| 571 | - * @param string $default Optional. Default value 'default'. | |
| 572 | - * @return string ID of the theme-package. | |
| 571 | + * @param string $default Optional. Default value 'default' | |
| 572 | + * @return string ID of the theme-package | |
| 573 | 573 | */ |
| 574 | 574 | function bbp_get_theme_package_id( $default = 'default' ) { |
| 575 | 575 | |
| 576 | 576 | // Filter & return |
| @@ -577,32 +577,31 @@ | ||
| 577 | 577 | return apply_filters( 'bbp_get_theme_package_id', get_option( '_bbp_theme_package_id', $default ) ); |
| 578 | 578 | } |
| 579 | 579 | |
| 580 | 580 | /** |
| 581 | - * Output the maximum length of a title. | |
| 581 | + * Output the maximum length of a title | |
| 582 | 582 | * |
| 583 | 583 | * @since 2.0.0 bbPress (r3246) |
| 584 | 584 | * |
| 585 | - * @param bool $default Optional. Default value 80. | |
| 585 | + * @param bool $default Optional. Default value 80 | |
| 586 | 586 | */ |
| 587 | 587 | function bbp_title_max_length( $default = 80 ) { |
| 588 | 588 | echo bbp_get_title_max_length( $default ); |
| 589 | 589 | } |
| 590 | + /** | |
| 591 | + * Return the maximum length of a title | |
| 592 | + * | |
| 593 | + * @since 2.0.0 bbPress (r3246) | |
| 594 | + * | |
| 595 | + * @param bool $default Optional. Default value 80 | |
| 596 | + * @return int Is anonymous posting allowed? | |
| 597 | + */ | |
| 598 | + function bbp_get_title_max_length( $default = 80 ) { | |
| 590 | 599 | |
| 591 | -/** | |
| 592 | - * Return the maximum length of a title. | |
| 593 | - * | |
| 594 | - * @since 2.0.0 bbPress (r3246) | |
| 595 | - * | |
| 596 | - * @param bool $default Optional. Default value 80. | |
| 597 | - * @return int Is anonymous posting allowed? | |
| 598 | - */ | |
| 599 | -function bbp_get_title_max_length( $default = 80 ) { | |
| 600 | + // Filter & return | |
| 601 | + return (int) apply_filters( 'bbp_get_title_max_length', (int) get_option( '_bbp_title_max_length', $default ) ); | |
| 602 | + } | |
| 600 | 603 | |
| 601 | - // Filter & return | |
| 602 | - return (int) apply_filters( 'bbp_get_title_max_length', (int) get_option( '_bbp_title_max_length', $default ) ); | |
| 603 | -} | |
| 604 | - | |
| 605 | 604 | /** |
| 606 | 605 | * Output the number of minutes a topic or reply can be edited after it's |
| 607 | 606 | * published. Used by `bbp_past_edit_lock()`. |
| 608 | 607 | * |
| @@ -607,61 +606,59 @@ | ||
| 607 | 606 | * published. Used by `bbp_past_edit_lock()`. |
| 608 | 607 | * |
| 609 | 608 | * @since 2.6.0 bbPress (r6868) |
| 610 | 609 | * |
| 611 | - * @param bool $default Optional. Default value 5. | |
| 610 | + * @param bool $default Optional. Default value 5 | |
| 612 | 611 | */ |
| 613 | 612 | function bbp_edit_lock( $default = 5 ) { |
| 614 | 613 | echo bbp_get_edit_lock( $default ); |
| 615 | 614 | } |
| 615 | + /** | |
| 616 | + * Return the number of minutes a topic or reply can be edited after it's | |
| 617 | + * published. Used by `bbp_past_edit_lock()`. | |
| 618 | + * | |
| 619 | + * @since 2.6.0 bbPress (r6868) | |
| 620 | + * | |
| 621 | + * @param bool $default Optional. Default value 5 | |
| 622 | + * @return int Is anonymous posting allowed? | |
| 623 | + */ | |
| 624 | + function bbp_get_edit_lock( $default = 5 ) { | |
| 616 | 625 | |
| 617 | -/** | |
| 618 | - * Return the number of minutes a topic or reply can be edited after it's | |
| 619 | - * published. Used by `bbp_past_edit_lock()`. | |
| 620 | - * | |
| 621 | - * @since 2.6.0 bbPress (r6868) | |
| 622 | - * | |
| 623 | - * @param bool $default Optional. Default value 5. | |
| 624 | - * @return int Is anonymous posting allowed? | |
| 625 | - */ | |
| 626 | -function bbp_get_edit_lock( $default = 5 ) { | |
| 626 | + // Filter & return | |
| 627 | + return (int) apply_filters( 'bbp_get_edit_lock', (int) get_option( '_bbp_edit_lock', $default ) ); | |
| 628 | + } | |
| 627 | 629 | |
| 628 | - // Filter & return | |
| 629 | - return (int) apply_filters( 'bbp_get_edit_lock', (int) get_option( '_bbp_edit_lock', $default ) ); | |
| 630 | -} | |
| 631 | - | |
| 632 | 630 | /** |
| 633 | - * Output the group forums root parent forum id. | |
| 631 | + * Output the group forums root parent forum id | |
| 634 | 632 | * |
| 635 | 633 | * @since 2.1.0 bbPress (r3575) |
| 636 | 634 | * |
| 637 | - * @param int $default Optional. Default value. | |
| 635 | + * @param int $default Optional. Default value | |
| 638 | 636 | */ |
| 639 | 637 | function bbp_group_forums_root_id( $default = 0 ) { |
| 640 | 638 | echo bbp_get_group_forums_root_id( $default ); |
| 641 | 639 | } |
| 640 | + /** | |
| 641 | + * Return the group forums root parent forum id | |
| 642 | + * | |
| 643 | + * @since 2.1.0 bbPress (r3575) | |
| 644 | + * | |
| 645 | + * @param bool $default Optional. Default value 0 | |
| 646 | + * @return int The post ID for the root forum | |
| 647 | + */ | |
| 648 | + function bbp_get_group_forums_root_id( $default = 0 ) { | |
| 642 | 649 | |
| 643 | -/** | |
| 644 | - * Return the group forums root parent forum id. | |
| 645 | - * | |
| 646 | - * @since 2.1.0 bbPress (r3575) | |
| 647 | - * | |
| 648 | - * @param bool $default Optional. Default value 0. | |
| 649 | - * @return int The post ID for the root forum. | |
| 650 | - */ | |
| 651 | -function bbp_get_group_forums_root_id( $default = 0 ) { | |
| 650 | + // Filter & return | |
| 651 | + return (int) apply_filters( 'bbp_get_group_forums_root_id', (int) get_option( '_bbp_group_forums_root_id', $default ) ); | |
| 652 | + } | |
| 652 | 653 | |
| 653 | - // Filter & return | |
| 654 | - return (int) apply_filters( 'bbp_get_group_forums_root_id', (int) get_option( '_bbp_group_forums_root_id', $default ) ); | |
| 655 | -} | |
| 656 | - | |
| 657 | 654 | /** |
| 658 | - * Checks if BuddyPress Group Forums are enabled. | |
| 655 | + * Checks if BuddyPress Group Forums are enabled | |
| 659 | 656 | * |
| 660 | 657 | * @since 2.1.0 bbPress (r3575) |
| 661 | 658 | * |
| 662 | - * @param bool $default Optional. Default value true. | |
| 663 | - * @return bool Is group forums enabled or not. | |
| 659 | + * @param bool $default Optional. Default value true | |
| 660 | + * @return bool Is group forums enabled or not | |
| 664 | 661 | */ |
| 665 | 662 | function bbp_is_group_forums_active( $default = 1 ) { |
| 666 | 663 | |
| 667 | 664 | // Filter & return |
| @@ -668,14 +665,14 @@ | ||
| 668 | 665 | return (bool) apply_filters( 'bbp_is_group_forums_active', (bool) get_option( '_bbp_enable_group_forums', $default ) ); |
| 669 | 666 | } |
| 670 | 667 | |
| 671 | 668 | /** |
| 672 | - * Checks if Akismet is enabled. | |
| 669 | + * Checks if Akismet is enabled | |
| 673 | 670 | * |
| 674 | 671 | * @since 2.1.0 bbPress (r3575) |
| 675 | 672 | * |
| 676 | - * @param bool $default Optional. Default value true. | |
| 677 | - * @return bool Is Akismet enabled or not. | |
| 673 | + * @param bool $default Optional. Default value true | |
| 674 | + * @return bool Is Akismet enabled or not | |
| 678 | 675 | */ |
| 679 | 676 | function bbp_is_akismet_active( $default = 1 ) { |
| 680 | 677 | |
| 681 | 678 | // Filter & return |
| @@ -682,9 +679,9 @@ | ||
| 682 | 679 | return (bool) apply_filters( 'bbp_is_akismet_active', (bool) get_option( '_bbp_enable_akismet', $default ) ); |
| 683 | 680 | } |
| 684 | 681 | |
| 685 | 682 | /** |
| 686 | - * Integrate settings into existing WordPress pages. | |
| 683 | + * Integrate settings into existing WordPress pages | |
| 687 | 684 | * |
| 688 | 685 | * There are 3 possible modes: |
| 689 | 686 | * - 'basic' Traditional admin integration |
| 690 | 687 | * - 'compact' One "bbPress" top-level admin menu |
| @@ -691,10 +688,10 @@ | ||
| 691 | 688 | * - 'deep' Deeply integrate with the WordPress admin interface |
| 692 | 689 | * |
| 693 | 690 | * @since 2.4.0 bbPress (r4932) |
| 694 | 691 | * |
| 695 | - * @param bool $default Optional. Default value false. | |
| 696 | - * @return string How to integrate settings. | |
| 692 | + * @param bool $default Optional. Default value false | |
| 693 | + * @return string How to integrate settings | |
| 697 | 694 | */ |
| 698 | 695 | function bbp_settings_integration( $default = 'basic' ) { |
| 699 | 696 | |
| 700 | 697 | // Get the option value |
| @@ -716,9 +713,9 @@ | ||
| 716 | 713 | return apply_filters( 'bbp_settings_integration', $integration, $default ); |
| 717 | 714 | } |
| 718 | 715 | |
| 719 | 716 | /** |
| 720 | - * How to interact with engagements. | |
| 717 | + * How to interact with engagements | |
| 721 | 718 | * |
| 722 | 719 | * There are 3 possible strategies: |
| 723 | 720 | * - 'meta' 2.6 and higher. Uses multiple postmeta keys. |
| 724 | 721 | * - 'user' Pre-2.6. Uses comma-separated string of IDs in usermeta. |
| @@ -725,10 +722,10 @@ | ||
| 725 | 722 | * - 'term' Alternate. Uses taxonomy term relationships. |
| 726 | 723 | * |
| 727 | 724 | * @since 2.6.0 bbPress (r6875) |
| 728 | 725 | * |
| 729 | - * @param bool $default Optional. Default value false. | |
| 730 | - * @return string How to interact with engagements. | |
| 726 | + * @param bool $default Optional. Default value false | |
| 727 | + * @return string How to interact with engagements | |
| 731 | 728 | */ |
| 732 | 729 | function bbp_engagements_strategy( $default = 'meta' ) { |
| 733 | 730 | |
| 734 | 731 | // Get the option value |
| @@ -748,13 +745,13 @@ | ||
| 748 | 745 | |
| 749 | 746 | /** Slugs *********************************************************************/ |
| 750 | 747 | |
| 751 | 748 | /** |
| 752 | - * Return the root slug. | |
| 749 | + * Return the root slug | |
| 753 | 750 | * |
| 754 | 751 | * @since 2.1.0 bbPress (r3759) |
| 755 | 752 | * |
| 756 | - * @param string $default Optional. Default value 'forums'. | |
| 753 | + * @param string $default Optional. Default value 'forums' | |
| 757 | 754 | * @return string |
| 758 | 755 | */ |
| 759 | 756 | function bbp_get_root_slug( $default = 'forums' ) { |
| 760 | 757 | |
| @@ -766,9 +763,9 @@ | ||
| 766 | 763 | * Are we including the root slug in front of forum pages? |
| 767 | 764 | * |
| 768 | 765 | * @since 2.1.0 bbPress (r3759) |
| 769 | 766 | * |
| 770 | - * @param bool $default Optional. Default value true. | |
| 767 | + * @param bool $default Optional. Default value true | |
| 771 | 768 | * @return bool |
| 772 | 769 | */ |
| 773 | 770 | function bbp_include_root_slug( $default = 1 ) { |
| 774 | 771 | |
| @@ -780,9 +777,9 @@ | ||
| 780 | 777 | * What to show on root, forums or topics? |
| 781 | 778 | * |
| 782 | 779 | * @since 2.4.0 bbPress (r4932) |
| 783 | 780 | * |
| 784 | - * @param string $default Optional. Default value 'forums'. | |
| 781 | + * @param string $default Optional. Default value 'forums' | |
| 785 | 782 | * @return string |
| 786 | 783 | */ |
| 787 | 784 | function bbp_show_on_root( $default = 'forums' ) { |
| 788 | 785 | |
| @@ -790,13 +787,13 @@ | ||
| 790 | 787 | return apply_filters( 'bbp_show_on_root', get_option( '_bbp_show_on_root', $default ) ); |
| 791 | 788 | } |
| 792 | 789 | |
| 793 | 790 | /** |
| 794 | - * Maybe return the root slug, based on whether or not it's included in the url. | |
| 791 | + * Maybe return the root slug, based on whether or not it's included in the url | |
| 795 | 792 | * |
| 796 | 793 | * @since 2.1.0 bbPress (r3759) |
| 797 | 794 | * |
| 798 | - * @param string $default Optional. Default value 'forums'. | |
| 795 | + * @param string $default Optional. Default value 'forums' | |
| 799 | 796 | * @return string |
| 800 | 797 | */ |
| 801 | 798 | function bbp_maybe_get_root_slug() { |
| 802 | 799 | $slug = bbp_get_root_slug(); |
| @@ -808,13 +805,13 @@ | ||
| 808 | 805 | return apply_filters( 'bbp_maybe_get_root_slug', $retval ); |
| 809 | 806 | } |
| 810 | 807 | |
| 811 | 808 | /** |
| 812 | - * Return the single forum slug. | |
| 809 | + * Return the single forum slug | |
| 813 | 810 | * |
| 814 | 811 | * @since 2.1.0 bbPress (r3759) |
| 815 | 812 | * |
| 816 | - * @param string $default Optional. Default value 'forum'. | |
| 813 | + * @param string $default Optional. Default value 'forum' | |
| 817 | 814 | * @return string |
| 818 | 815 | */ |
| 819 | 816 | function bbp_get_forum_slug( $default = 'forum' ) { |
| 820 | 817 | |
| @@ -822,13 +819,13 @@ | ||
| 822 | 819 | return apply_filters( 'bbp_get_forum_slug', bbp_maybe_get_root_slug() . get_option( '_bbp_forum_slug', $default ) ); |
| 823 | 820 | } |
| 824 | 821 | |
| 825 | 822 | /** |
| 826 | - * Return the topic archive slug. | |
| 823 | + * Return the topic archive slug | |
| 827 | 824 | * |
| 828 | 825 | * @since 2.1.0 bbPress (r3759) |
| 829 | 826 | * |
| 830 | - * @param string $default Optional. Default value 'topics'. | |
| 827 | + * @param string $default Optional. Default value 'topics' | |
| 831 | 828 | * @return string |
| 832 | 829 | */ |
| 833 | 830 | function bbp_get_topic_archive_slug( $default = 'topics' ) { |
| 834 | 831 | |
| @@ -836,13 +833,13 @@ | ||
| 836 | 833 | return apply_filters( 'bbp_get_topic_archive_slug', get_option( '_bbp_topic_archive_slug', $default ) ); |
| 837 | 834 | } |
| 838 | 835 | |
| 839 | 836 | /** |
| 840 | - * Return the reply archive slug. | |
| 837 | + * Return the reply archive slug | |
| 841 | 838 | * |
| 842 | 839 | * @since 2.4.0 bbPress (r4925) |
| 843 | 840 | * |
| 844 | - * @param string $default Optional. Default value 'replies'. | |
| 841 | + * @param string $default Optional. Default value 'replies' | |
| 845 | 842 | * @return string |
| 846 | 843 | */ |
| 847 | 844 | function bbp_get_reply_archive_slug( $default = 'replies' ) { |
| 848 | 845 | |
| @@ -850,13 +847,13 @@ | ||
| 850 | 847 | return apply_filters( 'bbp_get_reply_archive_slug', get_option( '_bbp_reply_archive_slug', $default ) ); |
| 851 | 848 | } |
| 852 | 849 | |
| 853 | 850 | /** |
| 854 | - * Return the single topic slug. | |
| 851 | + * Return the single topic slug | |
| 855 | 852 | * |
| 856 | 853 | * @since 2.1.0 bbPress (r3759) |
| 857 | 854 | * |
| 858 | - * @param string $default Optional. Default value 'topic'. | |
| 855 | + * @param string $default Optional. Default value 'topic' | |
| 859 | 856 | * @return string |
| 860 | 857 | */ |
| 861 | 858 | function bbp_get_topic_slug( $default = 'topic' ) { |
| 862 | 859 | |
| @@ -864,13 +861,13 @@ | ||
| 864 | 861 | return apply_filters( 'bbp_get_topic_slug', bbp_maybe_get_root_slug() . get_option( '_bbp_topic_slug', $default ) ); |
| 865 | 862 | } |
| 866 | 863 | |
| 867 | 864 | /** |
| 868 | - * Return the topic-tag taxonomy slug. | |
| 865 | + * Return the topic-tag taxonomy slug | |
| 869 | 866 | * |
| 870 | 867 | * @since 2.1.0 bbPress (r3759) |
| 871 | 868 | * |
| 872 | - * @param string $default Optional. Default value 'topic-tag'. | |
| 869 | + * @param string $default Optional. Default value 'topic-tag' | |
| 873 | 870 | * @return string |
| 874 | 871 | */ |
| 875 | 872 | function bbp_get_topic_tag_tax_slug( $default = 'topic-tag' ) { |
| 876 | 873 | |
| @@ -878,13 +875,13 @@ | ||
| 878 | 875 | return apply_filters( 'bbp_get_topic_tag_tax_slug', bbp_maybe_get_root_slug() . get_option( '_bbp_topic_tag_slug', $default ) ); |
| 879 | 876 | } |
| 880 | 877 | |
| 881 | 878 | /** |
| 882 | - * Return the single reply slug (used mostly for editing). | |
| 879 | + * Return the single reply slug (used mostly for editing) | |
| 883 | 880 | * |
| 884 | 881 | * @since 2.1.0 bbPress (r3759) |
| 885 | 882 | * |
| 886 | - * @param string $default Optional. Default value 'reply'. | |
| 883 | + * @param string $default Optional. Default value 'reply' | |
| 887 | 884 | * @return string |
| 888 | 885 | */ |
| 889 | 886 | function bbp_get_reply_slug( $default = 'reply' ) { |
| 890 | 887 | |
| @@ -892,13 +889,13 @@ | ||
| 892 | 889 | return apply_filters( 'bbp_get_reply_slug', bbp_maybe_get_root_slug() . get_option( '_bbp_reply_slug', $default ) ); |
| 893 | 890 | } |
| 894 | 891 | |
| 895 | 892 | /** |
| 896 | - * Return the single user slug. | |
| 893 | + * Return the single user slug | |
| 897 | 894 | * |
| 898 | 895 | * @since 2.1.0 bbPress (r3759) |
| 899 | 896 | * |
| 900 | - * @param string $default Optional. Default value 'users'. | |
| 897 | + * @param string $default Optional. Default value 'users' | |
| 901 | 898 | * @return string |
| 902 | 899 | */ |
| 903 | 900 | function bbp_get_user_slug( $default = 'users' ) { |
| 904 | 901 | |
| @@ -906,13 +903,13 @@ | ||
| 906 | 903 | return apply_filters( 'bbp_get_user_slug', bbp_maybe_get_root_slug() . get_option( '_bbp_user_slug', $default ) ); |
| 907 | 904 | } |
| 908 | 905 | |
| 909 | 906 | /** |
| 910 | - * Return the single user favorites slug. | |
| 907 | + * Return the single user favorites slug | |
| 911 | 908 | * |
| 912 | 909 | * @since 2.2.0 bbPress (r4187) |
| 913 | 910 | * |
| 914 | - * @param string $default Optional. Default value 'favorites'. | |
| 911 | + * @param string $default Optional. Default value 'favorites' | |
| 915 | 912 | * @return string |
| 916 | 913 | */ |
| 917 | 914 | function bbp_get_user_favorites_slug( $default = 'favorites' ) { |
| 918 | 915 | |
| @@ -920,13 +917,13 @@ | ||
| 920 | 917 | return apply_filters( 'bbp_get_user_favorites_slug', get_option( '_bbp_user_favs_slug', $default ) ); |
| 921 | 918 | } |
| 922 | 919 | |
| 923 | 920 | /** |
| 924 | - * Return the single user subscriptions slug. | |
| 921 | + * Return the single user subscriptions slug | |
| 925 | 922 | * |
| 926 | 923 | * @since 2.2.0 bbPress (r4187) |
| 927 | 924 | * |
| 928 | - * @param string $default Optional. Default value 'subscriptions'. | |
| 925 | + * @param string $default Optional. Default value 'subscriptions' | |
| 929 | 926 | * @return string |
| 930 | 927 | */ |
| 931 | 928 | function bbp_get_user_subscriptions_slug( $default = 'subscriptions' ) { |
| 932 | 929 | |
| @@ -934,13 +931,13 @@ | ||
| 934 | 931 | return apply_filters( 'bbp_get_user_subscriptions_slug', get_option( '_bbp_user_subs_slug', $default ) ); |
| 935 | 932 | } |
| 936 | 933 | |
| 937 | 934 | /** |
| 938 | - * Return the single user engagements slug. | |
| 935 | + * Return the single user engagements slug | |
| 939 | 936 | * |
| 940 | 937 | * @since 2.6.0 bbPress (r6320) |
| 941 | 938 | * |
| 942 | - * @param string $default Optional. Default value 'engagements'. | |
| 939 | + * @param string $default Optional. Default value 'engagements' | |
| 943 | 940 | * @return string |
| 944 | 941 | */ |
| 945 | 942 | function bbp_get_user_engagements_slug( $default = 'engagements' ) { |
| 946 | 943 | |
| @@ -948,13 +945,13 @@ | ||
| 948 | 945 | return apply_filters( 'bbp_get_user_engagements_slug', get_option( '_bbp_user_engs_slug', $default ) ); |
| 949 | 946 | } |
| 950 | 947 | |
| 951 | 948 | /** |
| 952 | - * Return the topic view slug. | |
| 949 | + * Return the topic view slug | |
| 953 | 950 | * |
| 954 | 951 | * @since 2.1.0 bbPress (r3759) |
| 955 | 952 | * |
| 956 | - * @param string $default Optional. Default value 'view'. | |
| 953 | + * @param string $default Optional. Default value 'view' | |
| 957 | 954 | * @return string |
| 958 | 955 | */ |
| 959 | 956 | function bbp_get_view_slug( $default = 'view' ) { |
| 960 | 957 | |
| @@ -962,13 +959,13 @@ | ||
| 962 | 959 | return apply_filters( 'bbp_get_view_slug', bbp_maybe_get_root_slug() . get_option( '_bbp_view_slug', $default ) ); |
| 963 | 960 | } |
| 964 | 961 | |
| 965 | 962 | /** |
| 966 | - * Return the search slug. | |
| 963 | + * Return the search slug | |
| 967 | 964 | * |
| 968 | 965 | * @since 2.3.0 bbPress (r4579) |
| 969 | 966 | * |
| 970 | - * @param string $default Optional. Default value 'search'. | |
| 967 | + * @param string $default Optional. Default value 'search' | |
| 971 | 968 | * @return string |
| 972 | 969 | */ |
| 973 | 970 | function bbp_get_search_slug( $default = 'search' ) { |
| 974 | 971 | |
| @@ -976,13 +973,13 @@ | ||
| 976 | 973 | return apply_filters( 'bbp_get_search_slug', bbp_maybe_get_root_slug() . get_option( '_bbp_search_slug', $default ) ); |
| 977 | 974 | } |
| 978 | 975 | |
| 979 | 976 | /** |
| 980 | - * Return the edit slug. | |
| 977 | + * Return the edit slug | |
| 981 | 978 | * |
| 982 | 979 | * @since 2.6.2 bbPress (r6965) |
| 983 | 980 | * |
| 984 | - * @param string $default Optional. Default value 'edit'. | |
| 981 | + * @param string $default Optional. Default value 'edit' | |
| 985 | 982 | * @return string |
| 986 | 983 | */ |
| 987 | 984 | function bbp_get_edit_slug( $default = 'edit' ) { |
| 988 | 985 | |
| @@ -992,14 +989,14 @@ | ||
| 992 | 989 | |
| 993 | 990 | /** Legacy ********************************************************************/ |
| 994 | 991 | |
| 995 | 992 | /** |
| 996 | - * Checks if there is a previous BuddyPress Forum configuration. | |
| 993 | + * Checks if there is a previous BuddyPress Forum configuration | |
| 997 | 994 | * |
| 998 | 995 | * @since 2.1.0 bbPress (r3790) |
| 999 | 996 | * |
| 1000 | - * @param string $default Optional. Default empty string. | |
| 1001 | - * @return string The location of the bb-config.php file, if any. | |
| 997 | + * @param string $default Optional. Default empty string | |
| 998 | + * @return string The location of the bb-config.php file, if any | |
| 1002 | 999 | */ |
| 1003 | 1000 | function bbp_get_config_location( $default = '' ) { |
| 1004 | 1001 | |
| 1005 | 1002 | // Filter & return |
