vb.org Archive - How to add a new field to the CMS

vb.org Archive (https://vborg.vbsupport.ru/index.php)

- vBulletin 4 Articles (https://vborg.vbsupport.ru/forumdisplay.php?f=242)

- - How to add a new field to the CMS (https://vborg.vbsupport.ru/showthread.php?t=257589)

How to add a new field to the CMS

- Apply the changes mentioned in this how-to at your own risk.
- You must have a basic understanding of php, html and vbulletin.
- This is a how-to for vb4.1, and may not work on previous versions.

Everywhere you see FIELDNAME, replace it with your field name (must not contain spaces).

1.
Create a new field in the cms_node table.

2.
If you run vB 4.1.9 or lower , open packages\vbcms\item\content.php and find:

PHP Code:


		
			
return $pub_view;

Add above it:

PHP Code:


		
			
$getFIELDNAME = vB::$vbulletin->db->query_first("SELECT FIELDNAME FROM " . TABLE_PREFIX . "cms_node WHERE nodeid = " . $this->nodeid);

$pub_view->FIELDNAME = $getFIELDNAME['FIELDNAME'];

If you run 4.1.10+, you can just create a new plugin with the above code, the hook is vbcms_content_publish_editor.

3.
Go to the template vbcms_edit_publisher.
At the bottom of the template, before these lines:

HTML Code:

</div>

<div style="clear:both"></div>

Add the following lines of code:

HTML Code:

        <div class="blockrow" >

                <label class="thirdleft">FIELD TITLE</label>

                <div class="twothirdsright"><input type="text" size="30" value="{vb:raw FIELDNAME}" name="FIELDNAME" tabindex="1" class="textbox fullwidth" /></div>

        </div>

4.
Go to your ACP --> Plugins & Products --> Add New Plugin.
Hook Location: vbcms_article_save_start.
PHP Code:

PHP Code:


		
			
vB::$vbulletin->input->clean_array_gpc('r', array(

    'FIELDNAME' => TYPE_STR

));



vB::$vbulletin->db->query_write("UPDATE " . TABLE_PREFIX . "cms_node SET FIELDNAME = '" . vB::$vbulletin->db->escape_string(vB::$vbulletin->GPC['FIELDNAME']) . "' WHERE nodeid = " . $this->content->getNodeId());

The following steps have been written by Lynne, thank you :)

5. To get the field to spit out, you must add it to the vbcms_content_article_page somewhere (this is rough, you'll have to add your own class/styling).

HTML Code:

<div>Custom Field:{vb:raw FIELDNAME}</div>

6. Then, open vbcms/item/content/article.php and add your field to the end of the protected $content_properties array.

PHP Code:


		
			
'imageheight', 'previewvideo', 'FIELDNAME'

7. In that same file, add this line with the other similar lines:

PHP Code:


		
			
protected $FIELDNAME;

8. Again, in the same file, add this with the other similar functions:

PHP Code:


		
			
    public function getFIELDNAME()

    {

        $this->Load(self::INFO_CONTENT);

        return $this->FIELDNAME;

    }

9. Then add another plugin using hook_location "vbcms_article_populate_start":

PHP Code:


		
			
$view->FIELDNAME = $this->content->getFIELDNAME();

I think I got that all correct.

That's it, you're done.

Thank you! I'll have to try this out. :)

I tried that for 3 fields (instead of one) and I can't get any of the data submitted to save into the database... some troubleshooting of the above code might be needed... have you tried this yourself?

Quote:

Originally Posted by HouseAddict (Post 2154257)

Please paste the relevant lines of code from packages\vbcms\item\content.php, vbcms_edit_publisher and the plugin.

Quote:

Originally Posted by Yellow Slider (Post 2154265)

Please paste the relevant lines of code from packages\vbcms\item\content.php, vbcms_edit_publisher and the plugin.

Sure.

content.php:

Code:

$geturl_text = vB::$vbulletin->db->query_first("SELECT url_text FROM " . TABLE_PREFIX . "cms_node WHERE nodeid = " . $this->nodeid);

$geturl_pdf = vB::$vbulletin->db->query_first("SELECT url_pdf FROM " . TABLE_PREFIX . "cms_node WHERE nodeid = " . $this->nodeid);

$geturl_audio = vB::$vbulletin->db->query_first("SELECT url_audio FROM " . TABLE_PREFIX . "cms_node WHERE nodeid = " . $this->nodeid);

$pub_view->url_text = $geturl_text['url_text'];

$pub_view->url_pdf = $geturl_text['url_pdf'];

$pub_view->url_audio = $geturl_text['url_audio'];

article.php:

Code:

        protected $content_properties = array(

                /*INFO_CONTENT================*/

                        'pagetext',        'threadid' , 'blogid', 'posttitle' ,

                        'postauthor', 'poststarter', 'postid', 'blogpostid', 'showrating', 'htmlstate',

                        'post_posted', 'post_started', 'previewimage', 'imagewidth', 'imageheight', 'previewvideo', 'url_text', 'url_pdf', 'url_audio'

        );



        protected $url_text;



        protected $url_pdf;



        protected $url_audio;



   public function geturl_text()

   {

        $this->Load(self::INFO_CONTENT);

        return $this->url_text;

   }



   public function geturl_pdf()

   {

        $this->Load(self::INFO_CONTENT);

        return $this->url_pdf;

   }



   public function geturl_audio()

   {

        $this->Load(self::INFO_CONTENT);

        return $this->url_audio;

   }

vbcms_content_article_inline template

added this:

Code:

        <div class="blockrow">

                <label class="quarter">Text Transcript URL</label>

                <div class="threequarters"><input type="text" size="30" value="{vb:raw url_text}" name="url_text" tabindex="1" class="textbox fullwidth" /></div>

        </div>



        <div class="blockrow" >

                <label class="quarter">PDF Transcript URL</label>

                <div class="threequarters"><input type="text" size="30" value="{vb:raw url_pdf}" name="url_pdf" tabindex="1" class="textbox fullwidth" /></div>

        </div>



        <div class="blockrow" >

                <label class="quarter">Audio Transcript URL</label>

                <div class="threequarters"><input type="text" size="30" value="{vb:raw url_audio}" name="url_audio" tabindex="1" class="textbox fullwidth" /></div>

        </div>

right below this:

Code:

        {vb:raw editor}

        <vb:else />

        {vb:raw previewtext}

        </vb:if>

plugin with vbcms_article_populate_start hook:

Code:

$view->url_text= $this->content->geturl_text();

$view->url_pdf= $this->content->geturl_pdf();

$view->url_audio= $this->content->geturl_audio();

and plugin with vbcms_article_save_start hook:

Code:

vB::$vbulletin->input->clean_array_gpc('r', array(

    'url_text' => TYPE_STR,

    'url_pdf' => TYPE_STR,

    'url_audio' => TYPE_STR

));



vB::$vbulletin->db->query_write("UPDATE " . TABLE_PREFIX . "cms_node 

SET url_text = '" . vB::$vbulletin->db->escape_string(vB::$vbulletin->GPC['url_text']) . "',

url_pdf = '" . vB::$vbulletin->db->escape_string(vB::$vbulletin->GPC['url_pdf']) . "',

url_audio = '" . vB::$vbulletin->db->escape_string(vB::$vbulletin->GPC['url_audio']) . "' 

WHERE nodeid = " . $this->content->getNodeId());

As I said, the fields show up just fine, but when I enter anything into them and click Save or Apply, the values are not shown.

They are correctly saved in the mysql, but are not being shown in the Edit Article page under those fields when the changes to the article are saved.

I have tried this and it works fine for me. Have you tried spitting out your last query to see if it is correct?

This is incorrect:

PHP Code:


		
			
$geturl_text = vB::$vbulletin->db->query_first("SELECT url_text FROM " . TABLE_PREFIX . "cms_node WHERE nodeid = " . $this->nodeid);
$geturl_pdf = vB::$vbulletin->db->query_first("SELECT url_pdf FROM " . TABLE_PREFIX . "cms_node WHERE nodeid = " . $this->nodeid);
$geturl_audio = vB::$vbulletin->db->query_first("SELECT url_audio FROM " . TABLE_PREFIX . "cms_node WHERE nodeid = " . $this->nodeid);
$pub_view->url_text = $geturl_text['url_text'];
$pub_view->url_pdf = $geturl_text['url_pdf'];
$pub_view->url_audio = $geturl_text['url_audio'];

You are using $geturl_text for all three of them. I would actually do this:

PHP Code:


		
			
$geturl_text = vB::$vbulletin->db->query_first("SELECT url_text, url_pdf, url_audio FROM " . TABLE_PREFIX . "cms_node WHERE nodeid = " . $this->nodeid);

$pub_view->url_text = $geturl_text['url_text'];
$pub_view->url_pdf = $geturl_text['url_pdf'];
$pub_view->url_audio = $geturl_text['url_audio'];

Doh!

Obvious mistake.

That was it, in a way...

Now, the problem I have is if I put those fields in "vbcms_edit_publisher" template, they show up just fine and work ok. But if I put them in "vbcms_content_article_inline" template - no go, they don't show the values at all, even though they save them properly.

And I'd rather have those extra fields in vbcms_content_article_inline, below the actual content box instead of in vbcms_edit_publisher which adds them into the right-hand column which makes that long column even longer now...

Thoughts?

Maybe this has something to do with the hooks?

If you want them in other templates, you must write a plugin to register them for use in the other template. Cellarius wrote a really good article that you may be interested in - [vB4] Rendering templates and registering variables - a short guide

Quote:

Originally Posted by Lynne (Post 2154447)

And that's a short guide?

Geez... I just spent almost an hour going through it and trying it out without any success.

Tsk, why does this have to be so darn complicated...

Hmm, how can I extend that $pub_view array to be available to other templates, not just vbcms_edit_publisher (as defined in content.php) in an easier manner...

--------------- Added [DATE]1295989658[/DATE] at [TIME]1295989658[/TIME] ---------------

It seems that I am having some issue with spitting out the value in the front-end as well... adding that code to vbcms_content_article_page prints out nothing.

Seems the root of the problem is $view->FIELDNAME = $this->content->getFIELDNAME(); in the plugin attached to vbcms_article_populate_start... as if I change that $view->FIELDNAME value to a constant, I get a value out on the front-end and in all the other templates (weird). If I leave it as $this->content->getFIELDNAME(), it ends up blank.

Ah yes, steps 5 through 9 were written to add the fields to the article page. That's it. If you need it on another page, you'd have to probaby do all those steps on another page. Perhaps someone else will look into that part and post it.

X vBulletin 3.8.12 by vBS Debug Information
Template Usage: (1)ad_footer_end (1)ad_footer_start (1)ad_header_end (1)ad_header_logo (1)ad_navbar_below (6)bbcode_code_printable (3)bbcode_html_printable (9)bbcode_php_printable (3)bbcode_quote_printable (1)footer (1)gobutton (1)header (1)headinclude (6)option (1)pagenav (1)pagenav_curpage (2)pagenav_pagelink (1)post_thanks_navbar_search (1)printthread (10)printthreadbit (1)spacer_close (1)spacer_open Phrase Groups Available: global postbit showthread	Included Files: ./printthread.php ./global.php ./includes/init.php ./includes/class_core.php ./includes/config.php ./includes/functions.php ./includes/class_hook.php ./includes/modsystem_functions.php ./includes/class_bbcode_alt.php ./includes/class_bbcode.php ./includes/functions_bigthree.php Hooks Called: init_startup init_startup_session_setup_start init_startup_session_setup_complete cache_permissions fetch_threadinfo_query fetch_threadinfo fetch_foruminfo style_fetch cache_templates global_start parse_templates global_setup_complete printthread_start pagenav_page pagenav_complete bbcode_fetch_tags bbcode_create bbcode_parse_start bbcode_parse_complete_precache bbcode_parse_complete printthread_post printthread_complete
Messages:

Phrase Groups Available:

X vBulletin 3.8.12 by vBS Debug Information
Page Generation 0.01385 seconds Memory Usage 1,810KB Queries Executed 10 (?)
More Information
Template Usage: (1)ad_footer_end (1)ad_footer_start (1)ad_header_end (1)ad_header_logo (1)ad_navbar_below (6)bbcode_code_printable (3)bbcode_html_printable (9)bbcode_php_printable (3)bbcode_quote_printable (1)footer (1)gobutton (1)header (1)headinclude (6)option (1)pagenav (1)pagenav_curpage (2)pagenav_pagelink (1)post_thanks_navbar_search (1)printthread (10)printthreadbit (1)spacer_close (1)spacer_open Phrase Groups Available: global postbit showthread	Included Files: ./printthread.php ./global.php ./includes/init.php ./includes/class_core.php ./includes/config.php ./includes/functions.php ./includes/class_hook.php ./includes/modsystem_functions.php ./includes/class_bbcode_alt.php ./includes/class_bbcode.php ./includes/functions_bigthree.php Hooks Called: init_startup init_startup_session_setup_start init_startup_session_setup_complete cache_permissions fetch_threadinfo_query fetch_threadinfo fetch_foruminfo style_fetch cache_templates global_start parse_templates global_setup_complete printthread_start pagenav_page pagenav_complete bbcode_fetch_tags bbcode_create bbcode_parse_start bbcode_parse_complete_precache bbcode_parse_complete printthread_post printthread_complete
Messages: