Support Forum

API Incomplete ?

PT Philip Treacy
Philip Treacy
Member

Hi,

I’m a new customer, very impressed so far.  But, I’m looking for function definitions and a lot of the doco is incomplete?

Why is this?

Where can I see the function definitions for e.g.

https://simple-press.com/documentation/codex/api/template-functions-and-the-api/api-helper-functions/sp_add_membership/

https://simple-press.com/documentation/codex/api/actions-filters-and-classes/actions/

Regards

Phil

4 Answers

New Answer

YS Yellow Swordfish
Yellow Swordfish
Member

The problem is simply one of time. We are a very small team (4 tops – only 2 of the 4 are coders) and trying to fit in more of the technical documentation on top of everything else is proving a great big headache. I reckon I would have to take 3-4 months off of coding and support to catch up. So we probably do need to make some changes to the codex etc.

Having said that – we are more than happy, of course, to point anyone in the right direction and give specific advice and help with any aspect of the API if you can identify to us what you want to do and achieve.

PT Philip Treacy
Philip Treacy
Member

Hi,

I understand that doing this takes time.  However, one of the things I wanted to evaluate before purchasing my membership was your API.  But as access to the API doco is prevented until one purchases a membership, I couldn’t do that.

Now I find that the doco is incomplete and I feel a little put out by this.  One of the features touted by Simple Press is its API, but I can’t actually use it right now.

Every time I want to check what functions are available to me, I don’t want to have to trawl through forums to see if someone has already asked the same question.  Just as I don’t want to have to come and create a new post asking what a certain function does each time I want to know.

All of this doco should already be competed so I can browse through it as and when I want to.

Right now I want to add and remove Memberships.  Presumably I need to use sp_add_membership and sp_remove_membership, and probably sp_check_membership.  But what parameters do they take?  What do they return?

Would I be better off using sp_update_member_data?

Can you please make it a priority to complete the doco.  Maybe hire a freelancer from eLance?

Regards

Phil

PT Philip Treacy
Philip Treacy
Member

OK, I have found what I need for sp_add_membership and sp_remove_membership, but nothing yet for sp_update_member_data.

MP Mr Papa
Mr Papa
Member

What do you need to know about it??    the file is located in simple-press/sp-api/sp-api-users.php

This function gets run on a WP profile save to see if any ‘synched’ profile data needs to be updated… namely, the display name….

if you need more, just holler…