vBSEO Functions for Extensibility

vBSEO Functions for Extensibility
There are several vBSEO functions that can be used by external scripts.

NOTE: Always include the functions_vbseo.php file. Since it may already be included, the following statement should be used:

Code:

include_once 'includes/functions_vbseo.php';

1. Use the following function to convert text to the vBSEO format. This is useful for custom (non-vBulletin) urls.

Code:

$seo_title = vbseo_filter_text($title); // " A simple example here!" => "simple-example-here"

Also discussed here: Custom Addons Rewrite

2. To create vB URLs, the following calls are required (these should be executed *once*):

Code:

vbseo_get_options();
vbseo_prepare_seo_replace();
vbseo_get_forum_info();

3. The following function returns the vBSEO URL for the forum specified by id:

Code:

$forumurl = vbseo_forum_url($forumid, $pagenum);

4. This function returns the vBSEO URL for the thread based on the *associated array fetched from the database (db record)*:

Code:

$threadurl = vbseo_thread_url_row($threadrow, $pagenum);

where $threadrow is
array(
'threadid'=>xxx,
'title'=>xxx,
....
);

5. This function returns the vBSEO URL for the member profile based on the user id and username:

Code:

$memberurl = vbseo_member_url_row($userid, $username);

6. This function returns the vBSEO URL for the member list:

Code:

$memberlisturl = vbseo_memberlist_url($letter, $pagenum);

7. This function allows the rewritting of a dynamic URL with the corresponding SEO URL (including custom rewrite rules applied).

Code:

vbseo_any_url($url)

For instance, if the following CRR is defined:

'index.php?page=(w+)$' => 'page-$1.html'

The following function call can be used:

$seourl = vbseo_any_url('index.php?page=news'); // $seourl = 'page-news.html'

This function will allow to integrate side rewrites with CRRs better (including sitemap hack additions).

These are the most useful functions. If you are doing a specific hack (or modification) and need more insight don't hesitate to ask

We'll be launching an enhanced API, but that's further down the road

Update (supported in vBSEO2.4.1+)

8. This function allows to replace META tags with custom value:

vbseo_replace_meta($metaname, $meta_content);

example:
vbseo_replace_meta('keywords', 'keywords replacement');

9. This function returns the specific vBSEO URL for the thread based thread row:

$threadurl_spec = vbseo_thread_url_row_spec($thread_row, $spec);

$spec can be either:
'new' - new post URL
'last' - last post URL
'next' - next thread URL
'prev' - previous thread URL

awesome list.. juan.. brilliant
will help a lot for the custom hacks i am doing for my site ..

The functions referenced here create vB URLs only. From this point, they should work fine no matter where the scripts reside

Hi Juan,

Maybe yo can give me some additional help here. I have a page located a domain.com/directory/page.php and my forums are at domain.com/forum/. page.php includes vb functions with global.php and others as needed. So I can add the include for the functions_vbseo.php no problem but what would this actually look like for this page?

Code:

$seotitle = vbseo_filter_text($title); // " A simple example here!" => "simple-example-here" 
 

Originally Posted by reefland

Hi Juan,

Maybe yo can give me some additional help here. I have a page located a domain.com/directory/page.php and my forums are at domain.com/forum/. page.php includes vb functions with global.php and others as needed. So I can add the include for the functions_vbseo.php no problem but what would this actually look like for this page?

Code:

$seotitle = vbseo_filter_text($title); // " A simple example here!" => "simple-example-here" 
 

Since your are rewritting vB URLs, you should use direct functions like:

• vbseo_forum_url
• vbseo_thread_url_row
• vbseo_member_url_row
• vbseo_memberlist_url.

The vbseo_filter_text() function is used to manually construct URLs for non-vB pages.

Also, with new vBSEO 2.2.1 it is possible to create CRR for non-vB folders.

Added function #7 (available in vBSEO 2.3.0 and up)

Hallo,

Originally Posted by dongdong

Hallo, wäre jemand so freundlich und würde das übersetzen? Danke

ich kann es gerne in den nächsten Tagen übersetzen

For function #4 listed above, vbseo_thread_url_row, is there also a way of getting the 'new post' version as well? In specific, the 'Newest Post in Thread' Redirect URL Format version? (Even though last-post and new-post have in the same name in the vbseocp menu, it's the new-post format I'm after.)

Thanks,
Kevin

Hello Kevin,

we will include a special function for this in vBSEO2.4.1: vbseo_thread_url_row_spec($thread_row, $spec);
Updated tutorial: vBSEO Functions for Extensibility

thank you for suggestion!

Originally Posted by Oleg Ignatiuk

we will include a special function for this in vBSEO2.4.1: vbseo_thread_url_row_spec($thread_row, $spec);

Excellent, thank you. In my replacement version of external.php for the RSS2 specs I use the "&goto=newpost" version of the thread for 'link' tag and the normal thread URL for the 'guid' tag.

Hello Tobi,

this is an array retrieved with mysql_fetch_array() function from "thread" db table.
Here is an example:

PHP Code:

$getthreads = $db->query("
SELECT *
FROM " . TABLE_PREFIX . "thread
WHERE threadid=123
");
$threadrow = $db->fetch_array($getthreads);

$threadurl = vbseo_thread_url_row($thread_row);