Filter: media upload title & icon

Hook
peepso_filter_video_action_icon
peepso_filter_video_action_text
peepso_filter_audio_action_icon
peepso_filter_audio_action_text

 

Plugin PeepSo Audio & Video
Since 2.0.0
Status Active
Args
string

Description

When users upload video and audio files, the resulting activity title contains an action text, icon and user-entered title. The action text and icon are customizable with these four filters.

Modify the CSS of the icons to change the icon or hide it completely: peepso_filter_video_action_icon – modifies the CSS class of the video icon peepso_filter_audio_action_icon – modifies the CSS class of the audio icon

Modify the action text or disable it (with an empty string) peepso_filter_video_action_text – modifies the action text on a video post peepso_filter_audio_action_text – modifies the action text on an audio post

Examples

Filter: photo thumbnail sizes

Hook
peepso_filter_photos_thumb_settings

 

Plugin PeepSo Photos
Since 1.10.4
Status Active
Args
array

Description

Used to modify the size (in pixels) of thumbnails generated by PeepSo Photos.

Examples

Filter: community navigation

Hook
peepso_navigation

 

Plugin PeepSo Foundation
Since 1.8.5
Status Active
Args
array

Description

This filter is used to build the

  • desktop toolbar
  • desktop notification area
  • mobile hamburger menu
  • mobile notification area
  • “community links” section of the profile widget

You can append a new key-value pair to the result array. Key must be an unique string identifying your plugin. Value is an array with the following keys:

    • required
      • href – the URL of the link
      • label – the text label
      • icon – CSS class of an icon. Needs to work both as <i> and <span> and is needed for icon-only and the widget
    • optional
      • class – CSS class of the parent element
      • icon-only – whether the link should be just an icon – label is then ignored
      • count – count of notifications

Each link added to the stack is also required to have five TRUE/FALSE flags deciding which area it should render in:

  • primary
  • secondary
  • mobile-primary
  • mobile-secondary
  • widget

See screenshot below for better explaination

Depending on TRUE/FALSE value of each key, the link will be rendered in the given area. Third parties are generally advised not to use the “secondary” positions, because the layout will most likely break.

With this filter it is possible to have different links in the toolbar and the widget, although for consistency a link should always show both in the primaries and the widget – with optional admin switches to disable them.

Examples

Screenshot

Elements marked in red are managed by peepso_navigation, yellow marks peepso_navigation_profile. Mobile view on the left, desktop view on the right

peepso_navigation filter

peepso_navigation & peepso_navigation_profile

Filter: country list

Hook
peepso_filter_countries

 

Plugin PeepSo Foundation
Since 2.0.0
Status Active
Args
array(string=>string)

Description

PeepSo is using the ISO-3166-1 alpha-2 standard for country codes. If you wish to remove, rename, add items to this list, you can use this filter.

The final country list will be sorted alphabetically.

Examples

Action: new reported content

Hook
peepso_after_login_form

 

Plugin PeepSo Foundation
Since 1.8.2
Status Active
Args
array

Description

Fires after a new report is filed, passes the array used to perform the insert.

Examples

Welcome to PeepSo Developer Documentation

Where To Start?

Check out our Hello World! plugin. This example plugin that highlights several most important hooks and actions necessary to successfully “plug into”  PeepSo. Please don’t download and install it if you are not a programmer, it’s a resource for experienced engineers!

Documentation

You can access the hooks (actions & filters) documentation from the panel on the left.  Unfortunately, documenting our hooks has never been extremely high on our priority list, given little time left after the between day-to-day development and end-user documentation and support. We do try to document anything that is asked often enough. More often than not, things can be figured out by reading our source code. Frankly, if you ask us a question, that’s what we will do – because nobody remembers every line of PeepSo code by heart.

Community Support

We have a special group for developers where you can ask questions. Most often repeated topics are prioritized for documentation.

Success stories

Despite being a relatively young project, PeepSo already attracted the attention of some third party developers. We maintain  a list of all known third party software and hope to see you there some day!

Thank you

Thanks for choosing (or considering) PeepSo for your next project.

Live long and prosper,
Matt Jaworski
Founder & CTO

Filter: oEmbed

Hook
peepso_enable_oembed

 

Plugin PeepSo Foundation
Since 2.7.7
Status Active
Args
bool
string

Description

This filter  can be used to enable or disable oEmbed in the PeepSoEmbed class (it’s enabled by default). When oEmbed is disabled, PeepSo will not attempt to embed links via the oEmbed endpoints and instead will immediately fall back to Open Graph based discovery.

You can use peepso_enable_oembed to completely disable oEmbed discovery, or use some rules. The most common use for this would be disabling oEmbed for certain domains –  the $url argument is provided in that case.

Examples