Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
06/23/2016 06:31:58 AM (8 years ago)
Author:
tw2113
Message:

Many PHPDocs cleanup for Core component.

See #6398.

File:
1 edited

Legend:

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

    r10861 r10899  
    55 * @package BuddyPress
    66 * @subpackage Core
     7 * @since 2.6.0
    78 */
    89
     
    7273     * @since 2.6.0
    7374     *
     75     * @param string $url URL to validate.
    7476     * @return int Your item ID
    7577     */
     
    8183     * @since 2.6.0
    8284     *
    83      * @param  int  $item_id Your item ID to do checks against.
     85     * @param int $item_id Your item ID to do checks against.
    8486     * @return array Should contain 'content', 'title', 'author_url', 'author_name' as array
    8587     *               keys. 'author_url' and 'author_name' is optional; the rest are required.
     
    9597     * @since 2.6.0
    9698     *
    97      * @param  int    $item_id Your item ID to do checks against.
     99     * @param int $item_id Your item ID to do checks against.
    98100     * @return string Fallback HTML you want to output.
    99101     */
     
    123125     *
    124126     * @param int $item_id The item ID to do checks for.
    125      * @return string
    126127     */
    127128    protected function set_iframe_title( $item_id ) {}
     
    146147        $url = bp_get_requested_url();
    147148
    148         // Remove querystring from bp_get_requested_url()
     149        // Remove querystring from bp_get_requested_url().
    149150        if ( false !== strpos( bp_get_requested_url(), '?' ) ) {
    150151            $url = substr( bp_get_requested_url(), 0, strpos( bp_get_requested_url(), '?' ) );
     
    240241     * @since 2.6.0
    241242     *
    242      * @param  string $template File path to current embed template.
     243     * @param string $template File path to current embed template.
    243244     * @return string
    244245     */
     
    264265     *
    265266     * @since 2.6.0
     267     *
     268     * @param string $slug Template slug.
     269     * @param string $name Template name.
    266270     */
    267271    public function content_buffer_start( $slug, $name ) {
     
    281285     *
    282286     * @since 2.6.0
     287     *
     288     * @param string $name Template name.
    283289     */
    284290    public function content_buffer_end( $name ) {
     
    319325     * @since 2.6.0
    320326     *
    321      * @param  string $retval Current discovery links.
     327     * @param string $retval Current discovery links.
    322328     * @return string
    323329     */
     
    354360     * @link http://oembed.com/ View the 'Response parameters' section for more details.
    355361     *
    356      * @param  array $item  Custom oEmbed response data.
    357      * @param  int   $width The requested width.
     362     * @param array $item  Custom oEmbed response data.
     363     * @param int   $width The requested width.
    358364     * @return array
    359365     */
     
    404410     * @since 2.6.0
    405411     *
    406      * @param  WP_REST_Request $request Full data about the request.
     412     * @param WP_REST_Request $request Full data about the request.
    407413     * @return WP_Error|array oEmbed response data or WP_Error on failure.
    408414     */
     
    509515     * @see bp_activity_embed_rest_route_callback()
    510516     *
    511      * @param  string $retval Current embed URL
     517     * @param string $retval Current embed URL.
    512518     * @return string
    513519     */
     
    521527
    522528        // This is for the 'WordPress Embed' block
    523         // @see bp_activity_embed_comments_button()
     529        // @see bp_activity_embed_comments_button().
    524530        if ( 'the_permalink' !== current_filter() ) {
    525531            $url = add_query_arg( 'embed', 'true', trailingslashit( $url ) );
     
    541547     * @since 2.6.0
    542548     *
    543      * @param  string $retval Current embed HTML
     549     * @param string $retval Current embed HTML.
    544550     * @return string
    545551     */
     
    568574        }
    569575
    570         // Remove default <blockquote>
     576        // Remove default <blockquote>.
    571577        $retval = substr( $retval, strpos( $retval, '</blockquote>' ) + 13 );
    572578
     
    595601     * @see add_oembed_discovery_links()
    596602     *
    597      * @param  string $retval Current oEmbed endpoint URL
     603     * @param string $retval Current oEmbed endpoint URL.
    598604     * @return string
    599605     */
Note: See TracChangeset for help on using the changeset viewer.