Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
07/12/2015 12:49:36 AM (9 years ago)
Author:
tw2113
Message:

First pass at BP-Core docs cleanup.

See #6398.

File:
1 edited

Legend:

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

    r9819 r10012  
    7070     *
    7171     * @param array $args {
    72      *     @type int $limit Maximum number of results to display. Optional, default: 16.
    73      *     @type string $type The name of the suggestion service to use for the request. Mandatory.
    74      *     @type string $term The suggestion service will try to find results that contain this string.
    75      *           Mandatory.
     72     *     @type int    $limit Maximum number of results to display. Optional, default: 16.
     73     *     @type string $type  The name of the suggestion service to use for the request. Mandatory.
     74     *     @type string $term  The suggestion service will try to find results that contain this string.
     75     *                         Mandatory.
    7676     * }
    7777     * @since BuddyPress (2.1.0)
     
    8787     * If validation fails, you must return a WP_Error object.
    8888     *
     89     * @since BuddyPress (2.1.0)
     90     *
    8991     * @return true|WP_Error If validation fails, return a WP_Error object. On success, return true (bool).
    90      * @since BuddyPress (2.1.0)
    9192     */
    9293    public function validate() {
     
    134135     * For example: { 'ID': 'admin', 'image': 'http://example.com/logo.png', 'name': 'Name Surname' }
    135136     *
     137     * @since BuddyPress (2.1.0)
     138     *
    136139     * @return array|WP_Error Array of results. If there were problems, returns a WP_Error object.
    137      * @since BuddyPress (2.1.0)
    138140     */
    139141    abstract public function get_suggestions();
Note: See TracChangeset for help on using the changeset viewer.