Skip to:
Content

BuddyPress.org

Changeset 13511


Ignore:
Timestamp:
07/06/2023 05:16:19 AM (12 months ago)
Author:
imath
Message:

Improve inline doc for the BP_Component::setup_globals() method

Fixes #8930
Closes https://github.com/buddypress/buddypress/pull/124

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/bp-core/classes/class-bp-component.php

    r13492 r13511  
    264264     *
    265265     * @since 1.5.0
     266     * @since 2.0.0 Adds the `$directory_title` argument to the `$args` parameter.
    266267     * @since 9.0.0 Adds the `$block_globals` argument to the `$args` parameter.
     268     * @since 12.0.0 Adds the `$rewrite_ids` argument to the `$args` parameter.
    267269     *
    268270     * @param array $args {
     
    275277     *                                           if one is found, otherwise an empty string.
    276278     *     @type bool     $has_directory         Set to true if the component requires an associated WordPress page.
    277      *     @type callable $notification_callback Optional. The callable function that formats the component's notifications.
    278      *     @type string   $search_term           Optional. The placeholder text in the component directory search box. Eg,
    279      *                                           'Search Groups...'.
    280      *     @type array    $global_tables         Optional. An array of database table names.
    281      *     @type array    $meta_tables           Optional. An array of metadata table names.
    282      *     @type array    $block_globals         Optional. An array of globalized data for BP Blocks.
     279     *     @type array    $rewrite_ids           The list of rewrited IDs to use for the component.
     280     *     @type string   $directory_title       The title to use for the directory page.
     281     *     @type callable $notification_callback The callable function that formats the component's notifications.
     282     *     @type string   $search_string         The placeholder text for the directory search box. Eg: 'Search Groups...'.
     283     *     @type array    $global_tables         An array of database table names.
     284     *     @type array    $meta_tables           An array of metadata table names.
     285     *     @type array    $block_globals         An array of globalized data for BP Blocks.
    283286     * }
    284287     */
Note: See TracChangeset for help on using the changeset viewer.