Contents

Code Reference Classes BP_REST_Document_Endpoint BP_REST_Document_Endpoint::bp_rest_document_default_scope()

BP_REST_Document_Endpoint::bp_rest_document_default_scope( string $scope, array $args )

Get default scope for the document.

Description

Parameters

$scope

(Required) Default scope.

$args

(Required) Array of document argument.

Return

(string)

Source

File: bp-document/classes/class-bp-rest-document-endpoint.php

1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
public function bp_rest_document_default_scope( $scope, $args ) {
    $new_scope = array();
 
    if ( ( 'all' === $scope || empty( $scope ) ) && ( empty( $args['group_id'] ) && empty( $args['user_id'] ) ) ) {
        $new_scope[] = 'public';
 
        if ( is_user_logged_in() ) {
            $new_scope[] = 'personal';
 
            if ( bp_is_active( 'friends' ) ) {
                $new_scope[] = 'friends';
            }
        }
 
        if ( bp_is_active( 'groups' ) ) {
            $new_scope[] = 'groups';
        }
    } elseif ( ! empty( $args['user_id'] ) && ( 'all' === $scope || empty( $scope ) ) ) {
        $new_scope[] = 'personal';
    } elseif ( bp_is_active( 'groups' ) && ! empty( $args['group_id'] ) && ( 'all' === $scope || empty( $scope ) ) ) {
        $new_scope[] = 'groups';
    }
 
    $new_scope = array_unique( $new_scope );
 
    if ( empty( $new_scope ) ) {
        $new_scope = (array) $scope;
    }
 
    /**
     * Filter to update default scope.
     */
    $new_scope = apply_filters( 'bp_rest_document_default_scope', $new_scope );
 
    return implode( ',', $new_scope );
}

Expand full source code Collapse full source code

Uses

Uses
Uses Description
bp-document/classes/class-bp-rest-document-endpoint.php: bp_rest_document_default_scope

Filter to update default scope.
bp-core/bp-core-template.php: bp_is_active()

Check whether a given component (or feature of a component) is active.

Questions?

We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.